Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the Patient logical model.
Guidance on how to interpret the contents of this table can be found here.
| 1. Patient | |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Patient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 3. Patient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 4. 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/fhir/cda/StructureDefinition/II |
| 5. Patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. Patient.name | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
| 7. Patient.sdtcDesc | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc. |
| 8. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrativeGender; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 10. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd. |
| 11. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime. |
| 12. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthInd. |
| 13. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT-POS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthOrderNumber. |
| 14. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MaritalStatus; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 15. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ReligiousAffiliation; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 16. Patient.raceCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 17. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name raceCode. |
| 18. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 19. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name ethnicGroupCode. |
| 20. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Guardian |
| 21. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Birthplace |
| 22. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication |
Guidance on how to interpret the contents of this table can be found here.
| 1. Patient | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. Patient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 3. Patient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 4. 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/fhir/cda/StructureDefinition/II |
| 5. Patient.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IIid |
| 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. |
| 6. Patient.name | |
| Definition | A name associated with the individual. |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ENHumanName |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| 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. |
| 7. Patient.sdtcDesc | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc. |
| 8. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrativeGender; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 10. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd. |
| 11. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime. |
| 12. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthInd. |
| 13. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT-POS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthOrderNumber. |
| 14. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MaritalStatus; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 15. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ReligiousAffiliation; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 16. Patient.raceCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 17. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name raceCode. |
| 18. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 19. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name ethnicGroupCode. |
| 20. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Guardian |
| 21. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Birthplace |
| 22. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication |
Guidance on how to interpret the contents of this table can be found here.
| 1. Patient | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. Patient.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityClassLivingSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PSN |
| Fixed Value | PSN |
| 3. Patient.determinerCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from EntityDeterminer |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INSTANCE |
| Fixed Value | INSTANCE |
| 4. 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/fhir/cda/StructureDefinition/II |
| 5. Patient.id | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. Patient.name | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
| 7. Patient.sdtcDesc | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc. |
| 8. Patient.administrativeGenderCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AdministrativeGender; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 9. Patient.birthTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 10. Patient.sdtcDeceasedInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd. |
| 11. Patient.sdtcDeceasedTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime. |
| 12. Patient.sdtcMultipleBirthInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthInd. |
| 13. Patient.sdtcMultipleBirthOrderNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT-POS |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name multipleBirthOrderNumber. |
| 14. Patient.maritalStatusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from MaritalStatus; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 15. Patient.religiousAffiliationCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ReligiousAffiliation; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 16. Patient.raceCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 17. Patient.sdtcRaceCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Race; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name raceCode. |
| 18. Patient.ethnicGroupCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 19. Patient.sdtcEthnicGroupCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from Ethnicity; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name ethnicGroupCode. |
| 20. Patient.guardian | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Guardian |
| 21. Patient.birthplace | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Birthplace |
| 22. Patient.languageCommunication | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication |
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change