HL7v2 Module Resources

Resources for configuration Aidbox HL7v2 module.

Overview

HL7v2 module includes the following resource types:

• Hl7v2Config

• Hl7v2Message

Hl7v2Config

Path	Card.	Type	Description
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..*		Fields within the segment.
extensions.quantifier	0..1	string	Occurrence quantifier. Allowed values: * | ? | +
isStrict	0..1	boolean	Whether strict validation should be applied.
sortTopLevelExtensions	0..1	boolean	Whether to sort top-level extensions during processing.
_source	0..1	string	System Property. DO NOT USE IT.
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.
mapping	0..1	Reference	Reference to a mapping resource for message transformation. Allowed references: Mapping

Hl7v2Message

Path	Card.	Type	Description
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.
src	1..1	string	Original source text of the HL7v2 message.
_source	0..1	string	System Property. DO NOT USE IT.
status	1..1	string	Processing status of the message (received, processed, or error). Allowed values: received | processed | error
parsed	0..1	Object	Parsed content of the HL7v2 message.
type	0..1	code	Message type code from the HL7v2 message.
outcome	0..1	Object	Outcome of message processing.