Encode Resource Activity

Use the Encode Resource activity to encode a FHIR resource against the published FHIR schema for that resource.

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.
Server Version   The version of the FHIR standard.

The supported FHIR versions are STU3, and R4.

FHIR Resource No The FHIR resource type to be encoded.

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

Output Type No The type of output.

XML and JSON output formats are supported.

Use Input Editor No

Select the Use Input Editor checkbox to insert input through the Input Editor tab.

Description

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

Input Editor

You can use the Input Editor tab to import an FHIR schema from external sources for the following BW FHIR activities.

If you want to generate XML schemas for the FHIR resource using the Schemagen utility, see Generating XML Schemas Using the Schemagen Utility.

  • ResourceOperations: Input Editor is on Input tab

  • SearchForResource: Both Input and Output Editor tabs are present

  • EncodeResource: Input Editor is on Input tab

  • ParseResource: Output Editor is provided on the Output tab

Note: Selecting the Use Input Editor checkbox allows use of resource schema provided in the Input Editor tab.

You need to provide the following schemas generated by the SchemaGen utility to use the Input Editor feature:

  • inputEditor : inputEncode<ResourceName>.xsd

Input

The Input tab is populated based on the selections made on the General tab.

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

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

Output

Output Item Datatype Description
Encoded FHIR Resource string An encoded FHIR resource (JSON or XML)

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