Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: US Realm Patient Name (PTN.US.FIELDED)

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED Version: 4.0.0
Draft as of 2025-06-20 Computable Name: USRealmPatientNamePTNUSFIELDED
Other Identifiers: OID:2.16.840.1.113883.10.20.22.5.1

The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, "Not Applicable" (NA), in the other field.

For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/).

Usages:

Changes since version 3.0.0:

  • No changes

    • Formal Views of Template Content

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

    This structure is derived from PN

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-family, shall-given, shall-max-suffix, 81-7278
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    ... item
    .... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... prefix 0..* ENXP
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ... validTime 0..1 IVL_TS 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: pn-no-ls, shall-family, shall-given, shall-max-suffix, 81-7278
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    Binding: CDAEntityNameUse (required)
    ... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    .... (Choice of one) 1..1
    ..... delimiter 0..* ENXP
    ..... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... prefix 0..* ENXP
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... xmlText 0..1 st Allows for mixed text content

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    PN.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.userequiredCDAEntityNameUse
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
    PN.item.family.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.family.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.given.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.prefix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.suffix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    EN-1errorPN.itemCan only have only one of the possible item elements in each choice
    : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    pn-no-lserrorPNNo PN name part may have a qualifier of LS.
    : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: pn-no-ls, shall-family, shall-given, shall-max-suffix, 81-7278
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    Binding: CDAEntityNameUse (required)
    ... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    .... (Choice of one) 1..1
    ..... delimiter 0..* ENXP
    ..... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... prefix 0..* ENXP
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... xmlText 0..1 st Allows for mixed text content

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    PN.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.userequiredCDAEntityNameUse
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
    PN.item.family.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.family.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.given.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.prefix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.suffix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    EN-1errorPN.itemCan only have only one of the possible item elements in each choice
    : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    pn-no-lserrorPNNo PN name part may have a qualifier of LS.
    : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)

    This structure is derived from PN

    Summary

    Differential View

    This structure is derived from PN

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-family, shall-given, shall-max-suffix, 81-7278
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    ... item
    .... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... prefix 0..* ENXP
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    .... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ..... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ... validTime 0..1 IVL_TS 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: pn-no-ls, shall-family, shall-given, shall-max-suffix, 81-7278
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    Binding: CDAEntityNameUse (required)
    ... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    .... (Choice of one) 1..1
    ..... delimiter 0..* ENXP
    ..... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... prefix 0..* ENXP
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... xmlText 0..1 st Allows for mixed text content

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    PN.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.userequiredCDAEntityNameUse
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
    PN.item.family.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.family.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.given.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.prefix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.suffix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    EN-1errorPN.itemCan only have only one of the possible item elements in each choice
    : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    pn-no-lserrorPNNo PN name part may have a qualifier of LS.
    : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. PN C 1..* PN XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item
    Base for all types and resources
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: pn-no-ls, shall-family, shall-given, shall-max-suffix, 81-7278
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
    Binding: CDAEntityNameUse (required)
    ... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    .... (Choice of one) 1..1
    ..... delimiter 0..* ENXP
    ..... family 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Last Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... given 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... prefix 0..* ENXP
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... suffix 0..* ENXP 𝗨𝗦𝗖𝗗𝗜: Suffix
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @representation 0..1 cs Fixed Value: TXT
    ...... @mediaType 0..1 cs Fixed Value: text/plain
    ...... @language 0..1 cs
    ...... xmlText 0..1 st Allows for mixed text content
    ...... @partType 0..1 cs Binding: EntityNamePartType (required)
    ...... @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier . (required)
    ..... xmlText 0..1 st Allows for mixed text content

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    PN.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.userequiredCDAEntityNameUse
    http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
    PN.item.family.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.family.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.family.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.given.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.given.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.given.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.prefix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.prefix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.prefix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    PN.item.suffix.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    PN.item.suffix.partTyperequiredEntityNamePartType
    http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    PN.item.suffix.qualifierrequiredEntityPersonNamePartQualifier .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

    Constraints

    IdGradePath(s)DetailsRequirements
    81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
    : item.xmlText.empty()
    EN-1errorPN.itemCan only have only one of the possible item elements in each choice
    : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    pn-no-lserrorPNNo PN name part may have a qualifier of LS.
    : (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
    shall-familyerrorPNSHALL contain exactly one [1..1] family (CONF:81-7159).
    : nullFlavor.exists() or item.family.count() = 1
    shall-givenerrorPNSHALL contain at least one [1..*] given (CONF:81-7157).
    : nullFlavor.exists() or item.given.exists()
    shall-max-suffixerrorPNThere may be at most one suffix
    : (item.suffix.empty() or item.suffix.count() = 1)

    This structure is derived from PN

    Summary

     

    Other representations of profile: CSV, Excel