Structure Definitions
This page contains the HL7 v2.x structure definitions for various message types that are supported by Smile CDR.
If there are additional HL7 v2.x structure definitions you would like to see supported, please let us know!
For more information, refer to Supported HL7 v2.x Elements.
Structure: ADT_A01
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| [{ NK1 }] | 0..* | Patient Contact (Next of Kin) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ AL1 }] | 0..* | Allergy Information |
| [{ DG1 }] | 0..* | Diagnosis |
| [{ | 0..* | PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| }] | | PROCEDURE end |
| [{ GT1 }] | 0..* | Guarantor |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: ADT_A02
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ GT1 }] | 0..* | Guarantor |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: ADT_A03
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| [{ NK1 }] | 0..* | Patient Contact (Next of Kin) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
| [{ AL1 }] | 0..* | Allergy Information |
| [{ DG1 }] | 0..* | Diagnosis |
| [{ | 0..* | PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| }] | | PROCEDURE end |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: ADT_A05
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| [{ NK1 }] | 0..* | Patient Contact (Next of Kin) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ AL1 }] | 0..* | Allergy Information |
| [{ DG1 }] | 0..* | Diagnosis |
| [{ | 0..* | PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| }] | | PROCEDURE end |
| [{ GT1 }] | 0..* | Guarantor |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: ADT_A06
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| [{ MRG }] | 0..* | Merge Information |
| [{ NK1 }] | 0..* | Patient Contact (Next of Kin) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ AL1 }] | 0..* | Allergy Information |
| [{ DG1 }] | 0..* | Diagnosis |
| [{ | 0..* | PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| }] | | PROCEDURE end |
| [{ GT1 }] | 0..* | Guarantor |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: ADT_A09
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
Structure: ADT_A12
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
Structure: ADT_A17
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| PV1 | 1..1 | Visit/Encounter |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| PID | 1..1 | Patient Identification 2 |
| PV1 | 1..1 | Visit/Encounter 2 |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ OBX }] | 0..* | Observation 2 (Patient Assessments) |
Structure: ADT_A21
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
Structure: ADT_A30
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| MRG | 1..1 | Merge Information |
Structure: ADT_A38
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ OBX }] | 0..* | Observation (Patient Assessments) |
| [{ DG1 }] | 0..* | Diagnosis |
Structure: ADT_A39
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| { | 1..* | PATIENT begin |
| PID | 1..1 | Patient Identification |
| MRG | 1..1 | Merge Information |
| } | | PATIENT end |
Structure: ADT_A44
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| { | 1..* | PATIENT begin |
| PID | 1..1 | Patient Identification |
| MRG | 1..1 | Merge Information |
| } | | PATIENT end |
Structure: ADT_A45
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| { | 1..* | MERGE_INFO begin |
| MRG | 1..1 | Merge Information |
| PV1 | 0..1 | Visit/Encounter |
| } | | MERGE_INFO end |
Structure: ADT_A54
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
Structure: ADT_A60
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ | 0..* | ADVERSE_REACTION_GROUP begin |
| IAM | 1..1 | Patient Adverse Reaction Information |
| }] | | ADVERSE_REACTION_GROUP end |
Structure: ADT_A61
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Patient Associated Roles (e.g. Family Provider) |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| [{ ROL }] | 0..* | Visit Associated Roles (e.g. Attending) |
Structure: DFT_P03
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| EVN | 1..1 | Event Type |
| PID | 1..1 | Patient Identification |
| [ PD1 ] | 1..1 | Patient Demographics Extended |
| [{ ROL }] | 0..* | Role |
| [ PV1 ] | 0..1 | Visit Information |
| { | 1..* | FINANCIAL begin |
| FT1 | 1..1 | Financial Transaction |
| [{ | 0..1 | FINANCIAL_PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| }] | | FINANCIAL_PROCEDURE end |
| } | | FINANCIAL end |
| [{ DG1 }] | 0..* | Role |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| IN2 | 1..1 | Insurance Additional Information |
| }] | | INSURANCE end |
Structure: OMG_O19
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| | 1..1 | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [{ | 0..1 | PATIENT_VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| }] | | PATIENT_VISIT end |
| | | PATIENT end |
| | 1..1 | ORDER begin |
| [ ORC ] | 0..1 | Order Common |
| [ | 0..1 | ORDER_DETAIL begin |
| OBR | 1..1 | Observation Request |
| ] | | ORDER_DETAIL end |
| | | ORDER end |
Structure: ORM_O01
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| [ | 0..1 | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [ | 0..1 | PATIENT_VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| [ PV1 ] | 0..1 | Visit/Encounter Additional |
| ] | | PATIENT_VISIT end |
| [{ | 0..* | INSURANCE begin |
| IN1 | 1..1 | Insurance |
| [ IN2 ] | 1..1 | Insurance additional information |
| }] | | INSURANCE end |
| GT1 | 1..1 | Guarantor |
| ] | | PATIENT end |
| { | 1..* | ORDER begin |
| ORC | 1..1 | Order Common |
| [ | 0..1 | ORDER_DETAIL begin |
| OBR | 1..1 | Observation Request |
| [{ NTE }] | 0..* | Notes |
| [{ DG1 }] | 1..1 | Diagnosis |
| [{ | 0..* | OBSERVATION begin |
| OBX | 1..1 | Observation |
| [{ NTE }] | 0..* | Notes |
| }] | | OBSERVATION end |
| ] | | ORDER_DETAIL end |
| } | | ORDER end |
Structure: ORU_R01
Note that the HL7 v2.x inbound processor populates Observation.specimen where a given ORDER_OBSERVATION group includes a single SPECIMEN group. Where multiple SPECIMEN groups exist, a warning is issued to the Transaction Log.
If you would like to see a multi-specimen model supported, let us know!
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| { | 1..* | PATIENT_RESULT begin |
| [ | 0..1 | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [ | 0..1 | VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| ] | | VISIT end |
| ] | | PATIENT end |
| { | 1..* | ORDER_OBSERVATION begin |
| [ ORC ] | 0..1 | Order Common |
| OBR | 1..1 | Observation Request |
| [{ NTE }] | 0..* | Order Observation Note |
| [{ | 0..* | OBSERVATION begin |
| OBX | 1..1 | Observation |
| [{ NTE }] | 0..* | Observation Note |
| }] | | OBSERVATION end |
| [{ | 0..* | SPECIMEN begin |
| SPM | 1..1 | Specimen |
| }] | | SPECIMEN end |
| ] | | ORDER_OBSERVATION end |
| } | | PATIENT_RESULT end |
Structure: RAS_O17
Note that when mapping this structure to FHIR, the HL7 v2.x inbound processor will set MedicationRequest.intent to instance-order.
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| | 1..1 | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [ | 0..1 | PATIENT_VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| ] | | PATIENT_VISIT end |
| | | PATIENT end |
| { | 1..* | ORDER begin |
| ORC | 1..1 | Order Common |
| [ | 0..1 | ENCODING begin |
| [ RXE ] | 0..1 | Pharmacy Encoded Order |
| [ RXR ] | 0..1 | Route |
| [{ RXC }] | 0..* | Component (for RXE) |
| ] | | ENCODING end |
| { | 1..* | ADMINISTRATION begin |
| { RXA } | 1..* | Administration |
| [ RXR ] | 0..1 | Route |
| [{ ZXC }] | 0..* | Component (for RXA) |
| } | | ADMINISTRATION end |
| } | | ORDER end |
Structure: RDE_O11
Note that messages that declare their message type as RDE^O01 or RDE^O11 will both be processed using this structure and workflow.
Note that when mapping this structure to FHIR, the HL7 v2.x inbound processor will set MedicationRequest.intent to order.
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| | 1..1 | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [ | 0..1 | PATIENT_VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| [ PV2 ] | 0..1 | Visit/Encounter Additional |
| ] | | PATIENT_VISIT end |
| | | PATIENT end |
| { | 1..* | ORDER begin |
| ORC | 1..1 | Order Common |
| RXE | 1..1 | Pharmacy Encoded Order |
| [ RXR ] | 0..1 | Route |
| [{ RXC }] | 0..* | Component (for RXE) |
| } | | ORDER end |
Structure: SIU_S12
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| SCH | 1..1 | Schedule Activity Information |
| [{ NTE }] | 0..* | Notes and Comments for the SCH |
| [{ | 0..* | PATIENT begin |
| PID | 1..1 | Patient Identification |
| [ PV1 ] | 0..1 | Patient Visit |
| }] | | PATIENT end |
| { | 1..* | RESOURCES begin |
| RGS | 1..1 | Resource Group Segment |
| [{ | 0..* | LOCATION_RESOURCE begin |
| [ AIL ] | 0..1 | Appointment Information - Location |
| }] | | LOCATION_RESOURCE end |
| [{ | 0..* | PERSONNEL_RESOURCE begin |
| [ AIP ] | 0..1 | Appointment Information - Personnel |
| }] | | PERSONNEL_RESOURCE end |
| } | | RESOURCES end |
Structure: VXU_V04
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| PID | 1..1 | Patient Identification |
| [{ NK1 }] | 0..* | Patient Contact (Next of Kin) |
| [ | 0..1 | PATIENT_VISIT begin |
| PV1 | 1..1 | Visit/Encounter |
| ] | | PATIENT_VISIT end |
| { | 1..* | ORDER begin |
| ORC | 1..1 | Order Common |
| RXA | 1..1 | Pharmacy Encoded Order |
| [ RXR ] | 0..1 | Route |
| } | | ORDER end |
Structure: BAR_P12
The BAR^P12 message is used to communicate diagnosis and/or procedures in update mode.
| Segment | Card | Description |
|---|
| MSH | 1..1 | Message Header |
| EVN | 1..1 | Event Type |
| PID | 1..1 | Patient Identification |
| PV1 | 1..1 | Visit/Encounter |
| [{ DG1 }] | 0..* | Diagnosis |
| [{ | 0..* | PROCEDURE begin |
| PR1 | 1..1 | Procedure |
| [{ ROL }] | 0..* | Role |
| }] | | PROCEDURE end |