DRAFT Working draft of an upcoming version. Not the published standard. View the current published version
Skip to content

5.1 Value Sets Used in this Implementation Guide ​

VS IDValue Set NameValue Set Expansion Location (or an enumerated coded concept to be used if a Value Set Expansion is not defined elsewhere)
AAdministrative Sex

As an example, if needed, below is a mapping between V2 Administrative Sex value set and V3 Administrative Gender Value Set.

Administrative SexAdministrative Gender
FF
MM
AUN
NNA
OOTH
UUNK

http://terminology.hl7.org/2.1.0/ValueSet-v2-0001.html

BDiagnosis Type (0052)http://terminology.hl7.org/2.1.0/ValueSet-v2-0052.html
CNot needed
DNotification Note TypesTable in Section 5.1.1
EHealthcare Facility Type Codehttp://hl7.org/fhir/R4/valueset-c80-facilitycodes.html
FlanguageCodeCoded identifiers as described by the IETF (Internet Engineering Task Force) RFC 3066, conformant with IHE requirements
GPractice Settinghttp://hl7.org/fhir/R4/valueset-c80-practice-codes.html
HEvent Types

A01 Admit/visit notification

A02 Transfer a patient

A03 Discharge/end visit

A04 Register a patient

A06 Change an outpatient to an Inpatient

A09 Emergency department Departure notification

A10 Emergency department Arrival notification

Note this IG does not restrict Notification Initiators from distributing additional event types to support specific use cases that need more event types. Definitions of filtering mechanisms by any actor are out of scope.

IProvider Role (0443)For Recipient, specifically expect to see one of PP or FHCP. For Treating Facility, specifically expect to see TF (note this is an extension to the Provider Role value set) https://terminology.hl7.org/2.1.0/ValueSet-v2-0443.html
JPatient Class (0004) with extensions defined here to add codes for Observation and Short Stay

All codes in Patient Class value set with these additions:

V Observation Table in Section 5.1.2

S Short Stay

http://terminology.hl7.org/2.1.0/ValueSet-v2-0004.html

KCoding Systems (0396)

This Standard restricts the possible coding systems I10 ICD-10

SCT SNOMED-CT

http://terminology.hl7.org/2.1.0/ValueSet-v2-0396.html

LAdmission Type (0007)

http://terminology.hl7.org/2.1.0/ValueSet-v2-0007.html

![Woman with stroller](/images/05-value-sets-and-examples/5-1-value-sets-used-in-this-implementation-guide-1.svg)Note: For Newborn birth in healthcare facility use code N.

MDischarge Disposition (0112)The code values to be used in PV1-36 should be from the NUBC UB-04 Patient Discharge Status codes used in Form Locator 17.
NNot needed
ONot needed
P

Health Insurance Type

2.16.840.1.113883.3.88.12.3221.5.2

This is a X12 value set and is not available through the VSAC.
QTelecom Use Code (0201)

Use DSM for Direct Secure Messaging addresses

https://terminology.hl7.org/ValueSet-v2-0201.html

LOINC Codes for Use in Context and XDM Metadata ​

CodeDisplayDefinition
86530-3Visit notificationVisit notification - the most general code
86532-9Admission notificationAdmission notification
86531-1Discharge notificationDischarge notification
79429-7Hospital Admission notificationAdmission notification
79430-5Hospital Discharge notificationDischarge notification
80110-0Emergency department Visit notificationVisit notification - most general for ED notifications
98141-5Emergency department Admission notificationED notification of the admission event
98142-3Emergency department Discharge notificationED notification of the discharge event
98143-1Emergency department Arrival notificationED notification of the arrival even - happens before being admitted
98144-9Emergency department Departure notificationED notification of the departure event
98145-6Outpatient Visit notificationOutpatient Visit notification

General Guidance:

In XDM metadata Document Entries include two fields that help systems process the included content: classCode (26) and typeCode (38). The classCode uses very prescriptive LOINC codes that help systems broadly identify what kind of information is included. The typeCode offers more specific information, if it is available, to support more refined workflows. When populating classCodes, initiating systems sharing ADT event notifications conformant to this specification must use very specific LOINC codes:

When populating typeCode for the V2 message content, initiating systems should use the most specific LOINC code they are able to apply. If no appropriate code is available for a combination of ADT event type and Patient Class, the initiating system uses the most specific code that would apply. For example, for a notification of admission to a Skilled Nursing facility, use 86532-9 (Admission Notification).

The Submission Set contentTypeCode (17) uses the same LOINC code as the Document Entry typeCode (38) for the V2 message.

Examples utilizing LOINC Codes in XDM Metadata ​

Note: Using LOINC codes in Document Entries to indicate the classCode (26) of the document.

In the Document Entry for the file that holds the human readable content (Document 1 in this example) the classCode uses LOINC Code 56444-3 to indicate this content is the human readable healthcare communication. By convention established for the IHE XDM transaction, this code is used to identify the inclusion of a document that holds the human readable content.

Graphical user interface, text, application, email Description automatically generated

In the Document Entry for the file that holds the HL7 V2 message content (Document 2 in this example) the classCode uses LOINC Code 86530-3 to indicate this content is the machine processable ADT notification message.

Graphical user interface, text, application, email Description automatically generated

DocumentEntry.typeCode (38)

(See Reference, IHE Guide 4.2.3.2.25)

Description: The code specifies the precise type of document from the user’s perspective. It is recommended that the creating entity draw these values from a coding scheme providing a fine level of granularity such as LOINC.

Coding: Coded as an ebRIM classification. (See reference, IHE Guide 4.2.3.1.2 for a description on creating classifications). Shall have zero or one value.

The following example specifies typeCod”=”ExampletypeCo”e” with display nam“ “typeCodeDisplayNam“ “ and coding schem“ “ Example Type Code Schem“ “ for the DocumentEntry labele“ “ExampleDocume”t”.

Graphical user interface, text, application, email Description automatically generated

Document Entry: typeCode (38)

The Document Entry typeCode carries a more specific classification of the type of event to facilitate more granular workflow management.

Graphical user interface, application Description automatically generated

Submission Set: contentTypeCode (17)

Supports carrying a more specific classification of the type of event to facilitate more granular workflow management. This should be identical to the document entry typeCode of the document entry for the V2 message.

Graphical user interface, text, application, email Description automatically generated

Patient Class Table 0004 with Extensions ​

(Value Set J)

CodeDisplayDefinitionActEncounterCode
EEmergencyEmergencyEMER
IInpatientInpatient

IMP

ACUTE

NONAC

OOutpatientOutpatientAMB
PPreadmitPreadmitPRENC
RRecurring patientRecurring patient
BObstetricsObstetrics
CCommercial AccountCommercial Account
NNot ApplicableNot Applicable
UUnknownUnknown
S ‖Short StayShort StaySS
V ‖ObservationObservationOBSENC

‖ Extensions

¶ Cross reference to HL7 V3 ActEncounterCode

Provider Role Table 0443 with Extensions ​

(Value Set I)

CodeDisplayComment
ADAdmittingPV1-17 Admitting doctor
ATAttendingPV1-7 Attending doctor
CPConsulting Provider
FHCPFamily Health Care Professional
PPPrimary Care Provider
RPReferring ProviderPV1-8 Referring doctor
RTReferred to Provider
TF ‖Treating Facility

‖ Extensions