Publisher API HL7 Messages: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
Line 32: Line 32:
This message is used to indicate whether or not DDS has successfully received an inbound message or not.
This message is used to indicate whether or not DDS has successfully received an inbound message or not.


The value of MSH:9.2 (trigger event) is always the same as the trigger event in the inbound message that is being acknowledged. The value of MSH:9.3 (message structure) is always "ACK".
The value of MSH:9.2 (trigger event) is always the same as the trigger event in the inbound message that is being acknowledged.  
{| class="wikitable"
{| class="wikitable"
!Segment
!Segment

Revision as of 16:47, 2 June 2021


This page summarises the messages that are currently supported by DDS

Records

Encounters

Observations

  • ORU R01 - send observations

Standard segments

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]

ACK: General acknowledgement

This message is used to indicate whether or not DDS has successfully received an inbound message or not.

The value of MSH:9.2 (trigger event) is always the same as the trigger event in the inbound message that is being acknowledged.

Segment Optionality Repeating
MSH - Message Header R N
MSA - Message acknowledgement R N

ADT A28: Create patient record

Overview

This message will create a new patient record within DDS. [TODO - what happens if the record exists - will this act as A31?]

Definition

Segments

Segment Optionality Repeating
MSH - Message Header R N
EVN - Event Type R N
PID - Patient Identification R N
AL1 - Patient allergy information O Y
DG1 - Diagnosis O Y

Example

ADT A31: Update patient record

Overview

This message will update an existing patient record within DDS. [TODO - what happens if the record does not exists - will this act as A28?] [TODO - what happens to existing PID, AL1 and/or DG1. Replaced, merged, appended?]

Definition

Segments

Segment Optionality Repeating
MSH - Message Header R N
EVN - Event Type R N
PID - Patient Identification R N
AL1 - Patient allergy information O Y
DG1 - Diagnosis O Y

Example

ADT A40: Merge patient records

Overview

This message is used when two patient records are merged at the patient identifier list level.

Each "incorrect" identifier from MRG:1 is to be merged with the "correct" identifier from PID:3 where both identifiers have the same identifier type code.

In theory the identifiers from MRG:1 should not be used in future transactions when referring to the patient.

Definition

Segments

Segment Optionality Repeating
MSH - Message Header R N
EVN - Event Type R N
PID - Patient Identification R N
MRG - Merge Patient Information R N

Example

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

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" for PV1:6.9 ^^^^^^^^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

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

ADT 02: Transfer a Patient

Overview

Records a patient transfer. Note that there can be three kinds of transfer -

  1. location transfer
  2. clinician transfer
  3. 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" for PV1:6.9. 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

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

Example

ADT A03: Discharge Patient

Overview

This message signals that the patient's stay in the healthcare facility has ended.

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 X Ignored if supplied
PV1:6 - Prior Patient Location O If not known please provide "UNKNOWN" for PV1:6.9 ^^^^^^^^UNKNOWN
PV1:9 - Consulting Doctor R If not known please provide "UNKNOWN" for the family name ^UNKNOWN^^^^^^^^^^^^^^
PV1:36 - Discharge Disposition R If not known please provide "UNKNOWN" UNKNOWN
PV1:37 - Discharged to Location R If not known please provide "UNKNOWN" 19
PV1:44 - Admit Date/TIme X Ignored if supplied
PV1:45 - Discharge Date/Time R 202105250824

Example

ADT A13: Cancel discharge

Overview

The A13 is sent following the cancellation of a discharge event (A03). The reason for cancellation could be that the discharge transfer (A03) was created in error or that a decision was taken to not discharge 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 R Assigned Patient Location should record the location of the patient following the cancellation. In the case of a discharge created in error the location could be different from the patient’s location prior to the erroneous discharge. In this scenario the prior Location could be used to show the location before the erroneous A03 was sent. If Assigned Patient Location is not known please provide "UNKNOWN" for PV1:6.9 ^^^^^^^^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 X Ignored if supplied
PV1:45 - Discharge Date/Time X Ignored if supplied

Example

Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages&oldid=5124’