Publisher API HL7 Segments: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
No edit summary
Line 227: Line 227:
The PV2 segment is a continuation of visit-specific information contained on the PV1 segment.
The PV2 segment is a continuation of visit-specific information contained on the PV1 segment.


=== Definition ===
{| class="wikitable"
{| class="wikitable"
!Field
!Field
Line 237: Line 236:
!Example
!Example
|-
|-
|PV1:2 - Patient Class
|OBX:2 - Value Type
|PV1:2.1
|OBX:2.1
|ID
|ID
|O
|O
Line 245: Line 244:
|
|
|-
|-
|PV1:3 - Assigned Patient Location
| rowspan="4" |OBX:3 - Observation Identifier
|PV1:3.9
|ST
|O
|N
|Free text description of the location
|
|-
|PV1:4 - Admission Type
|PV1:4.1
|ID
|O
|N
|Allowed values are [TODO]
|
|-
|PV1:6 - Prior Patient Location
|PV1:6.9
|ST
|O
|N
|Free text description of the location
|
|-
| rowspan="5" |PV1:7 - Attending Doctor
| -
| -
| -
| -
|O
|R
|N
|Y
|Attending doctor. If provided, at least the family name must be given.
|
|
|
|-
|-
|PV1:7.2
|OBX:3.1
|ST
|ST
|R
|R
|N
|N
|Family Name
|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.
|
|
|-
|-
|PV1:7.3
|OBX:3.2
|ST
|ST
|O
|O
|N
|N
|Given Name
|Test Name
|
|
|-
|-
|PV1:7.4
|OBX:3.3
|ST
|ST
|O
|R
|N
|Middle Names
|
|-
|PV1:7.6
|ST
|O
|N
|N
|Prefix
|Test coding system. If this is a textual report, this value will be overridden by OBR:4.3. Note: DDS will only accept a measurement if this value is "SNOMED-CT"
|
|
|-
|-
| rowspan="5" |PV1:8 - Referring Doctor
| rowspan="3" |OBX:5 - Observation Value
| -
| -
| -
| -
|O
|R
|N
|N
|Referring doctor. If provided, at least the family name must be given.
|Test result value. If providing an SN value: OBX-5.1 must be one of: >, <, >=, <=, =. OBX-5.2 must be a number
|
|
|-
|-
|PV1:8.2
|OBX:5.1
|ST
|VARIES
|R
|R
|N
|N
|Family Name
|Value or comparator
|
|
|-
|-
|PV1:8.3
|OBX:5.2
|ST
|VARIES
|O
|C
|N
|N
|Given Name
|Value. Required if providing SN
|
|
|-
|-
|PV1:8.4
| rowspan="4" |OBX:6 - Observation Units
|ST
|O
|N
|Middle Names
|
|-
|PV1:8.6
|ST
|O
|N
|Prefix
|
|-
| rowspan="5" |PV1:9 - Consulting Doctor
| -
| -
| -
| -
|O
|O
|N
|N
|Consulting doctor. If provided, at least the family name must be given.
|
|
|
|-
|-
|PV1:9.2
|OBX:6.1
|ST
|ST
|R
|R
|N
|N
|Family Name
|Unit ID.
|
|
|-
|-
|PV1:9.3
|OBX:6.2
|ST
|ST
|O
|O
|N
|N
|Given Name
|Unit Name
|
|
|-
|-
|PV1:9.4
|OBX:6.3
|ST
|ST
|O
|R
|N
|N
|Middle Names
|Unit coding system
|
|
|-
|-
|PV1:9.6
|OBX:7
|ST
|ST
|O
|O
|N
|N
|Prefix
|Reference range
|
|
|-
|PV1:10 - Hospital Service
|PV1:10.1
|IS
|O
|N
|Allowed values are [TODO]
|
|
|-
|-
|PV1:13 - Re-admission Indicator
|OBX:11
|PV1:13.1
|ST
|IS
|O
|O
|N
|N
|Allowed values are [TODO]
|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.
|
|
|-
|-
|PV1:18 - Patient Type
|OBX:13
|PV1:18.1
|ST
|IS
|O
|O
|N
|N
|Allowed values are [TODO]
|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}
|-
|-
|PV1:19 - Visit Number
|OBX:14
|PV1:19.1
|ST
|CX
|C
|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 [TODO]
|
|-
|PV1:37 - Discharged to Location
|PV1:37.1
|ID
|O
|N
|Allowed values are [TODO]
|
|-
|PV1:44 - Admit Date/Time
|PV1:44.1
|TS
|O
|N
|Admit timestamp
|
|-
|PV1:45 - Discharge Date/Time
|PV1:45.1
|TS
|O
|N
|N
|Discharge timestamp
|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.
|
|
|}
|}

Revision as of 14:38, 21 May 2021

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

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 O N Allowed values are [TODO]
PV1:3 - Assigned Patient Location PV1:3.9 ST O N Free text description of the location
PV1:4 - Admission Type PV1:4.1 ID O N Allowed values are [TODO]
PV1:6 - Prior Patient Location PV1:6.9 ST O N Free text description of the location
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
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
PV1:9 - Consulting Doctor - - O N Consulting doctor. If provided, at least the family name must be given.
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 [TODO]
PV1:13 - Re-admission Indicator PV1:13.1 IS O N Allowed values are [TODO]
PV1:18 - Patient Type PV1:18.1 IS O N Allowed values are [TODO]
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 [TODO]
PV1:37 - Discharged to Location PV1:37.1 ID O N Allowed values are [TODO]
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

PV2 - Patient visit - additional information

Overview

The PV2 segment is a continuation of visit-specific information contained on the PV1 segment.

Field Component Data Type Optionality Repeating Description Example
OBX:2 - Value Type OBX:2.1 ID O N Allowed values are [TODO]
OBX:3 - Observation Identifier - - R Y
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 R N Test coding system. If this is a textual report, this value will be overridden by OBR:4.3. Note: DDS will only accept a measurement if this value is "SNOMED-CT"
OBX:5 - Observation Value - - R N Test result value. If providing an SN value: OBX-5.1 must be one of: >, <, >=, <=, =. OBX-5.2 must be a number
OBX:5.1 VARIES R N Value or comparator
OBX:5.2 VARIES C N Value. Required if providing SN
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 ST O N Reference range
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.
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.
Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Segments&oldid=4974’