Resource Operations Activity

Use the Resource Operations activity to create, read, update, or delete a FHIR resource on the specified FHIR server.

Example

Refer to the associated example:

General

The General tab contains the following fields:

Field Literal Value/Module Property/Process Property? Description
Name No The name to be displayed as the label for the activity in the process.
FHIR Context Points to the desired FHIR server
Display existing FHIRContextPropertiesDisplays

If multiple properties are created, select one from the list.

Create a new process property

After creation, the new property appears on the FHIRContextPropertiesDisplays menu.

Set default property values

To select the Default Value Set for the property, click :

  • Literal Value
  • Module Property
Select FHIR Resource

To create or choose a FHIR resource, click Choose/Create Default Resource Value .

For more information about creating a FHIR resource, see Select FHIR Resource Template.

Edit Default Resource

To edit the default resource, click Edit Default Resource icon.

Clear Value

To clear the current value from the existing FHIRContextProperties display, click Clear Value .

FHIR Resource No The FHIR resource.

Depending on the server version you select, different FHIR resources are supported. For more information about the supported FHIR resources, see Supported Resource Types.

Operation No The type of operation to be performed on the selected FHIR resource:
  • Create
  • Read
  • Update
  • Delete

Description

The Description tab is used to provide a short description for the activity.

Input

The Input tab is populated based on the selections made for FHIR Context, Resource type, and Operation type.

For example, requests involving the Practitioner resource displays the FHIR template for that resource.

For more information about the supported resource types, see the or FHIR DSTU2, FHIR STU3, and FHIR R4 documentation.

Output

The Output tab is populated based on the operation selected. An OperationOutcome object might also be returned with an ID.

Example 1: If you perform a create, delete, or update operation, the ID of the created, deleted, or updated FHIR resource is returned.

Example 2: If you perform a read operation, the resource is returned. This example shows the Practitioner resource displayed on the Output tab.

Output Item Datatype Description
OperationOutcome element You can use it to determine the results of the operation.

The following OperationOutcome properties can help you diagnose an error. Expand the issue property to view these properties.

  • severity - Severity of the issue. Can be fatal, error, warning, or information.
  • code - Error or warning code.
  • details - Additional details about the error.
  • diagnostics - Additional diagnostic information.
  • location - Path of the elements related to the issue.

For more information about the supported resource types, see the FHIR R4, FHIR STU3, or FHIR DSTU2 documentation.

Fault

The Fault tab lists errors that might occur when you use this activity.

Error Schema Element Datatype Description
msg string Error message description
msgCode string The error code.

It represents ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR errors. For more information about the error codes, see FHIR Error Codes.

OperationOutcome string The issue description in case of failure of the activity in a process.

The following OperationOutcome properties can help you diagnose an error. Expand the issue property to view these properties.

  • severity - Severity of the issue. Can be fatal, error, warning, or information.
  • code - Error or warning code
  • details - Additional details about the error.
  • diagnostics - Additional diagnostic information.
  • location - Path of the elements related to the issue.