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)

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.5.1 | Version: 2.2
Active as of 2022-05-13 | Computable Name: USRealmPatientNamePTNUSFIELDED
Other Identifiers: : 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:

- Use this Resource Profile: US Realm Header, Unstructured Document, Transfer Summary, Referral Note, Care Plan, Continuity of Care Document (CCD), History and Physical, Consultation Note, Diagnostic Imaging Report, Procedure Note, Operative Note, Discharge Summary, Progress Note, US Realm Header for Patient Generated Document

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from PN

Summary

Mandatory: 2 elements

This structure is derived from PN

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | I | 1..* | PN | 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
use |  | 0..1 | code | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
family |  | 1..1 | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
given | I | 1..* | ENXP | 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
prefix |  | 0..* | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
suffix |  | 0..1 | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | I | 1..* | PN | 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
use |  | 0..1 | code | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
delimiter |  | 0..* | ENXP |
family |  | 1..1 | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
given | I | 1..* | ENXP | 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
prefix |  | 0..* | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
suffix |  | 0..1 | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
other |  | 0..1 | string |
validTime |  | 0..1 | IVL_TS |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | I | 1..* | PN | 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
Documentation for this format

This structure is derived from PN

Summary

Mandatory: 2 elements

Differential View

This structure is derived from PN

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | I | 1..* | PN | 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
use |  | 0..1 | code | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
family |  | 1..1 | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
given | I | 1..* | ENXP | 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
prefix |  | 0..* | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
suffix |  | 0..1 | ENXP |
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | I | 1..* | PN | 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
use |  | 0..1 | code | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
delimiter |  | 0..* | ENXP |
family |  | 1..1 | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
given | I | 1..* | ENXP | 81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
prefix |  | 0..* | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
suffix |  | 0..1 | ENXP |
nullFlavor |  | 0..1 | code | Binding: NullFlavor (required)
charset |  | 0..1 | code |
language |  | 0..1 | code |
mediaType |  | 0..1 | code | Fixed Value: text/plain
representation |  | 0..1 | code | Fixed Value: TXT
data[x] |  | 0..1 | string |
partType |  | 0..1 | code | Binding: EntityNamePartType (required)
qualifier |  | 0..1 | code | Binding: EntityPersonNamePartQualifier (required)
other |  | 0..1 | string |
validTime |  | 0..1 | IVL_TS |
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
PN.nullFlavor | required | NullFlavor
PN.use | required | EntityNameUse
PN.family.nullFlavor | required | NullFlavor
PN.family.partType | required | EntityNamePartType
PN.family.qualifier | required | EntityPersonNamePartQualifier
PN.given.nullFlavor | required | NullFlavor
PN.given.partType | required | EntityNamePartType
PN.given.qualifier | required | EntityPersonNamePartQualifier
PN.prefix.nullFlavor | required | NullFlavor
PN.prefix.partType | required | EntityNamePartType
PN.prefix.qualifier | required | EntityPersonNamePartQualifier
PN.suffix.nullFlavor | required | NullFlavor
PN.suffix.partType | required | EntityNamePartType
PN.suffix.qualifier | required | EntityPersonNamePartQualifier

#### Constraints

Id | Grade | Path | Details | Requirements
81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : |
81-7163 | warning | PN.given | The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). : |