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 Person Name (PN.US.FIELDED)

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

The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons.

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: 81-9371, 81-9372

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()
    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, 81-9371, 81-9372
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..* cs 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
    ..... given 0..* ENXP
    ..... prefix 0..* ENXP
    ..... suffix 0..* ENXP
    ..... 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

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).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()
    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, 81-9371, 81-9372
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..* cs 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
    ..... given 0..* ENXP
    ..... prefix 0..* ENXP
    ..... suffix 0..* ENXP
    ..... 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

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).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()

    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: 81-9371, 81-9372

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()

    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, 81-9371, 81-9372
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..* cs 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
    ..... given 0..* ENXP
    ..... prefix 0..* ENXP
    ..... suffix 0..* ENXP
    ..... 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

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).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()

    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, 81-9371, 81-9372
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... @use 0..* cs 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
    ..... given 0..* ENXP
    ..... prefix 0..* ENXP
    ..... suffix 0..* ENXP
    ..... 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

    Constraints

    IdGradePath(s)DetailsRequirements
    81-9371errorPNThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
    : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
    81-9372errorPNThe string **SHALL NOT** contain name parts (CONF:81-9372).
    : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).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()

    This structure is derived from PN

    Summary

     

    Other representations of profile: CSV, Excel