Publisher API HL7 Segments: Difference between revisions

From Discovery Data Service
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 228: Line 228:


=== Definition ===
=== Definition ===
{| class="wikitable"
!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
|
|-
| 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="5" |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
|
|}

Revision as of 13:01, 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.

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
Retrieved from ‘https://wiki.discoverydataservice.org/index.php?title=Publisher_API_HL7_Segments&oldid=4973’