Publisher API HL7 Messages: Difference between revisions
No edit summary |
|||
| Line 119: | Line 119: | ||
===Response=== | ===Response=== | ||
== ADT | == ADT A11: Cancel admit == | ||
=== Overview === | === 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 === | === Definition === | ||
| Line 146: | Line 146: | ||
|R | |R | ||
|N | |N | ||
|} | |} | ||
'''Fields''' | '''Fields''' | ||
| Line 175: | Line 159: | ||
|- | |- | ||
|PV1:3 - Assigned Patient Location | |PV1:3 - Assigned Patient Location | ||
| | |X | ||
| | |Ignored if supplied | ||
| | | | ||
|- | |- | ||
|PV1:9 - Consulting Doctor | |PV1:9 - Consulting Doctor | ||
| Line 195: | Line 179: | ||
|- | |- | ||
|PV1:44 - Admit Date/TIme | |PV1:44 - Admit Date/TIme | ||
| | |X | ||
|Ignored if supplied | |||
| | | | ||
|- | |- | ||
|PV1:45 - Discharge Date/Time | |PV1:45 - Discharge Date/Time | ||
Revision as of 16:35, 27 May 2021
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" 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 |