Consolidated CDA Release 2.2
2.2 - CI Build

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/cda-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: US Realm Patient Name (PTN.US.FIELDED)

Defining URL:http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1
Version:2.2
Name:USRealmPatientNamePTNUSFIELDED
Title:US Realm Patient Name (PTN.US.FIELDED)
Status:Active as of 11/24/21, 5:43 PM
Definition:

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/).

Publisher:Health Level Seven
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1

Formal Views of Profile Content

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

This structure is derived from PN

Summary

Mandatory: 2 elements

This structure is derived from PN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-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 I1..*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
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-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 I1..*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
NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).

doco Documentation for this format

This structure is derived from PN

Summary

Mandatory: 2 elements

Differential View

This structure is derived from PN

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-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 I1..*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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PN I1..*PN81-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 I1..*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

 

Other representations of profile: CSV, Excel, Schematron

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

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