Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. 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: 2.1
Draft as of 2023-09-29 | Computable Name: USRealmPersonNamePNUSFIELDED
Other Identifiers: id: urn: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.

Usage:

- Use this Logical Model: Advance Directive Observation, Care Plan, Care Team Member Act, Drug Monitoring Act... Show 4 more, Note Activity, Procedure Activity Procedure, Related Person Relationship and Name Participant and US Realm Header

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from PN

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | PN | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@use |  | 0..1 | cs | Binding: EntityNameUse (required)
delimiter |  | 0..* | ENXP |
family |  | 0..* | ENXP |
given |  | 0..* | ENXP |
prefix |  | 0..* | ENXP |
suffix |  | 0..* | ENXP |
other |  | 0..1 | st |
validTime |  | 0..1 | IVL_TS |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PN.nullFlavor | required | NullFlavor
PN.use | required | EntityNameUse

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | PN | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

This structure is derived from PN

Summary

Differential View

This structure is derived from PN

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | PN | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@use |  | 0..1 | cs | Binding: EntityNameUse (required)
delimiter |  | 0..* | ENXP |
family |  | 0..* | ENXP |
given |  | 0..* | ENXP |
prefix |  | 0..* | ENXP |
suffix |  | 0..* | ENXP |
other |  | 0..1 | st |
validTime |  | 0..1 | IVL_TS |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PN.nullFlavor | required | NullFlavor
PN.use | required | EntityNameUse

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-9371 | error | PN | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | PN | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | PN | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

This structure is derived from PN

Summary

Other representations of profile: CSV, Excel