Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED | Version: 4.0.0-ballot | |||
| Draft as of 2024-12-19 | 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:
Description of Template, Differentials, Snapshots and how the different presentations work.
| 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) pn-no-ls: No PN name part may have a qualifier of LS. 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 EN-1: Can only have only one of the possible item elements in each choice |
   (Choice of one) |
1..1 | |||
   delimiter |
0..* | ENXP | ||
 family |
0..* | ENXP | 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗨𝗦𝗖𝗗𝗜: callMe meets the USCDI 'Name to use' requirement 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 | 𝗨𝗦𝗖𝗗𝗜: 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 | 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PN.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| PN.use | required | CDAEntityNameUsehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse | |
| PN.item.family.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| PN.item.family.partType | required | EntityNamePartTypehttp://terminology.hl7.org/ValueSet/v3-EntityNamePartType | |
| PN.item.family.qualifier | required | EntityPersonNamePartQualifier http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26 | |
| PN.item.given.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| PN.item.given.partType | required | EntityNamePartTypehttp://terminology.hl7.org/ValueSet/v3-EntityNamePartType | |
| PN.item.given.qualifier | required | EntityPersonNamePartQualifier http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26 | |
| PN.item.prefix.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| PN.item.prefix.partType | required | EntityNamePartTypehttp://terminology.hl7.org/ValueSet/v3-EntityNamePartType | |
| PN.item.prefix.qualifier | required | EntityPersonNamePartQualifier http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26 | |
| PN.item.suffix.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| PN.item.suffix.partType | required | EntityNamePartTypehttp://terminology.hl7.org/ValueSet/v3-EntityNamePartType | |
| PN.item.suffix.qualifier | required | EntityPersonNamePartQualifier http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26 |
| 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) |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change