== Introduction ==
Below are all of the segments that a DDS Publisher using the HL7 API can send. The definitions below are generic and hence are relatively permissive. In the context of a specific message the segment various segment definitions may be refined to take account of the data needed to complete the business function associated with the message. More detail can be found on the [[Publisher API HL7 Messages|HL7 API messages page]]

== MSA - Message acknowledgement ==

=== Overview ===
The MSA segment contains information sent whilst acknowledging an inbound message. The following rules govern the nature of the acknowledgement -

* If the message could not be saved to the DDS message store then an AR (failure occurred, retry) acknowledgement code is returned.
* If the message is malformed, or fails sender, recipient or message type checks, or is missing a message control ID, or fails for an unexpected reason, an AE (failure occurred, move to next message) acknowledgement code is returned.
* If the message passes the above checks and is saved to the message store, an AA (success) acknowledgement code is returned.
* If the message receiver fails to send an acknowledgement (e.g. network outage, hardware failure etc), it is expected the sender will automatically re attempt to send the message.

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|MSA:1 - Acknowledgement code
|MSH:1.1
|ID
|R
|N
|Message type. Allowed values are from table [[Publisher API Code Sets#DDS-HL7v2-AckCode|DDS-HL7v2-AckCode]]
|
|-
|MSA:2 - Message control ID
|MSH:1.1
|ST
|R
|N
|Unique (to DDS) identifier assigned by DDS
|
|-
|-
|MSA:3 - Text message
|MSA:3.1
|ST
|O
|N
|Further describes an error condition (may not always be provided by DDS)
|
|}

== MSH - Message Header ==

=== Overview ===
The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|MSH.1 - Field Separator
|MSH:1.1
|ST
|R
|N
|Defines the character to be used as the separator in the message
|
|-
|MSH.2 - Encoding characters
|MSH:2.1
|ST
|R
|N
|Contains (in the following order) component separator, repetition separator, escape character, and subcomponent separator
|
|-
|MSH:3 - Sending application
|MSH:3.1
|ST
|R
|N
|Sending application name
|
|-
|MSH:4 - Sending facility
|MSH:4.1
|ST
|R
|N
|Sending facility name
|
|-
|MSH:5 - Receiving application
|MSH:5.1
|ST
|R
|N
|Receiving application name
|
|-
|MSH:6 - Receiving facility
|MSH:6.1
|ST
|R
|N
|Receiving facility name
|
|-
|MSH:7 - Message timestamp
|MSH:7.1
|DT
|R
|N
|Datetime that the sending system created the message
|
|-
|-
| rowspan="3" |MSH:9 - Message type
| -
| -
|R
|N
|
|
|-
|MSH:9.1
|ID
|R
|N
|Message type. Allowed values are from table [[Publisher API Code Sets#DDS-HL7v2-MessageType|DDS-HL7v2-MessageType]]
|
|-
|MSH:9.2
|ID
|R
|N
|Trigger event. Allowed values are from table [[Publisher API Code Sets#DDS-HL7v2-EventType|DDS-HL7v2-EventType]]
|
|-
|MSH:10 - Message control ID.
|MSH:10.1
|ST
|R
|N
|This must be unique for all messages sent to DDS by each publisher. However, DDS does not currently detect or reject duplicate messages based on this value, so it is important that each publisher enforces this themselves.
|
|-
|MSH:11 - Processing ID
|MSH:11.1
|PT
|O
|N
|In production MUST be "P"
|
|-
|MSH:12 - Message version
|MSH:12.1
|ID
|R
|N
|The version of HL7 that this message conforms to. MUST be "2.3"
|
|}

== EVN - Event Type ==

=== Overview ===
The EVN segment is used to communicate trigger event information to receiving applications

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|EVN:1 - Event Type Code
|EVN:1.1
|ID
|O
|N
|The value should be the same as theMSH:9.2 (trigger event)
|
|-
|EVN:2 - Recorded Date/Time
|EVN:2.1
|TS
|R
|N
|Timestamp of when the transaction was entered
|
|-
|EVN:3 - Date/Time planned event
|EVN:3.1
|TS
|O
|N
|Avoid populating this field. Instead use PV2 expected admit date and PV2 expected discharge date whenever possible.
|
|-
|EVN:4 - Event reason code
|EVN:4.1
|CWE
|O
|N
|The reason for this event. Allowed values are from table [[Publisher API Code Sets#0062-EventReason|0062-EventReason]]
|
|-
| rowspan="5" |EVN:5 - Operator ID
| -
| -
|O
|N
|Operator ID. If provided, at least the family name must be given.
|
|-
|EVN:5.2
|ST
|R
|N
|Family Name
|
|-
|EVN:5.3
|ST
|O
|N
|Given Name
|
|-
|EVN:5.4
|ST
|O
|N
|Middle Names
|
|-
|EVN:5.6
|ST
|O
|N
|Prefix
|
|-
|EVN:6 - Event occured
|EVN:6.1
|TS
|O
|N
|This field contains the date/time that the event actually occurred. For example, on a transfer (A02 (transfer a patient)), this field would contain the date/time the patient was actually transferred. On a cancellation event, this field should contain the date/time that the event being canceled occurred.
|
|}

== PID - Patient Identification ==

=== Overview ===
The PID segment is used as the main way of communicating patient identification information. The majority of patient identifying and demographic information held within the PID segment is not subject to frequent changes

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PID:2 - Patient ID
| -
| -
|X
|N
|Not used. Instead please populate PID.3 Patient Identifier List
|
|-
| rowspan="3" |PID:3 - Patient Identifier List
| -
| -
|R
|N
|Patient Identifier List. This list must include at least both of the following (in order) -

* the patient's local (to the publisher) identifier. In this instance the assigning authority (PID:3.4) must be "MRN"
*the patient's NHS number. In this instance the assigning authority (PID:3.4) must be "NHS"
|
|-
|PID:3.1
|ST
|R
|Y
|Patient ID
|
|-
|PID:3.4
|ST
|R
|N
|Assigning authority
|
|-
| rowspan="5" |PID:5 - Patient Name
| -
| -
|R
|N
|
|
|-
|PID:5.1
|ST
|R
|N
|Family name
|
|-
|PID:5.2
|ST
|O
|N
|Given name
|
|-
|PID:5.3
|ST
|O
|N
|Middle names
|
|-
|PID:5.5
|ST
|O
|N
|Title
|
|-
|PID:7
|PID:7.1
|TS
|R
|N
|Date of birth
|
|-
|PID:8
|PID:8.1
|IS
|R
|N
|Administrative sex. Allowed values are from table [[Publisher_API_Code_Sets#0001-AdministrativeSex|0001-AdministrativeSex]]
|
|-
| rowspan="8" |PID:11 - Patient Address
| -
| -
|O
|N
|
|
|-
|PID:11.1
|ST
|O
|N
|Address line 1
|
|-
|PID:11.2
|ST
|O
|N
|Address line 2
|
|-
|PID:11.3
|ST
|O
|N
|City
|
|-
|PID:11.5
|ST
|O
|N
|Post code
|
|-
|PID:11.6
|ID
|O
|N
|Country. Allowed values are from table [[Publisher API Code Sets#0399-CountryCode|0399-CountryCode]]
|
|-
|PID:11.7
|ID
|O
|N
|Address usage eg temporary address
|
|-
|PID:11.9
|IS
|O
|N
|County
|
|-
| rowspan="3" |PID:13 - Home contact information
| -
| -
|O
|N
|
|
|-
|PID:13.1
|TN
|O
|N
|Contact value
|
|-
|PID:13.2
|ID
|O
|N
|Contact use code. Allowed values are "home" or "mobile"
|
|-
| rowspan="3" |PID:14 - Work contact information
| -
| -
|O
|N
|
|
|-
|PID:14.1
|TN
|O
|N
|Contact value
|
|-
|PID:14.2
|ID
|O
|N
|Contact use code. Allowed values is "work"
|
|-
| rowspan="2" |PID:15 - Primary language
| -
| -
|O
|N
|Primary language. This should be the ISO 639-1 code or one of the five communication method extensions defined in the NHS Data Dictionary code set.
|
|-
|PID:15.1
|ST
|O
|N
|Primary language. Allowed values are from [https://datadictionary.nhs.uk/attributes/language_code.html LANGUAGE CODE]
|
|-
|PID:17 - Religion
|PID:17.1
|IS
|O
|N
|Religion. Allowed values are from [https://datadictionary.nhs.uk/attributes/religious_or_other_belief_system_affiliation_code.html RELIGIOUS OR OTHER BELIEF SYSTEM AFFILIATION CODE]
|
|-
|PID:18 - Patient Account Number
|PID:18.1
|ST
|C
|N
|Though officially this field is intended to capture account number it has been repurposed in DDS. It is used to carry the identifier for the episode of care. Simplistically an episode of care encapsulates all of the encounters that a patient may have with a healthcare organisation from the point of referral to the point of discharge.
If the publisher does not have the concept of episode of care then instead this MUST be the same value as that found in PV1.19 - Visit number.

If no PV1 segment accompanies this PID segment then PID:18 should not be populated
|
|-
|PID:22 - Ethnic group
| -
| -
|O
|N
|
|
|-
|
|PID:22.1
|ST
|O
|N
|Ethnicity identifier. Allowed values are from [https://datadictionary.nhs.uk/data_elements/ethnic_category.html?hl=ethnicity ETHNIC CATEGORY]
|
|-
|PID:29 - Patient Death Date and Time
|PID:29.1
|TS
|C
|N
|If PID.30:1 is not empty and PID:30.1 == "Y" then PID:29 is mandatory
|
|-
|PID:30 - Patient Death Indicator
|PID:30.1
|ID
|O
|N
|"Y" or "N"
|
|}

== PD1 - Patient Additional Demographic ==

=== Overview ===
The PD1 segment contains demographic information about a patient that is likely to change. In the case of DDS is it used to carry GP data.

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
| rowspan="3" |PD1:3 - Patient Primary Facility
| -
| -
|R
|N
|
|
|-
|PD1:3.1
|ST
|R
|N
|name
|
|-
|PD1:3.3
|ST
|R
|N
|ODS code
|
|-
| rowspan="5" |PD1:4 - Patient Primary Care Provider Name and ID No
| -
| -
|R
|N
|
|
|-
|PD1:4.1
|ST
|R
|N
|GMC code
|
|-
|PD1:4.2
|FN
|R
|N
|Family name
|
|-
|PD1:4.3
|ST
|R
|N
|Given name
|
|-
|PD1:4.6
|ST
|O
|N
|Prefix
|
|}
== MRG - Merge Patient Information ==

=== Overview ===
The MRG segment is used by DDS to support merging of patient identifiers

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|MRG:1 - Prior Patient Identifier List
|MRG:1.1
| CX
|R
|N
|MUST only contain one value - the patient's local (to the publisher) identifier.
|
|-
|MRG:2 - Prior Alternate Patient ID
|
|CX
|X
|N
|Ignored if supplied
|
|-
|MRG:3 - Prior Alternate Account Number
|
|CX
|X
|N
|Ignored if supplied
|
|-
|MRG:4 - Prior Patient ID
|
| -
|X
|N
|Ignored if supplied
|
|-
|MRG:5 - Prior Visit Number
|
|CX
|X
|N
|Ignored if supplied
|
|-
|MRG:6 - Prior Alternate Visit ID
|
|CX
|X
|N
|Ignored if supplied
|
|-
|MRG:7 - Prior Patient Name
| -
| XPN
|X
|N
|Ignored if supplied
|
|} 

== PV1 - Patient Visit ==

=== Overview ===
The PV1 segment is used by Registration/Patient Administration applications to communicate information on a visit-specific basis.

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PV1:2 - Patient Class
|PV1:2.1
|ID
|R
|N
|Allowed values are from table [[Publisher API Code Sets#0004-PatientClass|0004-PatientClass]]
|
|-
|PV1:3 - Assigned Patient Location
|PV1:3.1
|IS
|R
|N
|General patient location
|
|-
|PV1:4 - Admission Type
|PV1:4.1
|ID
|O
|N
|Allowed values are from [https://datadictionary.nhs.uk/attributes/admission_method.html ADMISSION METHOD]
|
|-
| rowspan="5" |PV1:8 - Referring Doctor
| -
| -
|O
|N
|Referring doctor. If provided, at least the family name must be given.
|
|-
|PV1:8.1
|ST
|O
|N
|ID number
|
|-
|PV1:8.2
|ST
|O
|N
|Family Name
|
|-
|PV1:8.3
|ST
|O
|N
|Given Name
|
|-
|PV1:8.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="5" |PV1:9 - Consulting Doctor
| -
| -
|R
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|-
|PV1:9.1
|ST
|R
|N
|ID number
|
|-
|PV1:9.2
|ST
|R
|N
|Family Name
|
|-
|PV1:9.3
|ST
|O
|N
|Given Name
|
|-
|PV1:9.6
|ST
|O
|N
|Prefix
|
|-
|PV1:10 - Hospital Service
|PV1:10.1
|IS
|R
|N
|Allowed values are from [https://datadictionary.nhs.uk/attributes/treatment_function_code.html TREATMENT FUNCTION CODE]
|
|-
|PV1:14 - Admit source
|PV1:14.1
|IS
|O
|N
|Allowed values are from [https://datadictionary.nhs.uk/attributes/source_of_admission.html SOURCE OF ADMISSION]
|
|-
|PV1:18 - Patient Type
|PV1:18.1
|IS
|R
|N
|Allowed values are from table [[Publisher API Code Sets#HL7v3-EncounterType|HL7v3-EncounterType]]
|
|-
|PV1:19 - Visit Number
|PV1:19.1
|CX
|R
|N
|Visit ID. Should uniquely identify an Encounter from the DDS publisher.
|
|-
|PV1:36 - Discharge Disposition
|PV1:36.1
|IS
|O
|N
|Allowed values are from [https://datadictionary.nhs.uk/attributes/discharge_method.html DISCHARGE METHOD]
|
|-
|PV1:37 - Discharged to Location
|PV1:37.1
|ID
|O
|N
|Allowed values are from [https://datadictionary.nhs.uk/attributes/discharge_destination.html DISCHARGE DESTINATION]
|
|-
|PV1:44 - Admit Date/Time
|PV1:44.1
|TS
|C
|N
|Admit timestamp
|
|-
|PV1:45 - Discharge Date/Time
|PV1:45.1
|TS
|O
|N
|Discharge timestamp
|
|}

== NTE - Notes and Comments ==

=== Overview ===
The NTE segment is used to hold comments [TODO - are there any constraints on the size of an individual comment]

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|NTE:3 - Comment
|NTE:3.1
|FT
|R
|Y
|Comment
|
|}

== ORC - Common Order ==

=== Overview ===
The ORC segment is used to carry information that is common across an order

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|ORC:3 - Filler Order number
|ORC:3.1
|ST
|O
|N
|This string must uniquely identify an order from other orders in the filling system
|
|-
| rowspan="4" |ORC:21 - Ordering Facility name
| -
| -
|R
|N
|Used to differentiate between different sources of result data (eg GP vs acute settings)
|
|-
|ORC:21.1
|ST
|O
|N
|Facility name
|
|-
|ORC:21.3
|ST
|R
|N
|Facility ID. Note that this MUST be the ODS code of the ordering facility
|
|-
|ORC:21.7
|ID
|R
|N
|Facility ID type. Allowed values are from table [[Publisher API Code Sets#0074-DiagnosticServiceSectionID|0074-DiagnosticServiceSectionID]]
|
|}

== OBR - Observation Request ==

=== Overview ===
DDS interprets an OBR as either representing a single textual laboratory report or a collection of individual test results. More information can be found in the [[Publisher API HL7 Messages#ORU_R01:_Unsolicited_Observation_.28Laboratory.29|ORU R01]] - Unsolicited Observation definition.
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBR:3 - Filler Order number
|OBR:3.1
|ST
|C
|N
|OBR:3-filler order number is identical to ORC:3-filler order number.
If the filler order number is not present in the ORC, it must be present in the associated OBR
|
|-
| rowspan="5" |OBR:4 - Universal Service Identifier
| -
| -
|R
|N
|
|
|-
|OBR:4.1
|ST
|R
|N
|Service Identifier
|
|-
|OBR:4.2
|ST
|R
|N
|Service name
|
|-
|OBR:4.3
|ID
|R
|N
|Service coding system. Allowed values are [TODO]
|
|-
|OBR:4.5
|ST
|O
|N
|Alternative service name
|
|-
|OBR:7 - Observation date/time
|ORC:7.1
|TS
|C
|N
|Observation timestamp. If this is not present, OBX:14 is used instead. It is an error for neither to be provided.
|
|-
| rowspan="5" |OBR:16 - Ordered by
|
|
|O
|N
|If provided, at least the family name must be given.
|
|-
|OBR:16.2
|ST
|R
|N
|Family Name
|
|-
|OBR:16.3
|ST
|O
|N
|Given Name
|
|-
|OBR:16.4
|ST
|O
|N
|Middle Names
|
|-
|OBR:16.6
|ST
|O
|N
|Prefix
|
|-
|OBR:24 - Discipline
|OBR:24.1
|ID
|O
|N
|This field is the section of the diagnostic service where the observation was performed.
If the study was performed by an outside service, the identification of that service should be recorded here. Allowed values are from table [[Publisher API Code Sets#0074-DiagnosticServiceSectionID|0074-DiagnosticServiceSectionID]]
|
|-
|OBR:25 - Result status
|OBR:25.1
|ID
|O
|N
|Only values of F and C will be processed. Values of I, O, P or X (which indicate pending or no results) are silently ignored, whilst any other values will cause an error. Allowed values are from table [[Publisher API Code Sets#DDS-ResultStatus|DDS-ResultStatus]]
|
|}

=== Definition ===

== OBX - Observation or result ==

=== Overview ===
The OBX segment can carry an observation about the patient or it can also be used to carry test results.

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:1 - Set ID
|OBX:1.1
|SI
|R
|N
|Sequence number for OBX. Must be unique under its associated OBR segment
|
|-
|OBX:2 - Value Type
|OBX:2.1
|ID
|R
|N
|Allowed values are from table [[Publisher API Code Sets#0125-ValueType|0125-ValueType]]
|
|-
| rowspan="4" |OBX:3 - Observation Identifier
| -
| CWE
|R
|Y
|If this is a textual report, this value will be overridden by OBR:4. Otherwise this value must be provided.
|
|-
|OBX:3.1
|ST
|R
|N
|Test ID. If this is a textual report, this value will be overridden by OBR:4.1. Otherwise this value must be provided. If a measurement is being provided, this ID must match one of the predefined values which DDS can accept.
|
|-
|OBX:3.2
|ST
|O
|N
|Test Name
|
|-
|OBX:3.3
|ST
|C
|N
|Test coding system. If this is a textual report, this value will be overridden by OBR:4.3.
|
|-
|OBX:5 - Observation Value
| OBX:5.1
| VARIES
|R
|N
|Value. Type MUST match OBX:2.1
|
|-
| rowspan="4" |OBX:6 - Observation Units
| -
| -
|O
|N
|
|
|-
|OBX:6.1
|ST
|R
|N
|Unit ID
|
|-
|OBX:6.2
|ST
|O
|N
|Unit Name
|
|-
|OBX:6.3
|ST
|R
|N
|Unit coding system
|
|-
|OBX:7
|OBX:7.1
|ST
|O
|N
|Reference range. Can be used to convey low value, high value and normal value. DDS will parse the data into one or more of these categories depending upon how the reference range value is formatted 

* [low value]"-"[high value]
* "<"[Number] (i.e. "less than number")
* ">"[Number] (i.e. "greater than number")
* "<="[Number] (i.e. "less than or equal to number")
* ">="[Number] (i.e. "greater than or equal to number")
* [Alphabetic value indicating normal value]
|See table below for examples
|-
| rowspan="4" |OBX:8 - Abnormal flag
| -
| -
|C
|N
|To flag the result as abnormal (e.g., High, Low) this flag MUST be sent in the message
|
|-
|OBX:8.1
|
|R
|N
|Flag ID - allowed values are from <nowiki>http://terminology.hl7.org/ValueSet/v3-ObservationInterpretation</nowiki>
|
|-
|OBX:8.2
|
|O
|
|Flag name
|
|-
|OBX:8.3
|
|O
|N
|Flag coding system - If present then MUST be "<nowiki>http://terminology.hl7.org/ValueSet/v3-ObservationInterpretation</nowiki>"
|
|-
|OBX:11
|ST
|O
|N
|Result status
|Result status. Only values of F and C will be processed. Values of I, O, P or X (which indicate pending or no results) are silently ignored, whilst any other values will cause an error. Allowed values are from table [[Publisher API Code Sets#DDS-ResultStatus|DDS-ResultStatus]]
|
|-
|OBX:13
|ST
|O
|N
|Custom access rules
|Custom access rules for lab results. Currently supported: "{patientDelay:NUMBERdays}" with any whole number in place of "NUMBER" (no spaces). The patient will see that a lab result has arrived, but the result value will not be revealed until the set number of days past the date/time of observation have passed. If this field is not specified the patient will be able to see their results immediately. Note: if this OBR group is a textual report spanning multiple OBX segments, the delay must be provided in the first.
|{patientDelay:3days}
|-
|OBX:14
|ST
|C
|N
|Date/Time of the Observation
|Observation timestamp. If this is not present, OBR:7 is used instead. It is an error for neither to be provided.
|
|
|-
| rowspan="5" |OBX:16 - Responsible Observer
|
|
|O
|N
|If provided, at least the family name must be given.
|
|-
|OBX:16.2
|ST
|R
|N
|Family Name
|
|-
|OBX:16.3
|ST
|O
|N
|Given Name
|
|-
|OBX:16.4
|ST
|O
|N
|Middle Names
|
|-
|OBX:16.6
|ST
|O
|N
|Prefix
|}

=== Reference range ===
{| class="wikitable"
!OBX:7 value
!Low value
!High value
!Normal value
|-
|"3-4"
|3
|4
| -
|-
|"3--4"
|3
| -4
| -
|-
|"-3-4"
| -3
|4
| -
|-
|"3 - 4"
|3
|4
| -
|-
|" 5"
| -
| -
|5
|-
|">5"
| -
| -
|">5"
|-
|"POS"
| -
| -
|"POS"
|}Each AL1 segment describes a single patient allergy.

=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|AL1:2 - Allergy type
|AL1:2.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0127-AllergenType|0127-AllergenType]]
|
|-
| rowspan="4" |AL1:3 - Allergy code/description
| -
| -
|R
|N
|
|
|-
|AL1:3.1
|ST
|O
|N
|Allergy ID.
|
|-
|AL1:3.2
|ST
|C
|N
|Allergy Name. If AL1:3.1 is not provided then Allergy name is required
|
|-
|AL1:3.3
|ST
|C
|N
|Allergy coding system. If AL1:3.1 is provided then Allergy coding system is required
|
|-
|AL1:4 - Allergy severity
|AL1:4.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0128-AllergySeverity|0128-AllergySeverity]]
|
|-
|AL1:5 - Allergy reaction
|AL1:5.1
|ST
|O
|N
|
|
|-
|AL1:6 - Allergy identification date
|AL1:6.1
|DT
|O
|N
|
|
|}

Publisher API Code Sets

2021-10-21T10:22:56Z

Will Weatherill: /* 0113-DischargedToLocation */

Publisher API Code Sets

2021-10-21T10:21:45Z

Will Weatherill: /* 0112-DischargeDisposition */

Publisher API Code Sets

2021-10-21T10:20:54Z

Will Weatherill: /* DDS-AdmissionSource */

2021-09-06T13:28:36Z

Will Weatherill: /* Overview */

__NOTOC__

This page summarises the messages that are currently supported by DDS

'''Acknowledgement'''

*[[Publisher API HL7 Messages#ACK: General acknowledgement|ACK]] - general acknowledgement

'''Records'''

*[[Publisher API HL7 Messages#ADT A28: Create patient record|ADT A28]] - create patient record
*[[Publisher API HL7 Messages#ADT A31: Update patient record|ADT A31]] - update patient record
*[[Publisher API HL7 Messages#ADT A34: Merge Patient Information - Patient ID Only|ADT A34]] - merge patient records

'''Encounters'''

*[[Publisher API HL7 Messages#ADT A05: Pre-admit a Patient|ADT A05]] - pre-admit a patient
*[[Publisher API HL7 Messages#ADT A38: Cancel a pre-admit|ADT A38]] - cancel a pre-admit
*[[Publisher API HL7 Messages#ADT A01: Admit Patient|ADT A01]] - admit a patient
*[[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11]] - cancel admit
*[[Publisher API HL7 Messages#ADT 02: Transfer a Patient|ADT A02]] - transfer a patient
*[[Publisher API HL7 Messages#ADT A12: Cancel transfer|ADT A12]] - cancel transfer
*[[Publisher API HL7 Messages#ADT A03: Discharge Patient|ADT A03]] - discharge a patient
*[[Publisher API HL7 Messages#ADT A13: Cancel discharge|ADT A13]] - cancel discharge
*[[Publisher API HL7 Messages#ADT A08: Update Patient Information|ADT A08]] - update patient information

'''Observations'''

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation|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.

== 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.
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#MSA - Message acknowledgement|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
===Example===

== ADT A34: Merge Patient Information - Patient ID Only ==

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

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

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

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#MRG - Merge Patient Information|MRG - Merge Patient Information]]
|R
|N
|}
===Example===
== ADT A05: Pre-admit a Patient ==

=== Overview ===
Records an expected future admission of a patient.

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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 [[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11: Cancel admit]]
== ADT A01: Admit Patient ==

=== Overview ===
This will create an Encounter for the specified patient

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV1:3 - Assigned Patient Location
|R
|If not known please provide "UNKNOWN" for PV1:6.9
|^^^^^^^^UNKNOWN
|-
|PV1:4 - Admission Type
|R
|
|
|-
|PV1:9 - Consulting Doctor
|R
|If not known please provide "UNKNOWN" for the family name
|^UNKNOWN^^^^^^^^^^^^^^
|-
|PV1:14 - Admit source
|R
|
|
|-
|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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 -

# 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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV2:3 - Admit reason
|X
|Ignored if supplied
|
|-
|PV2:4 - Transfer reason
|O
|Free text description of the reason for the transfer
|
|-
|PV2:8 - Expected Admit Date/Time
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|R
|
|
|-
|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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===

== ADT A08: Update Patient Information ==

=== '''Overview''' ===
An A08 message is used to update existing encounter information. Note that it is important to supply a value for PV1:19 (Visit number) in order to match the encounter to update.

[TODO] -

* confirm behaviour if A08 is sent an no encounter exists
* confirm what happens to the previous version of the updated data (is it retained and retrievable?)
* What are the rules around triggered an update, for example if a field is left blank in PV1 does that mean that the existing data in DDS will not be updated?
* is it only the PV1 segment that is used as a source data to update i.e. the PID segment is ignored?

=== '''Definition''' ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PV1:2 - Patient Class
|PV1:2.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0004-PatientClass|0004-PatientClass]]
|
|-
|PV1:3 - Assigned Patient Location
|PV1:3.1
|IS
|O
|N
|General patient location
|
|-
|PV1:4 - Admission Type
|PV1:4.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0007-AdmissionType|0007-AdmissionType]]
|
|-
|PV1:6 - Prior Patient Location
|PV1:6.9
|ST
|O
|N
|Free text description of the location
|
|-
| rowspan="5" |PV1:7 - Attending Doctor
| -
| -
|O
|N
|Attending doctor. If provided, at least the family name must be given.
|
|-
|PV1:7.2
|ST
|R
|N
|Family Name
|
|-
|PV1:7.3
|ST
|O
|N
|Given Name
|
|-
|PV1:7.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:7.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="5" |PV1:8 - Referring Doctor
| -
| -
|O
|N
|Referring doctor. If provided, at least the family name must be given.
|
|-
|PV1:8.2
|ST
|R
|N
|Family Name
|
|-
|PV1:8.3
|ST
|O
|N
|Given Name
|
|-
|PV1:8.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:8.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="6" |PV1:9 - Consulting Doctor
| -
| -
|O
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|-
|PV1:9.1
|ST
|R
|N
|ID number
|
|-
|PV1:9.2
|ST
|R
|N
|Family Name
|
|-
|PV1:9.3
|ST
|O
|N
|Given Name
|
|-
|PV1:9.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:9.6
|ST
|O
|N
|Prefix
|
|-
|PV1:10 - Hospital Service
|PV1:10.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0069-HospitalService|0069-HospitalService]]
|
|-
|PV1:13 - Re-admission Indicator
|PV1:13.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0092-Re-AdmissionIndicator|0092-Re-AdmissionIndicator]]
|
|-
|PV1:14 - Admit source
|PV1:14.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#DDS-AdmissionSource|DDS-AdmissionSource]]
|
|-
|PV1:18 - Patient Type
|PV1:18.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#HL7v3-EncounterType|HL7v3-EncounterType]]
|
|-
|PV1:36 - Discharge Disposition
|PV1:36.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0112-DischargeDisposition|0112-DischargeDisposition]]
|
|-
|PV1:37 - Discharged to Location
|PV1:37.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0113-DischargedToLocation|0113-DischargedToLocation]]
|
|-
|PV1:44 - Admit Date/Time
|PV1:44.1
|TS
|O
|N
|Admit timestamp
|
|-
|PV1:45 - Discharge Date/Time
|PV1:45.1
|TS
|O
|N
|Discharge timestamp
|}

== ORU R01: Unsolicited Observation ==

=== Overview ===
DDS supports two kinds of Observation -

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Laboratory.29|Laboratory observation]]
*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Radiology.29|Radiology Observation]]

DDS differentiates these by examining the value of MSH:3.1. For Radiology observations that value MUST be "RADIOLOGY". Any other value is interpreted as a Laboratory observation.

==== Schema ====

[[File:Schema.png]]

Note - In the diagram above the grey boxes are logical groupings of segments

=== Definition ===
'''segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|O
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PV1 - Patient Visit|PV1 - Patient Visit]]
|O
|N
|-
|[[Publisher API HL7 Segments#ORC - Common Order|ORC - Common Order]]
|O
|Y
|-
|[[Publisher API HL7 Segments#OBR - Observation Request|OBR - Observation Request]]
|C
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation or result]]
|C
|Y
|-
|[[Publisher API HL7 Segments#NTE - Notes and Comments|NTE - Notes and Comments]]
|O
|Y
|}

== ORU R01: Unsolicited Observation (Laboratory) ==

=== Overview ===
This message is used to transmit unsolicited laboratory results into DDS. [TODO - how to differentiate path from rad results?]

==== Interpretation of observations ====
Depending upon the structure of the R01, DDS will interpret the message in one of three ways.

===== Single textual laboratory report =====
The following criteria are used to determine if an OBR contains a single textual laboratory report -

* There are one or more OBX segments which when combined hold at least two lines of text
* Each OBX segment has a textual data type (TX, FT or ST)
* Each OBX segment has the same test ID as the others (OBX:3)

The OBX segments are interpreted as lines of a report as are any NTE segments directly associated with the OBR.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

===== Collection of individual test results =====
If an OBR group does not meet the criteria for a single textual laboratory report then DDS assumes it to contain a collection of individual test results. DDS considers the comments for a given test result (OBX) to be the combination of the comments (NTE segments) associated directly with the OBR plus the comments (NTE segments) associated directly with the test result.

'''Embedded PDF result'''

If OBX.2.1 (Value Type) contains "ED" then it is expected that the OBX segments contains an embedded, Base64-encoded PDF document

===== NTE - Notes and Comments =====
DDS will interpret comments differently depending on where in the R01 message an NTE segment is found -

* NTE segments that immediately follow the OBR segment are considered by DDS to apply to all results in the R01 message
* NTE segments immediately following an OBX segment are considered by DDS to apply only to the immediately preceding result

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX%20-%20Observation%20or%20result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:3 - Observation Identifier
|OBX:3.3
|ST
|R
|N
|DDS will only accept a measurement if this value is "SNOMED-CT"
|<nowiki>26604007 | Complete blood count (procedure)</nowiki>
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "document"
|document
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "pdf"
|pdf
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded PDF document
|
|}
ORC - Common Order

Refines the [[Publisher API HL7 Segments#ORC - Common Order|DDS standard definition of ORC]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|ORC:3 - Filler Order number
|ORC:3.1
|ST
|C
|N
|This string is required if OBR:3.1 is not provided
|
|}
=== Example ===

== ORU R01: Unsolicited Observation (Radiology) ==

=== Overview ===

==== Interpretation of observations ====
DDS only interprets a radiology observation in one way - as a single textual report with multiple image attachments.

If an OBX segments contains an image (OBX:2.1 = "ED" and OBX:5.2 = "image") then the image will be extracted and added as an attachment to the textual report. The ordering of the OBX segments containing images is not meaningful to DDS.

An NTE segment or an OBX segment that does not hold an image is considered to contain a portion of the report. The ordering of these segments will be respected by DDS and it will concatenate them to form a single textual report.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX - Observation or result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:2 - Value Type
|OBX:2.1
|ID
|R
|N
|Radiology messages only support FT, TX or ED
|ED
|-
|OBX:3 - Observation Identifier
|OBX:3.2
|ST
|R
|N
|Needed to allow consumers to understand the type of radiology study that this observation represents
|X-ray pelvis
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "image" or "document"
|image
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED"
if OBX:5.2 = "image" then MUST be "TIFF"

else if OBX:5.2 = "document" then must be "pdf"
|TIFF
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded image or PDF document
|
|}

Publisher API HL7 Messages

2021-09-06T11:34:28Z

Will Weatherill: /* Definition */

__NOTOC__

This page summarises the messages that are currently supported by DDS

'''Acknowledgement'''

*[[Publisher API HL7 Messages#ACK: General acknowledgement|ACK]] - general acknowledgement

'''Records'''

*[[Publisher API HL7 Messages#ADT A28: Create patient record|ADT A28]] - create patient record
*[[Publisher API HL7 Messages#ADT A31: Update patient record|ADT A31]] - update patient record
*[[Publisher API HL7 Messages#ADT A34: Merge Patient Information - Patient ID Only|ADT A34]] - merge patient records

'''Encounters'''

*[[Publisher API HL7 Messages#ADT A05: Pre-admit a Patient|ADT A05]] - pre-admit a patient
*[[Publisher API HL7 Messages#ADT A38: Cancel a pre-admit|ADT A38]] - cancel a pre-admit
*[[Publisher API HL7 Messages#ADT A01: Admit Patient|ADT A01]] - admit a patient
*[[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11]] - cancel admit
*[[Publisher API HL7 Messages#ADT 02: Transfer a Patient|ADT A02]] - transfer a patient
*[[Publisher API HL7 Messages#ADT A12: Cancel transfer|ADT A12]] - cancel transfer
*[[Publisher API HL7 Messages#ADT A03: Discharge Patient|ADT A03]] - discharge a patient
*[[Publisher API HL7 Messages#ADT A13: Cancel discharge|ADT A13]] - cancel discharge
*[[Publisher API HL7 Messages#ADT A08: Update Patient Information|ADT A08]] - update patient information

'''Observations'''

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation|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.

== 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.
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#MSA - Message acknowledgement|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
===Example===

== ADT A34: Merge Patient Information - Patient ID Only ==

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

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

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

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#MRG - Merge Patient Information|MRG - Merge Patient Information]]
|R
|N
|}
===Example===
== ADT A05: Pre-admit a Patient ==

=== Overview ===
Records an expected future admission of a patient.

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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 [[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11: Cancel admit]]
== ADT A01: Admit Patient ==

=== Overview ===
This will create an Encounter for the specified patient

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV1:3 - Assigned Patient Location
|R
|If not known please provide "UNKNOWN" for PV1:6.9
|^^^^^^^^UNKNOWN
|-
|PV1:4 - Admission Type
|R
|
|
|-
|PV1:9 - Consulting Doctor
|R
|If not known please provide "UNKNOWN" for the family name
|^UNKNOWN^^^^^^^^^^^^^^
|-
|PV1:14 - Admit source
|R
|
|
|-
|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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 -

# 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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV2:3 - Admit reason
|X
|Ignored if supplied
|
|-
|PV2:4 - Transfer reason
|O
|Free text description of the reason for the transfer
|
|-
|PV2:8 - Expected Admit Date/Time
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|R
|
|
|-
|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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===

== ADT A08: Update Patient Information ==

=== '''Overview''' ===
An A08 message is used to update existing encounter information. Note that it is important to supply a value for PV1:19 (Visit number) in order to match the encounter to update.

[TODO] -

* confirm behaviour if A08 is sent an no encounter exists
* confirm what happens to the previous version of the updated data (is it retained and retrievable?)
* What are the rules around triggered an update, for example if a field is left blank in PV1 does that mean that the existing data in DDS will not be updated?
* is it only the PV1 segment that is used as a source data to update i.e. the PID segment is ignored?

=== '''Definition''' ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PV1:2 - Patient Class
|PV1:2.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0004-PatientClass|0004-PatientClass]]
|
|-
|PV1:3 - Assigned Patient Location
|PV1:3.1
|IS
|O
|N
|General patient location
|
|-
|PV1:4 - Admission Type
|PV1:4.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0007-AdmissionType|0007-AdmissionType]]
|
|-
|PV1:6 - Prior Patient Location
|PV1:6.9
|ST
|O
|N
|Free text description of the location
|
|-
| rowspan="5" |PV1:7 - Attending Doctor
| -
| -
|O
|N
|Attending doctor. If provided, at least the family name must be given.
|
|-
|PV1:7.2
|ST
|R
|N
|Family Name
|
|-
|PV1:7.3
|ST
|O
|N
|Given Name
|
|-
|PV1:7.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:7.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="5" |PV1:8 - Referring Doctor
| -
| -
|O
|N
|Referring doctor. If provided, at least the family name must be given.
|
|-
|PV1:8.2
|ST
|R
|N
|Family Name
|
|-
|PV1:8.3
|ST
|O
|N
|Given Name
|
|-
|PV1:8.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:8.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="6" |PV1:9 - Consulting Doctor
| -
| -
|O
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|-
|PV1:9.1
|ST
|R
|N
|ID number
|
|-
|PV1:9.2
|ST
|R
|N
|Family Name
|
|-
|PV1:9.3
|ST
|O
|N
|Given Name
|
|-
|PV1:9.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:9.6
|ST
|O
|N
|Prefix
|
|-
|PV1:10 - Hospital Service
|PV1:10.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0069-HospitalService|0069-HospitalService]]
|
|-
|PV1:13 - Re-admission Indicator
|PV1:13.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0092-Re-AdmissionIndicator|0092-Re-AdmissionIndicator]]
|
|-
|PV1:14 - Admit source
|PV1:14.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#DDS-AdmissionSource|DDS-AdmissionSource]]
|
|-
|PV1:18 - Patient Type
|PV1:18.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#HL7v3-EncounterType|HL7v3-EncounterType]]
|
|-
|PV1:36 - Discharge Disposition
|PV1:36.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0112-DischargeDisposition|0112-DischargeDisposition]]
|
|-
|PV1:37 - Discharged to Location
|PV1:37.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0113-DischargedToLocation|0113-DischargedToLocation]]
|
|-
|PV1:44 - Admit Date/Time
|PV1:44.1
|TS
|O
|N
|Admit timestamp
|
|-
|PV1:45 - Discharge Date/Time
|PV1:45.1
|TS
|O
|N
|Discharge timestamp
|}

== ORU R01: Unsolicited Observation ==

=== Overview ===
DDS supports two kinds of Observation -

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Laboratory.29|Laboratory observation]]
*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Radiology.29|Radiology Observation]]

DDS differentiates these by examining the value of MSH:3.1. For Radiology observations that value MUST be "RADIOLOGY". Any other value is interpreted as a Laboratory observation.

==== Schema ====

[[File:Schema.png]]

Note - In the diagram above the grey boxes are logical groupings of segments

=== Definition ===
'''segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|O
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PV1 - Patient Visit|PV1 - Patient Visit]]
|O
|N
|-
|[[Publisher API HL7 Segments#ORC - Common Order|ORC - Common Order]]
|O
|Y
|-
|[[Publisher API HL7 Segments#OBR - Observation Request|OBR - Observation Request]]
|C
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation or result]]
|C
|Y
|-
|[[Publisher API HL7 Segments#NTE - Notes and Comments|NTE - Notes and Comments]]
|O
|Y
|}

== ORU R01: Unsolicited Observation (Laboratory) ==

=== Overview ===
This message is used to transmit unsolicited laboratory results into DDS. [TODO - how to differentiate path from rad results?]

==== Interpretation of observations ====
Depending upon the structure of the R01, DDS will interpret the message in one of three ways.

===== Single textual laboratory report =====
The following criteria are used to determine if an OBR contains a single textual laboratory report -

* There are one or more OBX segments which when combined hold at least two lines of text
* Each OBX segment has a textual data type (TX, FT or ST)
* Each OBX segment has the same test ID as the others (OBX:3)

The OBX segments are interpreted as lines of a report as are any NTE segments directly associated with the OBR.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

===== Collection of individual test results =====
If an OBR group does not meet the criteria for a single textual laboratory report then DDS assumes it to contain a collection of individual test results, each with it's own test code in OBX:3. DDS considers the comments for a given test result (OBX) to be the combination of the comments (NTE segments) associated directly with the OBR plus the comments (NTE segments) associated directly with the test result.

'''Embedded PDF result'''

If OBX.2.1 (Value Type) contains "ED" then it is expected that the OBX segments contains an embedded, Base64-encoded PDF document

===== NTE - Notes and Comments =====
DDS will interpret comments differently depending on where in the R01 message an NTE segment is found -

* NTE segments that immediately follow the OBR segment are considered by DDS to apply to all results in the R01 message
* NTE segments immediately following an OBX segment are considered by DDS to apply only to the immediately preceding result

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX%20-%20Observation%20or%20result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:3 - Observation Identifier
|OBX:3.3
|ST
|R
|N
|DDS will only accept a measurement if this value is "SNOMED-CT"
|<nowiki>26604007 | Complete blood count (procedure)</nowiki>
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "document"
|document
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "pdf"
|pdf
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded PDF document
|
|}
ORC - Common Order

Refines the [[Publisher API HL7 Segments#ORC - Common Order|DDS standard definition of ORC]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|ORC:3 - Filler Order number
|ORC:3.1
|ST
|C
|N
|This string is required if OBR:3.1 is not provided
|
|}
=== Example ===

== ORU R01: Unsolicited Observation (Radiology) ==

=== Overview ===

==== Interpretation of observations ====
DDS only interprets a radiology observation in one way - as a single textual report with multiple image attachments.

If an OBX segments contains an image (OBX:2.1 = "ED" and OBX:5.2 = "image") then the image will be extracted and added as an attachment to the textual report. The ordering of the OBX segments containing images is not meaningful to DDS.

An NTE segment or an OBX segment that does not hold an image is considered to contain a portion of the report. The ordering of these segments will be respected by DDS and it will concatenate them to form a single textual report.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX - Observation or result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:2 - Value Type
|OBX:2.1
|ID
|R
|N
|Radiology messages only support FT, TX or ED
|ED
|-
|OBX:3 - Observation Identifier
|OBX:3.2
|ST
|R
|N
|Needed to allow consumers to understand the type of radiology study that this observation represents
|X-ray pelvis
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "image" or "document"
|image
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED"
if OBX:5.2 = "image" then MUST be "TIFF"

else if OBX:5.2 = "document" then must be "pdf"
|TIFF
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded image or PDF document
|
|}

Publisher API HL7 Messages

2021-09-06T11:34:04Z

Will Weatherill: /* Definition */

__NOTOC__

This page summarises the messages that are currently supported by DDS

'''Acknowledgement'''

*[[Publisher API HL7 Messages#ACK: General acknowledgement|ACK]] - general acknowledgement

'''Records'''

*[[Publisher API HL7 Messages#ADT A28: Create patient record|ADT A28]] - create patient record
*[[Publisher API HL7 Messages#ADT A31: Update patient record|ADT A31]] - update patient record
*[[Publisher API HL7 Messages#ADT A34: Merge Patient Information - Patient ID Only|ADT A34]] - merge patient records

'''Encounters'''

*[[Publisher API HL7 Messages#ADT A05: Pre-admit a Patient|ADT A05]] - pre-admit a patient
*[[Publisher API HL7 Messages#ADT A38: Cancel a pre-admit|ADT A38]] - cancel a pre-admit
*[[Publisher API HL7 Messages#ADT A01: Admit Patient|ADT A01]] - admit a patient
*[[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11]] - cancel admit
*[[Publisher API HL7 Messages#ADT 02: Transfer a Patient|ADT A02]] - transfer a patient
*[[Publisher API HL7 Messages#ADT A12: Cancel transfer|ADT A12]] - cancel transfer
*[[Publisher API HL7 Messages#ADT A03: Discharge Patient|ADT A03]] - discharge a patient
*[[Publisher API HL7 Messages#ADT A13: Cancel discharge|ADT A13]] - cancel discharge
*[[Publisher API HL7 Messages#ADT A08: Update Patient Information|ADT A08]] - update patient information

'''Observations'''

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation|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.

== 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.
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#MSA - Message acknowledgement|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PD1 - Patient Additional Demographic|PD1 - Patient Additional Demographics]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
===Example===

== ADT A34: Merge Patient Information - Patient ID Only ==

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

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

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

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#MRG - Merge Patient Information|MRG - Merge Patient Information]]
|R
|N
|}
===Example===
== ADT A05: Pre-admit a Patient ==

=== Overview ===
Records an expected future admission of a patient.

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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 [[Publisher API HL7 Messages#ADT A11: Cancel admit|ADT A11: Cancel admit]]
== ADT A01: Admit Patient ==

=== Overview ===
This will create an Encounter for the specified patient

=== Definition ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV1:3 - Assigned Patient Location
|R
|If not known please provide "UNKNOWN" for PV1:6.9
|^^^^^^^^UNKNOWN
|-
|PV1:4 - Admission Type
|R
|
|
|-
|PV1:9 - Consulting Doctor
|R
|If not known please provide "UNKNOWN" for the family name
|^UNKNOWN^^^^^^^^^^^^^^
|-
|PV1:14 - Admit source
|R
|
|
|-
|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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!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
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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 -

# 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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|
|}
PV2 - Patient Visit - additional information

Refines the [[Publisher API HL7 Segments#PV2 - Patient Visit - Additional Information|DDS standard definition of PV2]] -
{| class="wikitable"
!Field
!Optionality
!Notes
!Example
|-
|PV2:3 - Admit reason
|X
|Ignored if supplied
|
|-
|PV2:4 - Transfer reason
|O
|Free text description of the reason for the transfer
|
|-
|PV2:8 - Expected Admit Date/Time
|X
|Ignored if supplied
|
|-
|PV2:9 - Expected Discharge Date/Time
|O
|Datetime of when discharge is expected
|202105270824
|}

===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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|-
|PV2 - Patient Visit - additional information
|O
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation/Results]]
|O
|N
|-
|[[Publisher API HL7 Segments#AL1 - Patient allergy information|AL1 - Patient allergy information]]
|O
|Y
|-
|[[Publisher API HL7 Segments#DG1 - Diagnosis|DG1 - Diagnosis]]
|O
|Y
|-
|[[Publisher API HL7 Segments#PR1 - Procedures|PR1 - Procedures]]
|O
|Y
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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
|R
|
|
|-
|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'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!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===

== ADT A08: Update Patient Information ==

=== '''Overview''' ===
An A08 message is used to update existing encounter information. Note that it is important to supply a value for PV1:19 (Visit number) in order to match the encounter to update.

[TODO] -

* confirm behaviour if A08 is sent an no encounter exists
* confirm what happens to the previous version of the updated data (is it retained and retrievable?)
* What are the rules around triggered an update, for example if a field is left blank in PV1 does that mean that the existing data in DDS will not be updated?
* is it only the PV1 segment that is used as a source data to update i.e. the PID segment is ignored?

=== '''Definition''' ===
'''Segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|PV1 - Patient Visit
|R
|N
|}
'''Fields'''

PV1 - Patient Visit

Refines the [[Publisher API HL7 Segments#PV1 - Patient Visit|DDS standard definition of PV1]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PV1:2 - Patient Class
|PV1:2.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0004-PatientClass|0004-PatientClass]]
|
|-
|PV1:3 - Assigned Patient Location
|PV1:3.1
|IS
|O
|N
|General patient location
|
|-
|PV1:4 - Admission Type
|PV1:4.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0007-AdmissionType|0007-AdmissionType]]
|
|-
|PV1:6 - Prior Patient Location
|PV1:6.9
|ST
|O
|N
|Free text description of the location
|
|-
| rowspan="5" |PV1:7 - Attending Doctor
| -
| -
|O
|N
|Attending doctor. If provided, at least the family name must be given.
|
|-
|PV1:7.2
|ST
|R
|N
|Family Name
|
|-
|PV1:7.3
|ST
|O
|N
|Given Name
|
|-
|PV1:7.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:7.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="5" |PV1:8 - Referring Doctor
| -
| -
|O
|N
|Referring doctor. If provided, at least the family name must be given.
|
|-
|PV1:8.2
|ST
|R
|N
|Family Name
|
|-
|PV1:8.3
|ST
|O
|N
|Given Name
|
|-
|PV1:8.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:8.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="6" |PV1:9 - Consulting Doctor
| -
| -
|O
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|-
|PV1:9.1
|ST
|R
|N
|ID number
|
|-
|PV1:9.2
|ST
|R
|N
|Family Name
|
|-
|PV1:9.3
|ST
|O
|N
|Given Name
|
|-
|PV1:9.4
|ST
|O
|N
|Middle Names
|
|-
|PV1:9.6
|ST
|O
|N
|Prefix
|
|-
|PV1:10 - Hospital Service
|PV1:10.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0069-HospitalService|0069-HospitalService]]
|
|-
|PV1:13 - Re-admission Indicator
|PV1:13.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0092-Re-AdmissionIndicator|0092-Re-AdmissionIndicator]]
|
|-
|PV1:14 - Admit source
|PV1:14.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#DDS-AdmissionSource|DDS-AdmissionSource]]
|
|-
|PV1:18 - Patient Type
|PV1:18.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#HL7v3-EncounterType|HL7v3-EncounterType]]
|
|-
|PV1:36 - Discharge Disposition
|PV1:36.1
|IS
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0112-DischargeDisposition|0112-DischargeDisposition]]
|
|-
|PV1:37 - Discharged to Location
|PV1:37.1
|ID
|O
|N
|Allowed values are from table [[Publisher API Code Sets#0113-DischargedToLocation|0113-DischargedToLocation]]
|
|-
|PV1:44 - Admit Date/Time
|PV1:44.1
|TS
|O
|N
|Admit timestamp
|
|-
|PV1:45 - Discharge Date/Time
|PV1:45.1
|TS
|O
|N
|Discharge timestamp
|}

== ORU R01: Unsolicited Observation ==

=== Overview ===
DDS supports two kinds of Observation -

*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Laboratory.29|Laboratory observation]]
*[[Publisher API HL7 Messages#ORU R01: Unsolicited Observation .28Radiology.29|Radiology Observation]]

DDS differentiates these by examining the value of MSH:3.1. For Radiology observations that value MUST be "RADIOLOGY". Any other value is interpreted as a Laboratory observation.

==== Schema ====

[[File:Schema.png]]

Note - In the diagram above the grey boxes are logical groupings of segments

=== Definition ===
'''segments'''
{| class="wikitable"
!Segment
!Optionality
!Repeating
|-
|[[Publisher API HL7 Segments#MSH - Message Header|MSH - Message Header]]
|R
|N
|-
|[[Publisher API HL7 Segments#EVN - Event Type|EVN - Event Type]]
|R
|N
|-
|[[Publisher API HL7 Segments#PID - Patient Identification|PID - Patient Identification]]
|R
|N
|-
|[[Publisher API HL7 Segments#PV1 - Patient Visit|PV1 - Patient Visit]]
|O
|N
|-
|[[Publisher API HL7 Segments#ORC - Common Order|ORC - Common Order]]
|O
|Y
|-
|[[Publisher API HL7 Segments#OBR - Observation Request|OBR - Observation Request]]
|C
|N
|-
|[[Publisher API HL7 Segments#OBX - Observation or result|OBX - Observation or result]]
|C
|Y
|-
|[[Publisher API HL7 Segments#NTE - Notes and Comments|NTE - Notes and Comments]]
|O
|Y
|}

== ORU R01: Unsolicited Observation (Laboratory) ==

=== Overview ===
This message is used to transmit unsolicited laboratory results into DDS. [TODO - how to differentiate path from rad results?]

==== Interpretation of observations ====
Depending upon the structure of the R01, DDS will interpret the message in one of three ways.

===== Single textual laboratory report =====
The following criteria are used to determine if an OBR contains a single textual laboratory report -

* There are one or more OBX segments which when combined hold at least two lines of text
* Each OBX segment has a textual data type (TX, FT or ST)
* Each OBX segment has the same test ID as the others (OBX:3)

The OBX segments are interpreted as lines of a report as are any NTE segments directly associated with the OBR.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

===== Collection of individual test results =====
If an OBR group does not meet the criteria for a single textual laboratory report then DDS assumes it to contain a collection of individual test results, each with it's own test code in OBX:3. DDS considers the comments for a given test result (OBX) to be the combination of the comments (NTE segments) associated directly with the OBR plus the comments (NTE segments) associated directly with the test result.

'''Embedded PDF result'''

If OBX.2.1 (Value Type) contains "ED" then it is expected that the OBX segments contains an embedded, Base64-encoded PDF document

===== NTE - Notes and Comments =====
DDS will interpret comments differently depending on where in the R01 message an NTE segment is found -

* NTE segments that immediately follow the OBR segment are considered by DDS to apply to all results in the R01 message
* NTE segments immediately following an OBX segment are considered by DDS to apply only to the immediately preceding result

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX%20-%20Observation%20or%20result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:3 - Observation Identifier
|OBX:3.3
|ST
|R
|N
|DDS will only accept a measurement if this value is "SNOMED-CT"
|<nowiki>26604007 | Complete blood count (procedure)</nowiki>
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "document"
|document
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "pdf"
|pdf
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded PDF document
|
|}
ORC - Common Order

Refines the [[Publisher API HL7 Segments#ORC - Common Order|DDS standard definition of ORC]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|ORC:3 - Filler Order number
|ORC:3.1
|ST
|C
|N
|This string is required if OBR:3.1 is not provided
|
|}
=== Example ===

== ORU R01: Unsolicited Observation (Radiology) ==

=== Overview ===

==== Interpretation of observations ====
DDS only interprets a radiology observation in one way - as a single textual report with multiple image attachments.

If an OBX segments contains an image (OBX:2.1 = "ED" and OBX:5.2 = "image") then the image will be extracted and added as an attachment to the textual report. The ordering of the OBX segments containing images is not meaningful to DDS.

An NTE segment or an OBX segment that does not hold an image is considered to contain a portion of the report. The ordering of these segments will be respected by DDS and it will concatenate them to form a single textual report.

It's worth noting that OBX:13 can be used to carry details of any delay that is to be applied before the patient should see the results. If there is a delay associated with the report then this should be included on the first OBX segment.

=== Definition ===
'''Fields'''

OBX - Observation

Refines the [[Publisher API HL7 Segments#OBX - Observation or result|DDS standard definition of OBX]] -
{| class="wikitable"
!Field
! Component
! Data Type
!Optionality
!Repeating
!Description
!Example
|-
|OBX:2 - Value Type
|OBX:2.1
|ID
|R
|N
|Radiology messages only support FT, TX or ED
|ED
|-
|OBX:3 - Observation Identifier
|OBX:3.2
|ST
|R
|N
|Needed to allow consumers to understand the type of radiology study that this observation represents
|X-ray pelvis
|-
| rowspan="6" |OBX:5 - Observation value
| -
|VARIES
|
|N
|The number of sub-fields varies depending upon the value of OBX:2.1
|
|-
|OBX:5.1
|ST
|R
|N
|If OBX:2.1 = "ED" then this must be the source application
Otherwise the raw observation value
|
|-
|OBX:5.2
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "image" or "document"
|image
|-
|OBX:5.3
|ID
|C
|N
|Required if OBX:2.1 = "ED"
if OBX:5.2 = "image" then MUST be "TIFF"

else if OBX:5.2 = "document" then must be "pdf"
|TIFF
|-
|OBX:5.4
|ID
|C
|N
|Required if OBX:2.1 = "ED" and MUST be "Base64"
|Base64
|-
|OBX:5.5
|ST
|C
|N
|Required if OBX:2.1 = "ED" and must be Base64 encoded image or PDF document
|
|}