HL7 integration

Build HL7 Message

Perform Build HL7 Message through HL7.

hl7_build_message

write

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "HL7",
  "params": {
    "hl7_version": "2.5.1",
    "message_type": "ORM^O01",
    "processing_id": "T"
  },
  "handler": "hl7_build_message"
}

Action contracts and connections · Run recovery

Inputs

message_type
selectrequired
Message Type
Required selected identifier or value.
Default: "ORM^O01"
Options: ORM^O01 ("ORM^O01"), ADT^A04 ("ADT^A04"), ADT^A08 ("ADT^A08"), ORU^R01 ("ORU^R01"), MDM^T02 ("MDM^T02")
hl7_version
selectrequired
Hl7 Version
Required selected identifier or value.
Default: "2.5.1"
Options: 2.3 ("2.3"), 2.3.1 ("2.3.1"), 2.4 ("2.4"), 2.5 ("2.5"), 2.5.1 ("2.5.1"), 2.6 ("2.6"), 2.7 ("2.7")
sending_application
expression
Sending Application
Optional literal value or workflow expression.
sending_facility
expression
Sending Facility
Optional literal value or workflow expression.
receiving_application
expression
Receiving Application
Optional literal value or workflow expression.
receiving_facility
expression
Receiving Facility
Optional literal value or workflow expression.
processing_id
select
Processing Id
Optional selected identifier or value.
Default: "T"
Options: T · Test ("T"), P · Production ("P"), D · Debug ("D")
field_map
repeatable_grouprequired
Field Map
Required list of structured items.
- field
  textrequired
  Field
  Required text value.
- value
  expression
  Value
  Optional literal value or workflow expression.

Outputs

successSuccess
messageMessage
control_idControl Id
message_typeMessage Type
hl7_versionHl7 Version
segment_namesSegment Names
validation_errorsValidation Errors
validation_warningsValidation Warnings
errorError
error_typeError Type

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "message_type",
    "hl7_version",
    "field_map"
  ],
  "properties": {
    "field_map": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "Required text value.",
            "x-workflow-field-type": "text"
          },
          "value": {
            "description": "Optional literal value or workflow expression.",
            "x-workflow-field-type": "expression"
          }
        },
        "additionalProperties": false
      },
      "description": "Required list of structured items.",
      "x-workflow-field-type": "repeatable_group"
    },
    "hl7_version": {
      "enum": [
        "2.3",
        "2.3.1",
        "2.4",
        "2.5",
        "2.5.1",
        "2.6",
        "2.7"
      ],
      "type": "string",
      "default": "2.5.1",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "message_type": {
      "enum": [
        "ORM^O01",
        "ADT^A04",
        "ADT^A08",
        "ORU^R01",
        "MDM^T02"
      ],
      "type": "string",
      "default": "ORM^O01",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "processing_id": {
      "enum": [
        "T",
        "P",
        "D"
      ],
      "type": "string",
      "default": "T",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "sending_facility": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "receiving_facility": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sending_application": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "receiving_application": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "success": {},
    "control_id": {},
    "error_type": {},
    "hl7_version": {},
    "message_type": {},
    "segment_names": {},
    "validation_errors": {},
    "validation_warnings": {}
  },
  "additionalProperties": true
}

View all HL7 actions