Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
 @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced | |
 item | ||||
 family | 0..* | ENXP | (USCDI) Last Name | |
 @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
 suffix | 0..* | ENXP | (USCDI) Suffix | |
 @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
 @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: CDAEntityNameUse (required) | |
 item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance |
 family | 0..* | ENXP | (USCDI) Last Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | (USCDI) Suffix | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.use | required | CDAEntityNameUse |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: CDAEntityNameUse (required) | |
| item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance |
 (Choice of one) | 1..1 | |||
 delimiter | 0..* | ENXP | ||
 family | 0..* | ENXP | (USCDI) Last Name | |
 @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | (USCDI) Suffix | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
 xmlText | 0..1 | st | Allows for mixed text content | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.nullFlavor | required | CDANullFlavor |
| PN.use | required | CDAEntityNameUse |
| PN.item.family.nullFlavor | required | CDANullFlavor |
| PN.item.family.partType | required | EntityNamePartType |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.nullFlavor | required | CDANullFlavor |
| PN.item.given.partType | required | EntityNamePartType |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.nullFlavor | required | CDANullFlavor |
| PN.item.prefix.partType | required | EntityNamePartType |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.nullFlavor | required | CDANullFlavor |
| PN.item.suffix.partType | required | EntityNamePartType |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
This structure is derived from PN
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, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
| @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced | |
| item | ||||
| family | 0..* | ENXP | (USCDI) Last Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | (USCDI) Suffix | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
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, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
| @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: CDAEntityNameUse (required) | |
| item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance |
| family | 0..* | ENXP | (USCDI) Last Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | (USCDI) Suffix | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.use | required | CDAEntityNameUse |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). shall-max-suffix: There may be at most one suffix 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: CDAEntityNameUse (required) | |
| item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance |
| (Choice of one) | 1..1 | |||
| delimiter | 0..* | ENXP | ||
| family | 0..* | ENXP | (USCDI) Last Name | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| given | 0..* | ENXP | (USCDI) First Name / Middle Name | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | (USCDI) Suffix | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @representation | 0..1 | cs | Fixed Value: TXT | |
| @mediaType | 0..1 | cs | Fixed Value: text/plain | |
| @language | 0..1 | cs | ||
| xmlText | 0..1 | st | Allows for mixed text content | |
| @partType | 0..1 | cs | Binding: EntityNamePartType (required) | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| xmlText | 0..1 | st | Allows for mixed text content | |
| validTime | 0..1 | IVL_TS | (USCDI) Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| PN.nullFlavor | required | CDANullFlavor |
| PN.use | required | CDAEntityNameUse |
| PN.item.family.nullFlavor | required | CDANullFlavor |
| PN.item.family.partType | required | EntityNamePartType |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.given.nullFlavor | required | CDANullFlavor |
| PN.item.given.partType | required | EntityNamePartType |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.prefix.nullFlavor | required | CDANullFlavor |
| PN.item.prefix.partType | required | EntityNamePartType |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier |
| PN.item.suffix.nullFlavor | required | CDANullFlavor |
| PN.item.suffix.partType | required | EntityNamePartType |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7278 | error | PN | **SHALL NOT** have mixed content except for white space (CONF:81-7278). : item.xmlText.empty() | |
| EN-1 | error | PN.item | Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1 | |
| pn-no-ls | error | PN | No 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() | |
| shall-family | error | PN | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-given | error | PN | SHALL contain at least one [1..*] given (CONF:81-7157). : nullFlavor.exists() or item.given.exists() | |
| shall-max-suffix | error | PN | There may be at most one suffix : (item.suffix.empty() or item.suffix.count() = 1) |
This structure is derived from PN
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change