Search for Resource

Use the Search for Resource activity to search for a particular FHIR resource on the specified FHIR server using one or more criteria.

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 Specifies existing FHIRContextProperties and allows:
  • editing of existing properties
  • creation of new properties
  • selection and configuration of a FHIR shared resource.

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 Name of the FHIR resource to be retrieved. Available resource types are:
  • Patient
  • Communication
  • CommunicationRequest
  • Practitioner
  • DocumentReference
  • Encounter

Description

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

Input

The Input tab contains the following fields.

Field Datatype Description
fhirResouce string Name of the FHIR resource-specific schema to be retrieved. For the current release this must be a DSTU2 type server.
searchCriterion string Name of the FHIR resource element to be used to search for the FHIR resource (e.g, Patient.FAMILY).
Note: A search on the basis of Field f1 and f2, with values v1 and v2 respectively would search for all records of that resources that match the "F1=v1 AND F2=v2" as search criteria.
searchValue string Value of the FHIR resource element to be used to search for the FHIR resource.

Output

Output Item Datatype Description
Reqeusted FHIR Resource Zero or a larger number of resource(s) of the same type are returned in the output tab. Each resource has a specific schema.

The total Number of returned resources is also output.

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.