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

Logical Model: CDAR2.Consent - Detailed Descriptions

Active as of 2023-01-16

Definitions for the Consent logical model.

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

1. Consent
Control1..1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCONS
Fixed ValueCONS
3. Consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
4. Consent.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
5. Consent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Consent.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
7. Consent.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
8. Consent.statusCode.code
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuecompleted
Fixed Valuecompleted

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

1. Consent
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCONS
Fixed ValueCONS
3. Consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
4. Consent.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
5. Consent.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..*1
Typehttp://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. Consent.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
7. Consent.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
8. Consent.statusCode.code
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuecompleted
Fixed Valuecompleted

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

1. Consent
Definition

Base definition for all types defined in FHIR type system.

Control1..1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Consent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCONS
Fixed ValueCONS
3. Consent.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
4. Consent.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
5. Consent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Consent.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
7. Consent.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
8. Consent.statusCode.code
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuecompleted
Fixed Valuecompleted