Publisher API HL7 Messages
Jump to navigation
Jump to search
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 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" | ^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 |