Publisher API HL7 Segments

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

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

AL1 - Patient allergy information

Overview

Each AL1 segment describes a single patient allergy.

Definition

Field	Component	Data Type	Optionality	Repeating	Description	Example
AL1:2 - Allergy type	AL1:2.1	IS	O	N	Allowed values are [TODO]
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 [TODO]
AL1:5 - Allergy reaction	AL1:5.1	ST	O	N
AL1:6 - Allergy identification date	AL1:6.1	DT	O	N