Consent (CDA Class) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

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

Logical Model: Consent (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Consent				Version: 2.0.1-sd
Active as of 2025-09-17				Computable Name: Consent

This class references the consents associated with this document. The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file.

Usages:

Use this Logical Model: Authorization (CDA Class)

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id	0..*	II
code	0..1	CE	Binding: v3 Code System ActCode (example)
statusCode	1..1	CS	Binding: ActStatus (required)
@code	1..1	cs	Fixed Value: completed
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@classCode		0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
statusCode		1..1	CS	Binding: ActStatus (required)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Fixed Value: completed
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Consent.statusCode.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Consent.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@classCode		0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
statusCode		1..1	CS	Binding: ActStatus (required)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Fixed Value: completed
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Consent.statusCode.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Consent.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 1 element(1 nested mandatory element)
Fixed: 3 elements

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent	1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@classCode	0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id	0..*	II
code	0..1	CE	Binding: v3 Code System ActCode (example)
statusCode	1..1	CS	Binding: ActStatus (required)
@code	1..1	cs	Fixed Value: completed
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@classCode		0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
statusCode		1..1	CS	Binding: ActStatus (required)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Fixed Value: completed
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Consent.statusCode.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Consent.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Consent		1..1	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension		1..1	st
templateId		0..*	II
@classCode		0..1	cs	Binding: CDAActClass (required) Fixed Value: CONS
@moodCode		0..1	cs	Binding: CDAActMood (required) Fixed Value: EVN
id		0..*	II
code		0..1	CE	Binding: v3 Code System ActCode (example)
statusCode		1..1	CS	Binding: ActStatus (required)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@code		1..1	cs	Fixed Value: completed
@sdtcValueSet		0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion		0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
Consent.classCode	required	Fixed Value: CONS `http://hl7.org/cda/stds/core/ValueSet/CDAActClass` From this IG
Consent.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` From this IG
Consent.code	example	ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
Consent.statusCode	required	ActStatus `http://terminology.hl7.org/ValueSet/v3-ActStatus`
Consent.statusCode.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	Consent.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 1 element(1 nested mandatory element)
Fixed: 3 elements

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2025-09-17
Links: Table of Contents | QA Report | Version History external | | Propose a change