Clinical Document Architecture
2.0.0-sd-ballot - ballot
Clinical Document Architecture
2.0.0-sd-ballot - ballot
Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions
| Active as of 2024-03-04 |
Definitions for the Patient logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |
| Control | 1..1 |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Patient.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | PSN |
| 4. Patient.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | INSTANCE |
| 6. Patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. Patient.name | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| 10. Patient.sdtcDesc | |
| Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc. |
| 12. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | For example codes, see AdministrativeGender (example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 14. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 16. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 18. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 20. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd. |
| 22. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber. |
| 24. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | For example codes, see MaritalStatus (example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | For example codes, see ReligiousAffiliation (example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 28. Patient.raceCode | |
| Control | 0..1 |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 30. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| 32. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 34. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 36. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian |
| 38. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace |
| 40. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication |
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..1* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Patient.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | PSN |
| 4. Patient.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | INSTANCE |
| 6. Patient.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IIid |
| Is Modifier | false |
| 8. Patient.name | |
| Definition | A name associated with the individual. |
| Short | A name associated with the patient |
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName |
| Is Modifier | false |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Patient.sdtcDesc | |
| Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc. |
| 12. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | For example codes, see AdministrativeGender (example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 14. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 16. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 18. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 20. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd. |
| 22. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber. |
| 24. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | For example codes, see MaritalStatus (example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 26. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | For example codes, see ReligiousAffiliation (example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 28. Patient.raceCode | |
| Control | 0..1 |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 30. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| 32. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 34. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 36. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian |
| 38. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace |
| 40. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication |
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |
| Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
| Short | Base for all types and resources |
| Control | 1..1 |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| Validation | Instances of this type are validated by templateId |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Patient.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 4. Patient.realmCode | |
| Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 6. Patient.typeId | |
| Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 8. Patient.typeId.nullFlavor | |
| Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Exceptional Value Detail |
| 10. Patient.typeId.assigningAuthorityName | |
| Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
| Control | 0..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Assigning Authority Name |
| 12. Patient.typeId.displayable | |
| Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Displayable |
| 14. Patient.typeId.root | |
| Definition | Identifies the type as an HL7 Registered model |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Fixed Value | 2.16.840.1.113883.1.3 |
| 16. Patient.typeId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| 18. Patient.templateId | |
| Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 20. Patient.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject (required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | PSN |
| 22. Patient.determinerCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | INSTANCE |
| 24. Patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 26. Patient.name | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| 28. Patient.sdtcDesc | |
| Definition | The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc. |
| 30. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | For example codes, see AdministrativeGender (example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 32. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| 34. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd. |
| 36. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime. |
| 38. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd. |
| 40. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT-POS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber. |
| 42. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | For example codes, see MaritalStatus (example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 44. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | For example codes, see ReligiousAffiliation (example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 46. Patient.raceCode | |
| Control | 0..1 |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 48. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | For example codes, see Race (example to http://terminology.hl7.org/ValueSet/v3-Race) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode. |
| 50. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 52. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | For example codes, see Ethnicity (example to http://terminology.hl7.org/ValueSet/v3-Ethnicity) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode. |
| 54. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Guardian |
| 56. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Birthplace |
| 58. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication |
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd-ballot based on FHIR 5.0.0. Generated 2024-03-04
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change