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

Logical Model: Consent (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Consent Version: 2.0.0-sd-ballot
Active as of 2024-03-04 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.

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CEBinding: v3 Code System ActCode (example)
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Consent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Consent.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 0..1csBinding: ActClass (required)
Fixed Value: CONS
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CEBinding: v3 Code System ActCode (example)
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Consent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
Consent.classCoderequiredFixed Value: CONS
http://terminology.hl7.org/ValueSet/v3-ActClass
Consent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
Consent.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Consent.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Consent.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel