Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: US Realm Patient Name - PTN.US.FIELDED

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: USRealmPatientNamePTNUSFIELDED
Other Identifiers: id: urn: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/).

Usage:

Formal Views of Profile Content

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

This structure is derived from PN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... family 1..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PN.userequiredEntityNameUse
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:
81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... family 1..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PN.userequiredEntityNameUse
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:
81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... nullFlavor 0..1codeBinding: NullFlavor (required)
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... delimiter 0..*ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... prefix 0..*ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... other 0..1string
... validTime 0..1IVL_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PN.nullFlavorrequiredNullFlavor
PN.userequiredEntityNameUse
PN.family.nullFlavorrequiredNullFlavor
PN.family.partTyperequiredEntityNamePartType
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.nullFlavorrequiredNullFlavor
PN.given.partTyperequiredEntityNamePartType
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.nullFlavorrequiredNullFlavor
PN.prefix.partTyperequiredEntityNamePartType
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.nullFlavorrequiredNullFlavor
PN.suffix.partTyperequiredEntityNamePartType
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:

This structure is derived from PN

Summary

Mandatory: 2 elements

Differential View

This structure is derived from PN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... family 1..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PN.userequiredEntityNameUse
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:
81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... family 1..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PN.userequiredEntityNameUse
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:
81-7278errorPN**SHALL NOT** have mixed content except for white space (CONF:81-7278).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN C1..*PNBase for all types and resources
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
... nullFlavor 0..1codeBinding: NullFlavor (required)
... use 0..1codeIf name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
Binding: EntityNameUse (required)
... delimiter 0..*ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... given C1..*ENXP81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... prefix 0..*ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... suffix 0..1ENXP
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... charset 0..1code
.... language 0..1code
.... mediaType 0..1codeFixed Value: text/plain
.... representation 0..1codeFixed Value: TXT
.... data[x] 0..1string
.... partType 0..1codeBinding: EntityNamePartType (required)
.... qualifier 0..1codeBinding: EntityPersonNamePartQualifier (required)
... other 0..1string
... validTime 0..1IVL_TS

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PN.nullFlavorrequiredNullFlavor
PN.userequiredEntityNameUse
PN.family.nullFlavorrequiredNullFlavor
PN.family.partTyperequiredEntityNamePartType
PN.family.qualifierrequiredEntityPersonNamePartQualifier
PN.given.nullFlavorrequiredNullFlavor
PN.given.partTyperequiredEntityNamePartType
PN.given.qualifierrequiredEntityPersonNamePartQualifier
PN.prefix.nullFlavorrequiredNullFlavor
PN.prefix.partTyperequiredEntityNamePartType
PN.prefix.qualifierrequiredEntityPersonNamePartQualifier
PN.suffix.nullFlavorrequiredNullFlavor
PN.suffix.partTyperequiredEntityNamePartType
PN.suffix.qualifierrequiredEntityPersonNamePartQualifier

Constraints

IdGradePath(s)DetailsRequirements
81-7163warningPN.givenThe second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
:

This structure is derived from PN

Summary

Mandatory: 2 elements

 

​Other representations of profile: CSV, Excel, Schematron