Publisher API HL7 Messages
This page summarises the messages that are currently supported by DDS
Records
- ADT A28 - create patient record
- ADT A31 - update patient record
- ADT A40 - merge patient records
Encounters
- ADT A05 - pre-admit a patient
- ADT A38 - cancel a pre-admit
- ADT A01 - admit a patient
- ADT A11 - cancel admit
- ADT A02 - transfer a patient
- ADT A12 - cancel transfer
- ADT A03 - discharge a patient
- ADT A13 - cancel discharge
Observations
- ORU R01 - send observations
Standard segments & acknowledgements
See Publisher API HL7 Segments for definitions of the segments that are used across the DDS message set. Note that in many cases individual messages refine the standard definitions. Where this is the case it is made clear in the definition of each message below.
DDS returns a standard acknowledgement message. [TODO]
ADT A05: Pre-admit a Patient
Overview
Records an expected future admission of a patient.
Definition
Segments
| Segment | Optionality | Repeating |
|---|---|---|
| MSH - Message Header | R | N |
| EVN - Event Type | R | N |
| PID - Patient Identification | R | N |
| PV1 - Patient Visit | R | N |
| PV2 - Patient Visit - additional information | R | N |
| OBX - Observation/Results | O | N |
| AL1 - Patient allergy information | O | Y |
| DG1 - Diagnosis | O | Y |
Fields
PV1 - Patient Visit
Refines the DDS standard definition of PV1 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV1:3 - Assigned Patient Location | X | Ignored if supplied | |
| PV1:9 - Consulting Doctor | R | If not known please provide "UNKNOWN" for the family name | ^UNKNOWN^^^^^^^^^^^^^^ |
| PV1:36 - Discharge Disposition | X | Ignored if supplied | |
| PV1:37 - Discharged to Location | X | Ignored if supplied | |
| PV1:44 - Admit Date/TIme | X | Ignored if supplied. Instead see EVN:3.2 | |
| PV1:45 - Discharge Date/Time | X | Ignored if supplied |
PV2 - Patient Visit - additional information
Refines the DDS standard definition of PV2 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV2:3 - Admit reason | O | Free text description of the reason for admission | Abdominal pain |
| PV2:4 - Transfer reason | X | Ignored if supplied | |
| PV2:8 - Expected Admit Date/Time | O | Datetime of when admission is expected | 202105250824 |
| PV2:9 - Expected Discharge Date/Time | O | Datetime of when discharge is expected | 202105270824 |
Example
Response
ADT A38: Cancel a pre-admit
Overview
The A38 is sent following the cancellation of a pre-admission event (A05). The reason for cancellation could be that the original pre-admission (A05) was created in error or that a decision was taken to not pre-admit the patient.
This is identical in definition to an ADT A11: Cancel admit
ADT A01: Admit Patient
Overview
This will create an Encounter for the specified patient
Definition
Segments
| Segment | Optionality | Repeating |
|---|---|---|
| MSH - Message Header | R | N |
| EVN - Event Type | R | N |
| PID - Patient Identification | R | N |
| PV1 - Patient Visit | R | N |
| OBX - Observation/Results | O | N |
| AL1 - Patient allergy information | O | Y |
| DG1 - Diagnosis | O | Y |
| PR1 - Procedures | O | Y |
Fields
PV1 - Patient Visit
Refines the DDS standard definition of PV1 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV1:3 - Assigned Patient Location | R | If not known please provide "UNKNOWN" | UNKNOWN |
| PV1:9 - Consulting Doctor | R | If not known please provide "UNKNOWN" for the family name | ^UNKNOWN^^^^^^^^^^^^^^ |
| PV1:36 - Discharge Disposition | X | Ignored if supplied | |
| PV1:37 - Discharged to Location | X | Ignored if supplied | |
| PV1:44 - Admit Date/TIme | R | 202105250824 | |
| PV1:45 - Discharge Date/Time | X | Ignored if supplied |
Example
Response
ADT A11: Cancel admit
Overview
The A11 is sent following the cancellation of an admission event (A01). The reason for cancellation could be that the original admission (A01) was created in error or that a decision was taken to not admit the patient.
Definition
Segments
| Segment | Optionality | Repeating |
|---|---|---|
| MSH - Message Header | R | N |
| EVN - Event Type | R | N |
| PID - Patient Identification | R | N |
| PV1 - Patient Visit | R | N |
Fields
PV1 - Patient Visit
Refines the DDS standard definition of PV1 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV1:3 - Assigned Patient Location | X | Ignored if supplied | |
| PV1:9 - Consulting Doctor | R | If not known please provide "UNKNOWN" for the family name | ^UNKNOWN^^^^^^^^^^^^^^ |
| PV1:36 - Discharge Disposition | X | Ignored if supplied | |
| PV1:37 - Discharged to Location | X | Ignored if supplied | |
| PV1:44 - Admit Date/TIme | X | Ignored if supplied | |
| PV1:45 - Discharge Date/Time | X | Ignored if supplied |
Example
Response
ADT 02: Transfer a Patient
Overview
Records a patient transfer. Note that there can be three kinds of transfer -
- location transfer
- clinician transfer
- location and clinician transfer
In the case of a location transfer PV1:6 (prior patient location) will be populated along with PV1:3 (assigned patient location). In the case of clinician transfer PV1:9 (consulting doctor) will be updated. Note also that EVN:2 (recorded date/time) is used to track the actual time of transfer.
Definition
Segments
| Segment | Optionality | Repeating |
|---|---|---|
| MSH - Message Header | R | N |
| EVN - Event Type | R | N |
| PID - Patient Identification | R | N |
| PV1 - Patient Visit | R | N |
Fields
PV1 - Patient Visit
Refines the DDS standard definition of PV1 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV1:3 - Assigned Patient Location | R | If not known please provide "UNKNOWN". If this is not a location transfer then provide the existing location. If this is a location transfer then provide the new location | UNKNOWN |
| PV1:9 - Consulting Doctor | R | If not known please provide "UNKNOWN" for the family name. If this is not a clinician transfer then provide the existing clinician. If this is a location transfer then provide the new clinician | ^UNKNOWN^^^^^^^^^^^^^^ |
| PV1:36 - Discharge Disposition | X | Ignored if supplied | |
| PV1:37 - Discharged to Location | X | Ignored if supplied | |
| PV1:44 - Admit Date/TIme | X | Ignored if supplied. Instead see EVN:3.2 where the transfer time will be recorded | |
| PV1:45 - Discharge Date/Time | X | Ignored if supplied |
Example
Response
ADT A12: Cancel transfer
Overview
The A12 is sent following the cancellation of a transfer event (A02). The reason for cancellation could be that the original transfer (A02) was created in error or that a decision was taken to not transfer the patient.
Definition
Segments
| Segment | Optionality | Repeating |
|---|---|---|
| MSH - Message Header | R | N |
| EVN - Event Type | R | N |
| PID - Patient Identification | R | N |
| PV1 - Patient Visit | R | N |
Fields
PV1 - Patient Visit
Refines the DDS standard definition of PV1 -
| Field | Optionality | Notes | Example |
|---|---|---|---|
| PV1:3 - Assigned Patient Location | X | Ignored if supplied | |
| PV1:9 - Consulting Doctor | R | If not known please provide "UNKNOWN" for the family name | ^UNKNOWN^^^^^^^^^^^^^^ |
| PV1:36 - Discharge Disposition | X | Ignored if supplied | |
| PV1:37 - Discharged to Location | X | Ignored if supplied | |
| PV1:44 - Admit Date/TIme | X | Ignored if supplied | |
| PV1:45 - Discharge Date/Time | X | Ignored if supplied |