| Seq# | Description | Implement | Flags | Cardinality | Length | C.LEN | Vocabulary | Data Type |
|---|---|---|---|---|---|---|---|---|
XPN
|
||||||||
1
|
Family Name | SHALL | RE | [0..1] | FN | |||
|
2
|
Given Name | # | [0..1] | 30 | ST | |||
|
3
|
Second and Further Given Names or Initials Thereof | # | [0..1] | 30 | ST | |||
|
4
|
Suffix | # | [0..1] | 20 | ST | |||
|
5
|
Prefix | # | [0..1] | 20 | ST | |||
|
6
|
Degree | [0..1] | ||||||
|
7
|
Name Type Code | SHALL | [0..1] | [1..5] | 0200 | ID | ||
|
8
|
Name Representation Code | SHALL | [0..1] | [1..1] | 0465 | ID | ||
|
9
|
Name Context | [0..1] | 0448 | CWE | ||||
|
10
|
Name Validity Range | [0..1] | ||||||
|
11
|
Name Assembly Order | SHALL | [0..1] | [1..1] | 0444 | ID | ||
|
12
|
Effective Date | [0..1] | DTM | |||||
|
13
|
Expiration Date | [0..1] | DTM | |||||
|
14
|
Professional Suffix | # | [0..1] | 199 | ST | |||
15
|
Called By | # | [0..1] | 30 | ST | |||
Components: <Family Name (FN)> & <Given Name (ST)> & <Second and Further Given Names or Initials Thereof (ST)> & <Suffix (ST)> & <Prefix (ST)> & <WITHDRAWN Degree> & <Name Type Code (ID)> & <Name Representation Code (ID)> & <Name Context (CWE)> & <WITHDRAWN Name Validity Range> & <Name Assembly Order (ID)> & <Effective Date (DTM)> & <Expiration Date (DTM)> & <Professional Suffix (ST)> & <Called By (ST)>
Subcomponents for Family Name (FN): <Surname (ST)> ^ <Own Surname Prefix (ST)> ^ <Own Surname (ST)> ^ <Surname Prefix from Partner/Spouse (ST)> ^ <Surname from Partner/Spouse (ST)>
Subcomponents for Name Context (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>
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
|
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/.
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.
Definition: This component allows full specification of the surname of a person. Where appropriate, it differentiates the person's own surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name. It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root. See section 2.A.30, "FN - family name".
XPN.1 will be empty when XPN.7 is MSK. It MAY be empty when XPN.7 is NAV.
Usage Note: If a person’s name has only one component, that name will be sent in XPN.1 Family Name. This is common practice in some countries such as Indonesia. This note does not cover the case where only one part of a person's multi-part name is known (e.g., only know "John" of "John Doe").
Definition: First name.
Definition: Multiple middle names may be included by separating them with spaces.
Definition: Used to specify a name suffix (e.g., Jr. or III).
Definition: Used to specify a name prefix (e.g., Dr.).
Attention: The XPN-6 component was deprecated as of v2.5 and the detail was withdrawn and removed from the standard as of v 2.7. See XPN.14 Professional Suffix.
Definition: A code that represents the type of name. Refer to HL7 Table 0200 - Name Type for valid values.
Note: The content of Legal Name is country specific. In the US the legal name is the same as the current married name.
Definition: Different <name/address types> and representations of the same <name/address> should be described by repeating of this field, with different values of the <name/address type> and/or <name/address representation> component.
Note: This new component remains in "alphabetic" representation with each repetition of the field using these data types, i.e., even though the name may be represented in an ideographic character set, this component will remain represented in an alphabetic character set.
Refer to HL7 Table 0465 – Name/address Representation for valid values.
In general this component provides an indication of the representation provided by the data item. It does not necessarily specify the character sets used. Thus, even though the representation might provide an indication of what to expect, the sender is still free to encode the contents using whatever character set is desired. This component provides only hints for the receiver, so it can make choices regarding what it has been sent and what it is capable of displaying.
Definition: This component is used to designate the context in which a name is used. The main use case is in Australian healthcare for indigenous patients who prefer to use different names when attending different healthcare institutions. Another use case occurs in the US where health practitioners can be licensed under slightly different names and the reporting of the correct name is vital for administrative purposes. Refer to User-defined Table 0448 – Name Context for suggested values.
Attention: The XPN.10 component was deprecated as of v2.5 and the detail was withdrawn and removed from the standard as of v2.7. Refer to 2.A.89.12, "Effective date (DTM)" and 2.A.89.13, "Expiration date (DTM)" components.
Definition: A code that represents the preferred display order of the components of this person name. Refer to HL7 0444 – Name Assembly Order for valid values.
Definition: The first date, if known, on which the person name is valid and active.
Definition: The last date, if known, on which the person name is valid and active.
Definition: Used to specify an abbreviation, or a string of abbreviations denoting qualifications that support the person’s profession, (e.g., licenses, certificates, degrees, affiliations with professional societies, etc.). The Professional Suffix normally follows the Family Name when the Person Name is used for display purposes. Please note that this component is an unformatted string and is used for display purposes only. Detailed information regarding the contents of Professional Suffix is obtained using appropriate segments in Chapter 15, Personnel Management.
Definition: A "called by" name is the name that is preferred when a person is directly addressed; sometimes known as a nickname.
Note: The called by component contains a name that could be categorized as a nickname using the name usage types in HL7 Table 0200 - Name type. Its use is reserved for instances in which the nickname is a single name part that is provided in addition to a name that has some other type, such as legal. It is understood that the "called by" name is not part of the full name. Where a nickname has more parts, possibly including a family name, a different XPN with a type of nickname should instead be used.
Examples:
James Robert Smith is Called By Jim Bob
James Robert Smith is Called By JR
Peter Richard Smith is Called By Richard
Mary Margaret Elizabeth Jones is Called By Meg.
®© HL7.org 2019+. HL7 v2+ generated on December 11, 2020
Links:
Version History
|
Propose a change
|
License
The Demo site for our new HL7 Version 2+ (plus) Standard
