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

Clinical Document Architecture
2.0.0-sd-ballot - ballot

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-ballot: CDA 2.0 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, 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 2023-10-27				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:

Use this Logical Model Profile: Authorization (CDA Class)

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
Consent	1..1	InfrastructureRoot	XML 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
@classCode	0..1	cs	Binding: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus

Name	Card.	Type	Description & Constraints
Consent	1..1	InfrastructureRoot	XML 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
@classCode	0..1	cs	Binding: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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

Path	Conformance	ValueSet / Code
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus

Name	Card.	Type	Description & Constraints
Consent	1..1	InfrastructureRoot	XML 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
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
realmCode	0..*	CS
typeId	0..1	II
@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: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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
Consent.nullFlavor	required	CDANullFlavor
Consent.typeId.nullFlavor	required	CDANullFlavor
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus
Consent.statusCode.nullFlavor	required	CDANullFlavor

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:

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
Consent	1..1	InfrastructureRoot	XML 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
@classCode	0..1	cs	Binding: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus

Key Elements View

Name	Card.	Type	Description & Constraints
Consent	1..1	InfrastructureRoot	XML 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
@classCode	0..1	cs	Binding: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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

Path	Conformance	ValueSet / Code
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus

Snapshot View

Name	Card.	Type	Description & Constraints
Consent	1..1	InfrastructureRoot	XML 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
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
realmCode	0..*	CS
typeId	0..1	II
@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: ActClass (required) Fixed Value: CONS
@moodCode	0..1	cs	Binding: ActMood (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
Consent.nullFlavor	required	CDANullFlavor
Consent.typeId.nullFlavor	required	CDANullFlavor
Consent.classCode	required	Fixed Value: CONS
Consent.moodCode	required	Fixed Value: EVN
Consent.code	example	ActCode
Consent.statusCode	required	ActStatus
Consent.statusCode.nullFlavor	required	CDANullFlavor

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:

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.0-sd-ballot based on FHIR 5.0.0. Generated 2023-10-27
Links: Table of Contents | QA Report | Version History external | | Propose a change