HL7 v2+ Specification
0.0.0 - draft

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions

Logical Model: HL7 v2 XPN Data Type

Official URL: http://hl7.org/v2/StructureDefinition/XPN Version: 0.0.0
Standards status: Informative Computable Name: XPN

Note: Replaces PN data type as of v 2.3.

Internationalization Note: In countries using ideographic or syllabic (phonetic) character sets, it is sometimes necessary to send the name in one or both of these formats, as well as an alphabetic format. The switching between the different character sets can be accomplished using a character set such as JIS X 0202 - ISO 2022 which provides an escape sequence for switching among different character sets and among single-byte and multi-byte character representations. When the name field is repeated, the different repetitions of the name may be represented by these different character sets. The details are as follows. (See also Section 2.9.2, “Escape sequences supporting multiple character sets for PN, XPN, XCN, XON, XAD, FT, ST and TX data types.”)

HL7 supports the following standards for Japanese characters:

JIS X 0201 for ISO-IR 13 (Japanese Katakana)

JIS X 0201 for ISO-IR 14 (Japanese Romaji)

JIS X 0208 for ISO-IR 87 (Japanese Kanji, Hiragana and Katakana)

JIS X 0212 for ISO-IR 159 (supplementary Japanese Kanji)

HL7 supports the following standards for European characters:

ISO 8859 (1-9) for ISO-IR 100, 101, 109, 110, 144,127, 126, 138 and 148.

Character sets are referenced in HL7 as ASCII, 8859/1,8859/2, ISO IR14, ISO IR87, and ISO IR159. DICOM uses codes laid out in ISO 2375, of the form 'ISO-IR xxx'. HL7 supports this naming as well, to facilitate interoperability.

HL7 uses the Basic G0 Set of the International Reference Version of ISO 646:1990 (ISO IR-6) as the default character repertoire for character strings. This is a single-byte character set, identical to ASCII.

Each repetition of a XPN, XON, XCN, or XAD field is assumed to begin with the default character set. If another character set is to be used, the HL7 defined escape sequence used to announce that character set must be at the beginning of the repetition, and the HL7 defined escape sequence used to start the default character set must be at the end of the repetition. Note also that several character sets may be intermixed within a single repetition as long as the repetition ends with a return to the default character set.

An application must specify which character sets it supports in the field MSH-18 Character Sets and which character set handling scheme it supports in the field MSH-20 Alternate Character Set Handling Scheme. It is assumed that the sending and receiving applications are aware of how to map character set names (i.e., ISO-IR xxx) to escape sequences.

For example, in many Japanese messages there is a mix of Romaji (i.e., Roman characters), Katakana (phonetic representation of foreign words), Hiragana (phonetic representation of Japanese words) and Kanji (pictographs). Such a message would require 4 character sets be specified in the MSH.

References for Internationalization of Name

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

Reference Description
1. “Understanding Japanese Information Processing” by Ken Lunde, O’Reilly Press
2. NEMA PS3.5 - DICOM Part 5: Data Structure and Semantics
3. ANSI X3.4:1986 ASCII character set
4. ISO 646:1990 Information Processing - ISO 7-bit coded character set for information interchange
5. ISO/IEC 2022:1994 Information Technology - Character code structure and extension techniques
6. ISO 2375:1986 Data Processing - Procedure for the registration of escape sequences
7. ISO 6429:1990 Information Processing - Control functions for 7-bit and 8-bit coded character sets
8. ISO 8859 (1-9) Information Processing - 8-bit single-byte coded graphic character sets - parts 1-9
9. ENV 41 503:1990 Information systems interconnection - European graphic character repertoires and their coding
10. ENV 41 508:1990 Information systems interconnection - East European graphic character repertoires and their coding
11. JIS X 0201-1976 Code for Information Exchange
12. JIS X 0212-1990 Code of the supplementary Japanese Graphic Character set for information interchange
13. JIS X 0208-1990 Code for the Japanese Graphic Character set for information interchange
14. RFC 1468 Japanese Character Encoding for Internet Messages

Character Repertoires supported by DICOM are defined in Part 5, section 6.1. The DICOM Standard is available free on the Internet at http://medical.nema.org/[http://medical.nema.org/].

Examples of names requiring only one iteration of the field where the XPN is applied:

Example 1: Adam A. Everyman III PhD

Everyman^Adam^A^III^DR^^L^^^^^^^PHD

Example 2: Ludwig van Beethoven

Beethoven&van^Ludwig^^^^^L

Example 3: Hermann Egon Mayer zur alten Schildesche

Mayer^Hermann^Egon^zur alten Schildesche

Example 4: Sister Margot

^Margot^^^Sister^^C

Example 5: Dr Harold Henry Hippocrates AO. MBBS. ASCTS. A physician who holds an Honorarium, an academic degree and a board certificate. Professional suffixes are displayed as concatenated. (AO = Order of Australia (Honorarium), MBBS = Bachelor of Medicine and Bachelor of Surgery, ASCTS = Australian Society of Cardiothoracic Surgeons

Hippocrates^Harold^Henry^^^^L^^^^^^^AO.MBBS.ASCTS

Example 6: Nancy N. Nightingale, RN, PHN, BSN, MSN. A registered nurse who is a Public Health Nurse with 2 academic degrees, BSN and MSN.

Nightingale^Nancy^N^^^^^^^^^^^RN, PHN, BSN, MSN

Example 7: H.Horrace Helper Jr., RN, CNP. A registered nurse who is a certified nurse practitioner.

Helper^H^Horrace^Jr^^^^^^^^^^ RN, CNP

Example 8: Mevrouw Irma Jongeneel de Haas.

An individual whose birth name (geboortenaam) is de Haas and whose partner's name is Jongeneel.

Jongeneel-de Haas&de&Haas&&Jongeneel^Irma^^^Mevrouw^^L

Examples of names requiring more than one iteration of the field where the XPN is applied:

Example 9: Herr Prof. Dr. med. Joachim W. Dudeck

Dudeck^Joachim^W.^^Dr.med.^^L^^^^^^^ MD ~Dudeck^J.W.^^^Herr Prof.Dr.^^D

Example 10: Herr Dr. Otto Graf Lambsdorff mdB a.D.

According to German law “Adelstitel” like “Graf” or “Baron” belongs to the family name and therefore must be encoded in the family name field separated by blanks.

Graf Lambsdorff&Graf&Lambsdorff^Otto^^^Dr.^^L~Graf Lambsdorff&Graf&Lambsdorff^Otto^^mdB a.D.^Herr Dr.^^D

Example 11: Walter Kemper genannt (named) Mölleken

Kemper^Walter^^^^^L~Mölleken^Walter^^^^^A

Example 12: Herr Dr. med. Dr. h.c. Egon Maier

Maier^Egon^^^Dr.med. Dr.h.c.^^L^^^^^^^MD~Maier^Egon^^^Herr Dr.med. Dr.h.c^^D

Example 13: Herr Dipl.Ing. Egon Maier

Maier^Egon^^^^^L^^^^^^^ DIPL~Maier^Egon^^^Herr Dipl.Ing.^^D

Example 14: Frau Gerda Müller geb. Maier, verheiratet seit 16.2.2000

Müller^Gerda^^^Frau^^L^^^^^20000216~Maier^Gerda^^^Frau^^M

Example 15: President Adam A Everyman III, president from 1997 until 2001, aka Sonny Everyman

Everyman^Adam^A.^III^President^^L~^^^^Mr. President^^D^^^^^19970816^20010320~Everyman^Sonny^^^^^A

Example 16: Michio Kimura

This example doesn’t use title and degrees, but shows the repetition of this name for different purposes. The first iteration is the legal name in Kanji; the second, Katakana; the third, alphabetic.

image:extracted-media/media/image1.png[extracted-media/media/image1]

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444
NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XPN 0..* V2ComplexDataType extended person name
Instances of this logical model are not marked to be the target of a Reference
... 1 1..1 FN Family Name
... 2 0..1 string Given Name
... 3 0..1 string Second and Further Given Names or Initials Thereof
... 5 0..1 string Prefix
... 6 Degree
... 7 0..1 code Name Type Code
Binding: hl7VS-nameType (required)
... 8 0..1 code Name Representation Code
Binding: hl7VS-name-addressRepresentation (required)
... 9 0..1 CWE ​Name Context
Binding: http://terminology.hl7.org/ValueSet/v2-0448 (required)
... 10 Name Validity Range
... 11 0..1 code Name Assembly Order
Binding: hl7VS-nameAssemblyOrder (required)
... 12 0..1 dateTime Effective Date
... 13 0..1 dateTime Expiration Date
... 14 0..1 string Professional Suffix
... 15 0..1 string Called By

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XPN.7requiredHl7VSNameType
http://terminology.hl7.org/ValueSet/v2-0200
XPN.8requiredHl7VSNameAddressRepresentation
http://terminology.hl7.org/ValueSet/v2-0465
XPN.9required​http://terminology.hl7.org/ValueSet/v2-0448
http://terminology.hl7.org/ValueSet/v2-0448
XPN.11requiredHl7VSNameAssemblyOrder
http://terminology.hl7.org/ValueSet/v2-0444

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel