Match Resource Activity

Use the Match Resource activity to match a Patient resource.

Example

Refer to the associated example:

General

The General tab contains the following fields:

Field Literal Value/Module Property/Process Property? Description
Name No Enter the name to be displayed as a label for the activity in the process.
FHIR Context No 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.

FHIR Resource No Name of FHIR resource to be retrieved.

Currently, only Patient resource is supported.

All Matches No Returns all the records that match the condition
Only Certain Matches No Returns the given number of records that match the condition
Select Matches No Selects the TopXMatches from the Select Matches drop down
Count No Provides the number of the top most records that match the condition.

For example, Count = 8, returns the top 8 records from the database that match the condition. However, if the result set has 3 records, then only those 3 records are returned.

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 on the General tab.

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

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

Field Datatype Description
count integer The number of FHIR resources retrieved
oauthToken string Is used to authorize the request against the FHIR server.
urlPage string The request that is sent to the FHIR server.

It includes the base URL, for example, https://hapi.fhir.org/baseDstu2/ and the query string for example, Practitioner?practitioner="xyz"&date=08/07/2019. The search criteria specified in the Query Builder is used to create the query string.

For more information about the supported resource types, see the FHIR documentation.

Output

The output depends on the input data that you want to match with the Patient resource.

Output Item Datatype Description
total integer The total number of resources returned
nextUrlPage string Link to the next ten resources to be fetched.

Populated when the total number of resources returned is more than 10.

previousUrlPage string Link to the previous page of results.

Populated when the total number of resources returned is more than 10 and also when viewing results from the second page onwards.

Requested FHIR Resource Zero or a larger number of Patient resources are returned and displayed on the Output tab.

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 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 (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