Patient (CDA Class) - Definitions - Clinical Document Architecture v2.0.1

Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.Patient - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Patient logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Patient
Control	1..1
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
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
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.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
8. Patient.id
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
10. Patient.name
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/PN
12. Patient.sdtcDesc
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 name`desc`.
14. Patient.administrativeGenderCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from AdministrativeGender
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
16. Patient.birthTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/TS
18. 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 name`deceasedInd`.
20. 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 name`deceasedTime`.
22. 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 name`multipleBirthInd`.
24. 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 name`multipleBirthOrderNumber`.
26. Patient.maritalStatusCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from MaritalStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Patient.religiousAffiliationCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ReligiousAffiliation
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
30. Patient.raceCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Race
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
32. Patient.sdtcRaceCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`raceCode`.
34. Patient.ethnicGroupCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Ethnicity
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
36. Patient.sdtcEthnicGroupCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`ethnicGroupCode`.
38. Patient.guardian
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Guardian
40. Patient.birthplace
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
42. 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	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Patient.classCode
Control	0..1
Binding	The codes SHALL be taken from 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
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.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
8. 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
10. 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()))
12. Patient.sdtcDesc
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 name`desc`.
14. Patient.administrativeGenderCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from AdministrativeGender
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
16. Patient.birthTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/TS
18. 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 name`deceasedInd`.
20. 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 name`deceasedTime`.
22. 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 name`multipleBirthInd`.
24. 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 name`multipleBirthOrderNumber`.
26. Patient.maritalStatusCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from MaritalStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Patient.religiousAffiliationCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ReligiousAffiliation
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
30. Patient.raceCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Race
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
32. Patient.sdtcRaceCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`raceCode`.
34. Patient.ethnicGroupCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Ethnicity
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
36. Patient.sdtcEthnicGroupCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`ethnicGroupCode`.
38. Patient.guardian
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Guardian
40. Patient.birthplace
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
42. 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	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. Patient.classCode
Control	0..1
Binding	The codes SHALL be taken from 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
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.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
8. Patient.id
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
10. Patient.name
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/PN
12. Patient.sdtcDesc
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 name`desc`.
14. Patient.administrativeGenderCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from AdministrativeGender
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
16. Patient.birthTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/TS
18. 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 name`deceasedInd`.
20. 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 name`deceasedTime`.
22. 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 name`multipleBirthInd`.
24. 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 name`multipleBirthOrderNumber`.
26. Patient.maritalStatusCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from MaritalStatus
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Patient.religiousAffiliationCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from ReligiousAffiliation
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
30. Patient.raceCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Race
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
32. Patient.sdtcRaceCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`raceCode`.
34. Patient.ethnicGroupCode
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Ethnicity
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
36. Patient.sdtcEthnicGroupCode
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from 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 name`ethnicGroupCode`.
38. Patient.guardian
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Guardian
40. Patient.birthplace
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Birthplace
42. 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.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents | QA Report | Version History external | | Propose a change