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
Active as of 2023-10-03 |
Definitions for the Consent logical model.
Guidance on how to interpret the contents of this table can be found here
0. Consent | |
Control | 1..1 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Consent.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActClass |
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 | CONS |
4. Consent.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActMood |
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 | EVN |
6. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Consent.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. Consent.code | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
12. Consent.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
14. Consent.statusCode.code | |
Comments | Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file. |
Control | 1..1 |
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 | completed |
Guidance on how to interpret the contents of this table can be found here
0. Consent | |
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. Consent.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActClass |
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 | CONS |
4. Consent.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActMood |
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 | EVN |
6. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Consent.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. Consent.code | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
12. Consent.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
14. Consent.statusCode.code | |
Comments | Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file. |
Control | 1..1 |
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 | completed |
Guidance on how to interpret the contents of this table can be found here
0. Consent | |
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. Consent.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActClass |
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 | CONS |
4. Consent.moodCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActMood |
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 | EVN |
6. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Consent.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. Consent.code | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
12. Consent.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
14. Consent.statusCode.code | |
Comments | Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file. |
Control | 1..1 |
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 | completed |