Validate Resource Activity

Use the Validate Resource activity to validate a FHIR resource against the published FHIR schema for that 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 The name to be displayed as the label for the activity in the process.
FHIR Context No The version of the FHIR standard.

The available server versions are STU3, and R4.

Write Result To Log No Select the checkbox if you want to write the result to a log file.
Input Data Type No The data type of the input.

The type of data can be a string in XML or JSON format or a resource object as an OBJECT.

Validation Type No The type of validation to be performed.

It depends on the type of input. If the input type is XML or JSON, the supported types are as follows:

  • Schema
  • SchemaAndSchematron
  • StructureDefinition
  • LenientParser
  • StrictParser

If the input is an OBJECT, the supported types are as follows:

  • Schema
  • SchemaAndSchematron
  • StructureDefinition

FHIR Resource No Name of the FHIR resource to be validated.

Depending on the server version you select and when the input data type is OBJECT, different resource types are supported. For more information about the supported resource types, see Supported Resource Types

Description

The Description tab is used to provide a short description of 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 STU3, and FHIR R4 documentation.

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

Output

The output depends on the input resource.

Output Item Datatype Description
status Boolean Indicates whether the validation was successful
OperationOutcome string The issue description in case of success 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.

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.