Resource Operations

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

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, use the dropdown menu to expand the listing.

Create a new process property

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

Set default property values

Use to select the Default Value Set for the property:

  • Literal Value
  • Module Property

Select FHIR Resource

Use to access the Select FHIR Resource Template.

See Select FHIR Resource Template.

Clear Value

Use to clear the current value from the existing FHIRContextProperties display.

FHIR Resource The selected FHIR resource type. Supported FHIR resources are:
  • Patient
  • Communication
  • CommunicationRequest
  • Practitioner
  • DocumentReference
  • Encounter
Operation 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 Resource type and Operation type.

For example, requests involving the Patient resource will display the FHIR template for that resource.

Refer to the following for details about templates for the supported resource types:

Input Guide for FHIR Resources

Output

The Output tab is populated based on the operation selected.

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

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

Refer to the following for details about templates fo the supported resource types:

Input Guide for FHIR Resources

Fault

The Fault tab lists exceptions that are thrown by this activity.

Error Schema Element Datatype Description
msg string Error message description.
msgCode string The error code. It represents TIBCO ActiveMatrix BusinessWorks™ Plug-in for HL7 with FHIR errors.

See FHIR Error Codes for details.