Latest news and Publisher API HL7 Segments: Difference between pages

From Discovery Data Service
(Difference between pages)
Jump to navigation Jump to search
No edit summary
 
(Latest Version)
 
Line 1: Line 1:
This page provides the latest information for all Discovery Data Service releases and changes, plus known issues and updates from system suppliers and other third parties.
== 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]]


{{Tip| Add this page to your [[Creating_a_DDS_wiki_watchlist|watchlist]] to get email notifications to new changes to this page.}}
== Coded fields ==
Note that currently only a subset of the coded fields that are specified in the segments below are interpreted by DDS (see below). The remainder are left as-is once ingested in to DDS are are not processed further. In this latter case it is recommended that publishers take note of the suggested code sets as in the future it might be that these fields are interpreted by DDS and therefore a mapping exercise will need to be undertaken to map from publisher local codes to a core DDS code set.


* Primary Language - PID:15
* Religion - PID:17
* Ethnic Group - PID:22
* Admission Type -  PV1:4
* Hospital Service - PV1:10
* Admit Source - PV1:14
* Patient Type - PV1:18
* Discharge Disposition - PV1:36
* Discharged to Location - PV1:37


__TOC__
== MSA - Message acknowledgement ==


== Discovery Data Service ==
=== Overview ===
This section will be updated with known issues, and updates, to the DDS and changes relevant to subscribers of Discovery data.
The MSA segment contains information sent whilst acknowledging an inbound message. The following rules govern the nature of the acknowledgement -


=== Remote Subscriber Database changes ===
* If the message could not be saved to the DDS message store then an AR (failure occurred, retry) acknowledgement code is returned.
This table will be update with changes that are scheduled to be and have been made to the Remote Subscriber Databases.  
* 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.
{| class="sortable" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top;"
* If the message passes the above checks and is saved to the message store, an AA (success) acknowledgement code is returned.
|- style="background-color:#90A4AE; color: white; vertical-align: top;"  
* 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.
! scope="col" width="45%" |Summary
 
! scope="col" width="10%" |Type of Change
=== Definition ===
! scope="col" width="10%" |Release Date
{| class="wikitable"
! scope="col" width="35%" |Who is affected?
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|-
| style="text-align: left" |
|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)
|
|
| style="text-align: left" |
|}
|}
See also:


*[[Release Information]]
== MSH - Message Header ==


=== Discovery Data Service updates ===
=== Overview ===
All DDS infrastructure, application or performance related problems will be resolved by the discovery technical team, and where appropriate, information relating to work carried out will be reported.
The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message


See also:
=== 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. Values SHOULD be from table [[Publisher API Code Sets#DDS-HL7v2-MessageType|DDS-HL7v2-MessageType]]
|
|-
|MSH:9.2
|ID
|R
|N
|Trigger event. Values SHOULD be 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"
|
|}


*[[Release Information]]
== EVN - Event Type ==
<hr/>


== EMIS ==
=== Overview ===
This section will be updated with known issues, updates, and changes to EMIS systems.
The EVN segment is used to communicate trigger event information to receiving applications


=== COVID-19 vaccinations ===
=== Definition ===
'''How long does it take to get the COVID-19 vaccination notifications into the patient records in EMIS Web?'''
{| 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.
|
|}


EMIS have informed us that "data is collected by NHS Digital at 22:00 each day, comprising all vaccination data received in that last 24 hour period. NHS Digital send us this data the following day and we will perform a daily upload of these vaccination notifications during that afternoon."
== PID - Patient Identification ==


'''Updated: 21 January 2021'''
=== 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


<hr/>
=== 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) -


{| class="sortable" border="1" style="border-collapse:collapse; text-align: center;  vertical-align:top;"
* the patient's local (to the publisher) identifier. In this instance the assigning authority (PID:3.4) must be "MRN"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
*the patient's NHS number. In this instance the assigning authority (PID:3.4) must be "NHS"
! scope="col" width="10%" |Updated
|
! scope="col" width="10%" |Issue
|-
! scope="col" width="55%" |Summary
|PID:3.1
! scope="col" width="7%" |Ongoing
|ST
! scope="col" width="6%&quot;" |Sites affected
|R
! scope="col" width="6%&quot;" |Subscribers affected
|Y
! scope="col" width="6%&quot;" |STP
|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. If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then allowed values are from table [[Publisher API Code Sets#AdministrativeSex|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. Values SHOULD be 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"
|
|-
|-
|25 October 2021
| rowspan="2" |PID:15 - Primary language
|Daily deltas not received
|  -
| style="text-align: left" |Daily deltas for SSIS01 have not been received since 23/10/2021. This has been reported to EMIS for investigation.
|  -
|Ongoing
|O
|138 Organisations
|N
| Yes
|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.
| NEL
|
NWL
|-
|PID:15.1
|ST
|O
|N
|Primary language. If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source]<nowiki> then allowed values are child concepts of the SNOMED CT World Languages concept  - 297289008 | World languages (qualifier value) |</nowiki>
|
|-
|PID:17 - Religion
|PID:17.1
|IS
|O
|N
|Religion. If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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.


SEL
If no PV1 segment accompanies this PID segment then PID:18 should not be populated
|
|-
|PID:22 - Ethnic group
| -
| -
|O
|N
|
|
|-
|-
| 25 October 2021
|
|Daily deltas not received
|PID:22.1
| style="text-align: left" |Daily deltas for SSIS06 have not been received since 22/10/2021. This has been reported to EMIS for investigation.
|ST
|Ongoing
|O
|60 Organisations
|N
|Yes
|Ethnicity identifier. If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then allowed values are from [https://datadictionary.nhs.uk/data_elements/ethnic_category.html?hl=ethnicity ETHNIC CATEGORY]
|NEL
|
NWL
|-
|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 ==


SEL
=== 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
|
|-
|-
|25 October 2021
|PD1:4.6
| Disabled practice
|ST
| style="text-align: left" |Y02974, G85003, G85642, Y06345, G84019, Y00206, F86642, F86627, F82006, F82621, F86626, RWKGY, F86020, G84627, F86085, F82648, E84020, F86701, E84083, F86625, F84749, F86650, E86001, G83628, Y01795, F86030, G85083, E84008, Y01839, Y04273 are showing as disabled in the daily delta extract from 23/10/2021. This has stopped any data for these practice being received from EMIS. This has been raised with EMIS to investigate.
|O
|N
|Prefix
|
|}
== MRG - Merge Patient Information ==


'''Resolved''' - data received and processed 25/10/2021
=== Overview ===
|Resolved
The MRG segment is used by DDS to support merging of patient identifiers
|55 Organisations
|Yes
|NEL
NWL


SEL
=== 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
|
|-
|-
|22 October 2021
|MRG:4 - Prior Patient ID
|Disabled practice
|
| style="text-align: left" |Y00206 is showing as disabled in the daily delta extract from 21/10/2021. This has stopped any data for this practice being received from EMIS. This has been raised with EMIS to investigate.
| -
'''Resolved''' - data received and processed 25/10/2021
|X
|Resolved
|N
|1 Organisation
|Ignored if supplied
|Yes
|
| NWL
|-
|MRG:5 - Prior Visit Number
|
|CX
|X
|N
|Ignored if supplied
|
|-
|MRG:6 - Prior Alternate Visit ID
|
|CX
|X
|N
|Ignored if supplied
|
|-
|-
|22 October 2021
|MRG:7 - Prior Patient Name
|Daily deltas not received
| -
| style="text-align: left" |Daily deltas for SSIS01, and SSIS03 have not been received since 21/10/2021. This has been reported to EMIS.
| XPN
'''Resolved''' - data received and processed 23/10/2021
|X
|Resolved
|N
|250 Organisations
|Ignored if supplied
|Yes
|
|NEL
|}<br />
NWL


SEL
== PV1 - Patient Visit ==
|-
|18 October 2021
|Daily deltas not received
| style="text-align: left" |Daily deltas for SSIS01 have not been received since 15/10/2021. This has been reported to EMIS for investigation.
'''Resolved''' - data received and processed 19/10/2021


'''Note''' - due to this extract containing three days worth of data for each organisation, the extract is larger then usual and will take longer to process.  
=== Overview ===
|Resolved
The PV1 segment is used by Registration/Patient Administration applications to communicate information on a visit-specific basis.
|138 Organisations
|Yes
| NEL
NWL


SEL
=== Definition ===
{| class="wikitable"
!Field
!Component
!Data Type
!Optionality
!Repeating
!Description
!Example
|-
|PV1:2 - Patient Class
|PV1:2.1
|ID
|R
|N
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then allowed values are from table [[Publisher API Code Sets#PatientClass|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
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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.
|
|-
|-
|18 October 2021
|PV1:8.1
|Disabled practice
|ST
| style="text-align: left" |F82031, and G83029 are showing as disabled in the daily delta extract from 14/10/2021. This has stopped any data for these practice being received from EMIS. This has been raised with EMIS to investigate.
|O
'''Resolved''' - data received and processed 19/10/2021
|N
|Resolved
|ID number
| 2 Organisations
|
|Yes
|NEL
SEL
|-
|-
|18 October 2021
|PV1:8.2
|Disabled practice
|ST
| style="text-align: left" |F82634, and F82028 are showing as disabled in the daily delta extract from 14/10/2021. This has stopped any data for these practice being received from EMIS. This has been raised with EMIS to investigate.
|O
'''Resolved''' - data received and processed 18/10/2021
|N
|Resolved
|Family Name
|2 Organisations
|
| Yes
| NEL
|-
|-
|14 October 2021
|PV1:8.3
|Daily deltas not received
|ST
| style="text-align: left" |Daily deltas for SSIS06, and SSIS06_2 have not been received since 12/10/2021. This has been reported to EMIS for investigation.
|O
'''Resolved''' - data received and processed 17/10/2021
|N
| Resolved
|Given Name
|60 Organisations
|
|Yes
|-
|NEL
|PV1:8.6
NWL
|ST
 
|O
SEL
|N
|Prefix
|
|-
| rowspan="5" |PV1:9 - Consulting Doctor
| -
| -
|R
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|-
|-
|12 October 2021
|PV1:9.1
| Daily deltas not received
|ST
| style="text-align: left" |Daily deltas for SSIS03, SSIS04, and SSIS04_2 have not been received since 10/10/2021. This has been reported to EMIS for investigation.
|R
'''Resolved''' - data received and processed 12/10/2021
|N
|Resolved
|ID number
|236 Organisations
|
|Yes
|NEL
NWL
 
SEL
|-
|-
|11 October 2021
|PV1:9.2
| Daily deltas not received
|ST
| style="text-align: left" |Daily deltas for SSIS02 have not been received since 08/10/2021. This has been reported to EMIS for investigation.
|R
'''Resolved''' - data received and processed 11/10/2021
|N
|Resolved
|Family Name
| 116 Organisations
|
| Yes
|NEL
NWL
 
SEL
|-
|-
| 11 October 2021
|PV1:9.3
|Disabled practice
|ST
| style="text-align: left" |F84008, E86015, E84075, E86625, and G85727 are showing as disabled in the daily delta extract from 07/10/2021. This has stopped any data for these practice being received from EMIS. This has been raised with EMIS to investigate.
|O
'''Resolved''' - data received and processed 11/10/2021
|N
|Resolved
|Given Name
|5 Organisations
|
|Yes
| NEL
NWL
 
SEL
|-
|-
|11 October 2021
|PV1:9.6
|Disabled practice
|ST
| style="text-align: left" |G84003, E86640, and E84693 are showing as disabled in the daily delta extract from 01/10/2021. This has stopped any data for these practice being received from EMIS. This has been raised with EMIS to investigate.
|O
'''Resolved''' - data received and processed 11/10/2021
|N
| Resolved
|Prefix
| 3 Organisations
|
|Yes
|NEL
NWL
 
SEL
|-
|-
|17 September 2021
|PV1:10 - Hospital Service
|Registration data not received
|PV1:10.1
| style="text-align: left" |The custom registration data file from EMIS has not been received since 14/07/2021. This has been escalated to EMIS.
|IS
|Ongoing
|R
|All
|N
|Yes
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then allowed values are from [https://datadictionary.nhs.uk/attributes/treatment_function_code.html TREATMENT FUNCTION CODE]
|NEL
|
NWL
 
SEL
|-
|-
|13 May 2020
|PV1:14 - Admit source
|Registration data status
|PV1:14.1
| style="text-align: left" |The daily GP IT IM1 EMIS extract does not include registration status data, which is key in working out a list of registered patients at an EMIS Web GP practice. The daily extract includes the registration date and registration type (e.g. Regular/GMS) but, without the registration status, it’s not possible to match registered patient counts between EMIS Web and DDS because EMIS Web factors the current registration status into its calculation of registered patients. Similarly, the regular extract doesn’t include the 'original term' recorded against each record in the CareRecord_Observation file. EMIS Web allows a free-text term to be recorded against any observation, effectively overwriting the term from the clinical code selected. Without this free-text term, a number of observations are apparently meaningless when viewing a patient record.
|IS
|Ongoing
|O
|N
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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
|If [https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Messages#Coded_field_mapping mapping at source] then 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
|
|}
|}
See also:


*[[Latest news archive#EMIS|Archived EMIS items]]
== NTE - Notes and Comments ==
*[[Publisher feed status#EMIS|Latest publisher feed status]]
 
=== Overview ===
The NTE segment is used to hold comments [TODO - are there any constraints on the size of an individual comment]


==TPP==
=== Definition ===
This section will be updated with known issues, updates, and changes to TPP systems.<br />
{| class="wikitable"
{| class="sortable" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top;"
!Field
|- style="background-color:#90A4AE; color: white; vertical-align: top;"  
!Component
! scope="col" width="10%" |Updated
!Data Type
! scope="col" width="10%" |Issue
!Optionality
! scope="col" width="55%" |Summary
!Repeating
! scope="col" width="7%" |Status
!Description
! scope="col" width="6%&quot;" |Sites affected
!Example
! scope="col" width="6%&quot;" |Subscribers affected
! scope="col" width="6%&quot;" | STP
|-
|-
|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
|
|
| style="text-align: left" |
|-
| 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. Values SHOULD be from table [[Publisher API Code Sets#0074-DiagnosticServiceSectionID|0074-DiagnosticServiceSectionID]]
|
|
|}
|}
See also:


*[[Latest news archive#TPP|Archived TPP items]]
== OBR - Observation Request ==
*[[Publisher feed status#TPP|Latest publisher feed status]]


==Vision==
=== Overview ===
This section will be updated with known issues, updates, and changes to Vision systems.<br />
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="sortable" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top;"
{| class="wikitable"
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
!Field
! scope="col" width="10%" |Updated
!Component
! scope="col" width="10%" |Issue
!Data Type
! scope="col" width="55%" |Summary
!Optionality
! scope="col" width="7%" |Status
!Repeating
! scope="col" width="6%&quot;" |Sites affected
!Description
! scope="col" width="6%&quot;" | Subscribers affected
!Example
! scope="col" width="6%&quot;" | STP
|-
|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
|
|
| style="text-align: left" |
|-
|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. Values SHOULD be 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. Values SHOULD be from table [[Publisher API Code Sets#DDS-ResultStatus|DDS-ResultStatus]]
|
|
|- valign="top"
|}
|}
See also:


*[[Latest news archive#Vision|Archived Vision items]]
=== Definition ===
*[[Publisher feed status#Vision|Latest publisher feed status]]
 
== 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.


==Adastra==
=== Definition ===
This section will be updated with known issues, updates, and changes to Adastra systems.<br />
{| class="wikitable"
{| class="sortable" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top;"
!Field
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
!Component
! scope="col" width="10%" | Updated
!Data Type
! scope="col" width="10%" |Issue
!Optionality
! scope="col" width="55%" | Summary
!Repeating
! scope="col" width="7%" |Status
!Description
! scope="col" width="6%&quot;" |Sites affected
!Example
! scope="col" width="6%&quot;" |Subscribers affected
|-
! scope="col" width="6%&quot;" |STP
|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
|Values SHOULD be 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. At the time of writing the acceptable code systems are still being defined though there is an aspiration to adopt the [https://digital.nhs.uk/about-nhs-digital/our-work/nhs-digital-data-and-technology-standards/clinical-information-standards#unified-test-list National Unified Test List] where appropriate. Note that this does not exclude the adoption of more appropriate code systems depending upon the nature of the observation
|
|-
|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
|
|-
|-
|11 June 2021
|OBX:6.2
|Missing Data File
|ST
| style="text-align: left" |In the daily extract received 10/06/21, a file is missing for 8HD62. This delta and any subsequent delta can not be processed until this file is received. This has been raised with Advanced.
|O
|Ongoing
|N
|1 Organisation
|Unit Name
|No
|
|NEL
|-
|-
|22 February 2021
|OBX:6.3
|Data not received
|ST
| style="text-align: left" |Data hasn't been received for 8HD62, RRU, Y02147 or Y04645 . This has been raised with Advanced.
|R
|Ongoing
|N
|4 Organisations
|Unit coding system
|Yes
|
|SEL
|-
|- valign="top"
|OBX:7
|}
|OBX:7.1
See also:
|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<br />


*[[Latest news archive#Adastra|Archived Adastra items]]
* [low value]"-"[high value]  
 
* "<"[Number] (i.e. "less than number")
==HL7==
* ">"[Number] (i.e. "greater than number")
This section will be updated with known issues, updates, and changes to the HL7 feeds and the publishing organisations.<br />
* "<="[Number] (i.e. "less than or equal to number")
{| class="sortable" border="1" style="border-collapse:collapse; text-align: center; vertical-align:top;"
* ">="[Number] (i.e. "greater than or equal to number")
|- style="background-color:#90A4AE; color: white; vertical-align: top;"
* [Alphabetic value indicating normal value]
! scope="col" width="10%" |Updated
|See table below for examples
! scope="col" width="10%" |Issue
|-
! scope="col" width="55%" |Summary
| rowspan="4" |OBX:8 - Abnormal flag
! scope="col" width="7%" |Status
| -
! scope="col" width="6%&quot;" |Sites affected
| -
! scope="col" width="6%&quot;" |Subscribers affected
|C
! scope="col" width="6%&quot;" |STP
|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 - Values SHOULD be from table <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 SHOULD 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. Values SHOULD be 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
|
|
|
|
| style="text-align: left" |
|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
|
|
|- valign="top"
|-
|OBX:16.6
|ST
|O
|N
|Prefix
|}
|}
See also:
 
=== 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"
|}<br />

Revision as of 13:34, 10 January 2022

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 HL7 API messages page

Coded fields

Note that currently only a subset of the coded fields that are specified in the segments below are interpreted by DDS (see below). The remainder are left as-is once ingested in to DDS are are not processed further. In this latter case it is recommended that publishers take note of the suggested code sets as in the future it might be that these fields are interpreted by DDS and therefore a mapping exercise will need to be undertaken to map from publisher local codes to a core DDS code set.

  • Primary Language - PID:15
  • Religion - PID:17
  • Ethnic Group - PID:22
  • Admission Type -  PV1:4
  • Hospital Service - PV1:10
  • Admit Source - PV1:14
  • Patient Type - PV1:18
  • Discharge Disposition - PV1:36
  • Discharged to Location - PV1:37

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

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 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

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
MSH:9 - Message type - - R N
MSH:9.1 ID R N Message type. Values SHOULD be from table DDS-HL7v2-MessageType
MSH:9.2 ID R N Trigger event. Values SHOULD be from table 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

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 0062-EventReason
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

Field Component Data Type Optionality Repeating Description Example
PID:2 - Patient ID - - X N Not used. Instead please populate PID.3 Patient Identifier List
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
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. If mapping at source then allowed values are from table AdministrativeSex
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. Values SHOULD be from table 0399-CountryCode
PID:11.7 ID O N Address usage eg temporary address
PID:11.9 IS O N County
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"
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"
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. If mapping at source then allowed values are child concepts of the SNOMED CT World Languages concept - 297289008 | World languages (qualifier value) |
PID:17 - Religion PID:17.1 IS O N Religion. If mapping at source then allowed values are from 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. If mapping at source then allowed values are from 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

Field Component Data Type Optionality Repeating Description Example
PD1:3 - Patient Primary Facility - - R N
PD1:3.1 ST R N name
PD1:3.3 ST R N ODS code
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

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

Field Component Data Type Optionality Repeating Description Example
PV1:2 - Patient Class PV1:2.1 ID R N If mapping at source then allowed values are from table 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 If mapping at source then allowed values are from ADMISSION METHOD
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
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 If mapping at source then allowed values are from TREATMENT FUNCTION CODE
PV1:14 - Admit source PV1:14.1 IS O N If mapping at source then allowed values are from SOURCE OF ADMISSION
PV1:18 - Patient Type PV1:18.1 IS R N If mapping at source then allowed values are from table 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 If mapping at source then allowed values are from DISCHARGE METHOD
PV1:37 - Discharged to Location PV1:37.1 ID O N If mapping at source then allowed values are from 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

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

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
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. Values SHOULD be from table 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 ORU R01 - Unsolicited Observation definition.

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

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.
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. Values SHOULD be from table 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. Values SHOULD be from table 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

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 Values SHOULD be from table 0125-ValueType
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. At the time of writing the acceptable code systems are still being defined though there is an aspiration to adopt the National Unified Test List where appropriate. Note that this does not exclude the adoption of more appropriate code systems depending upon the nature of the observation
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
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
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 - Values SHOULD be from table http://terminology.hl7.org/ValueSet/v3-ObservationInterpretation
OBX:8.2 O Flag name
OBX:8.3 O N Flag coding system - If present then SHOULD be "http://terminology.hl7.org/ValueSet/v3-ObservationInterpretation"
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. Values SHOULD be from table 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.
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

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"


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