HL7v2 Module Resources | Aidbox User Docs

Resources for configuration Aidbox HL7v2 module.

Overview

HL7v2 module includes the following resource types:

Hl7v2Config
Hl7v2Message

Hl7v2Config

Path	Card.	Type	Description
_source	0..1	string	System Property. DO NOT USE IT.
extensions	0..*		Extensions for the HL7v2 message processing configuration.
extensions.after	0..1	string
extensions.msh	0..1	string	Message header information.
extensions.segment	0..1	string	HL7v2 segment identifier.
extensions.fields	0..*	BackboneElement	Fields within the segment.
extensions.fields.key	0..1	string
extensions.fields.name	0..1	string
extensions.fields.type	0..1	string
extensions.quantifier	0..1	string	Occurrence quantifier. Allowed values: `*` \| `?` \| `+`
isStrict	0..1	boolean	Whether strict validation should be applied.
mapping	0..1	Reference	Reference to a mapping resource for message transformation. Allowed references: Mapping
sortTopLevelExtensions	0..1	boolean	Whether to sort top-level extensions during processing.
text	0..1		Narrative text representation.
text.div	0..1	string	HTML content of the narrative.
text.status	0..1	string	Status of the narrative text.

Hl7v2Message

Path	Card.	Type	Description
_source	0..1	string	System Property. DO NOT USE IT.
apiOperation	0..1	string	API operation to be performed with this message.
config	0..1	Reference	Reference to the configuration for processing this message. Allowed references: Hl7v2Config
event	0..1	code	Event type code from the HL7v2 message.
outcome	0..1	Object	Outcome of message processing.
parsed	0..1	Object	Parsed content of the HL7v2 message.
src	1..1	string	Original source text of the HL7v2 message.
status	1..1	string	Processing status of the message (received, processed, or error). Allowed values: `received` \| `processed` \| `error`
type	0..1	code	Message type code from the HL7v2 message.

PreviousCloud Module Resources

NextSQL on FHIR Module Resources

Last updated 2025-05-06T09:17:20Z