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
| Page standards status: Informative |
Definitions for the XPN logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. XPN | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | extended person nameBase for all types and resources |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. XPN.1 | |
| Short | Family Name |
| Control | 1..1 |
| Type | http://hl7.org/v2/StructureDefinition/FN |
| 4. XPN.2 | |
| Short | Given Name |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. XPN.3 | |
| Short | Second and Further Given Names or Initials Thereof |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. XPN.4 | |
| Short | Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. XPN.5 | |
| Short | Prefix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. XPN.6 | |
| Short | Degree |
| 14. XPN.7 | |
| Short | Name Type Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameType (required to http://terminology.hl7.org/ValueSet/v2-0200) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. XPN.8 | |
| Short | Name Representation Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-name-addressRepresentation (required to http://terminology.hl7.org/ValueSet/v2-0465) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. XPN.9 | |
| Short | Name Context |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to http://terminology.hl7.org/ValueSet/v2-0448) |
| Type | http://hl7.org/v2/StructureDefinition/CWE |
| 20. XPN.10 | |
| Short | Name Validity Range |
| 22. XPN.11 | |
| Short | Name Assembly Order |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to http://terminology.hl7.org/ValueSet/v2-0444) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. XPN.12 | |
| Short | Effective Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. XPN.13 | |
| Short | Expiration Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. XPN.14 | |
| Short | Professional Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. XPN.15 | |
| Short | Called By |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. XPN | |
| Short | extended person name |
| Control | 0..* |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. XPN.1 | |
| Short | Family Name |
| Control | 1..1 |
| Type | http://hl7.org/v2/StructureDefinition/FN |
| 4. XPN.2 | |
| Short | Given Name |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. XPN.3 | |
| Short | Second and Further Given Names or Initials Thereof |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. XPN.4 | |
| Short | Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. XPN.5 | |
| Short | Prefix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. XPN.6 | |
| Short | Degree |
| 14. XPN.7 | |
| Short | Name Type Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameType (required to http://terminology.hl7.org/ValueSet/v2-0200) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. XPN.8 | |
| Short | Name Representation Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-name-addressRepresentation (required to http://terminology.hl7.org/ValueSet/v2-0465) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. XPN.9 | |
| Short | Name Context |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to http://terminology.hl7.org/ValueSet/v2-0448) |
| Type | http://hl7.org/v2/StructureDefinition/CWE |
| 20. XPN.10 | |
| Short | Name Validity Range |
| 22. XPN.11 | |
| Short | Name Assembly Order |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to http://terminology.hl7.org/ValueSet/v2-0444) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. XPN.12 | |
| Short | Effective Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. XPN.13 | |
| Short | Expiration Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. XPN.14 | |
| Short | Professional Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. XPN.15 | |
| Short | Called By |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. XPN | |
| Definition | Base definition for all types defined in FHIR type system. |
| Short | extended person name |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. XPN.1 | |
| Short | Family Name |
| Control | 1..1 |
| Type | http://hl7.org/v2/StructureDefinition/FN |
| 4. XPN.2 | |
| Short | Given Name |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. XPN.3 | |
| Short | Second and Further Given Names or Initials Thereof |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. XPN.4 | |
| Short | Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. XPN.5 | |
| Short | Prefix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. XPN.6 | |
| Short | Degree |
| 14. XPN.7 | |
| Short | Name Type Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameType (required to http://terminology.hl7.org/ValueSet/v2-0200) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. XPN.8 | |
| Short | Name Representation Code |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-name-addressRepresentation (required to http://terminology.hl7.org/ValueSet/v2-0465) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. XPN.9 | |
| Short | Name Context |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v2-0448 (required to http://terminology.hl7.org/ValueSet/v2-0448) |
| Type | http://hl7.org/v2/StructureDefinition/CWE |
| 20. XPN.10 | |
| Short | Name Validity Range |
| 22. XPN.11 | |
| Short | Name Assembly Order |
| Control | 0..1 |
| Binding | The codes SHALL be taken from hl7VS-nameAssemblyOrder (required to http://terminology.hl7.org/ValueSet/v2-0444) |
| Type | http://hl7.org/v2/StructureDefinition/ID |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. XPN.12 | |
| Short | Effective Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. XPN.13 | |
| Short | Expiration Date |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/DTM |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. XPN.14 | |
| Short | Professional Suffix |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. XPN.15 | |
| Short | Called By |
| Control | 0..1 |
| Type | http://hl7.org/v2/StructureDefinition/ST |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |