Clinical Document Architecture
2.0.0-sd-ballot - 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
| Active as of 2023-10-27 |
XML representation of the Consent logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Consent"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>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.</p>
</div>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueUri value="consent"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-profile-style">
<valueUri value="cda"/>
</extension>
<url value="http://hl7.org/cda/stds/core/StructureDefinition/Consent"/>
<version value="2.0.0-sd-ballot"/>
<name value="Consent"/>
<title value="Consent (CDA Class)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-10-27T07:17:32+11:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structure"/>
</telecom>
<telecom>
<system value="email"/>
<value value="structdog@lists.HL7.org"/>
</telecom>
</contact>
<description
value="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."/>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/Consent"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
<derivation value="specialization"/>
<snapshot>
<element id="Consent">
<path value="Consent"/>
<short value="Base for all types and resources"/>
<definition
value="Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Consent.nullFlavor">
<path value="Consent.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="Consent.realmCode">
<path value="Consent.realmCode"/>
<definition
value="When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="InfrastructureRoot.realmCode"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
</element>
<element id="Consent.typeId">
<path value="Consent.typeId"/>
<definition
value="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="InfrastructureRoot.typeId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Consent.typeId.nullFlavor">
<path value="Consent.typeId.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="Consent.typeId.assigningAuthorityName">
<path value="Consent.typeId.assigningAuthorityName"/>
<representation value="xmlAttr"/>
<label value="Assigning Authority Name"/>
<definition
value="A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="II.assigningAuthorityName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.typeId.displayable">
<path value="Consent.typeId.displayable"/>
<representation value="xmlAttr"/>
<label value="Displayable"/>
<definition
value="Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="II.displayable"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
</type>
</element>
<element id="Consent.typeId.root">
<path value="Consent.typeId.root"/>
<representation value="xmlAttr"/>
<label value="Root"/>
<definition value="Identifies the type as an HL7 Registered model"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="II.root"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
</type>
<fixedString value="2.16.840.1.113883.1.3"/>
</element>
<element id="Consent.typeId.extension">
<path value="Consent.typeId.extension"/>
<representation value="xmlAttr"/>
<label value="Extension"/>
<definition
value="A character string as a unique identifier within the scope of the identifier root."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="II.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.templateId">
<path value="Consent.templateId"/>
<definition
value="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"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="InfrastructureRoot.templateId"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Consent.classCode">
<path value="Consent.classCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Consent.classCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CONS"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="Consent.moodCode">
<path value="Consent.moodCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Consent.moodCode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="EVN"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
</binding>
</element>
<element id="Consent.id">
<path value="Consent.id"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Consent.id"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Consent.code">
<path value="Consent.code"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Consent.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActCode"/>
</binding>
</element>
<element id="Consent.statusCode">
<path value="Consent.statusCode"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Consent.statusCode"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActStatus"/>
</binding>
</element>
<element id="Consent.statusCode.nullFlavor">
<path value="Consent.statusCode.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="Consent.statusCode.code">
<path value="Consent.statusCode.code"/>
<representation value="xmlAttr"/>
<label value="Code"/>
<definition
value="The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache."/>
<comment
value="Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CD.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="completed"/>
</element>
<element id="Consent.statusCode.codeSystem">
<path value="Consent.statusCode.codeSystem"/>
<representation value="xmlAttr"/>
<label value="Code System"/>
<definition value="Specifies the code system that defines the code."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.codeSystem"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
</type>
</element>
<element id="Consent.statusCode.codeSystemName">
<path value="Consent.statusCode.codeSystemName"/>
<representation value="xmlAttr"/>
<label value="Code System Name"/>
<definition value="The common name of the coding system."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.codeSystemName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.statusCode.codeSystemVersion">
<path value="Consent.statusCode.codeSystemVersion"/>
<representation value="xmlAttr"/>
<label value="Code System Version"/>
<definition
value="If applicable, a version descriptor defined specifically for the given code system."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.codeSystemVersion"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.statusCode.displayName">
<path value="Consent.statusCode.displayName"/>
<representation value="xmlAttr"/>
<label value="Display Name"/>
<definition
value="A name or title for the code, under which the sending system shows the code value to its users."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.displayName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.statusCode.sdtcValueSet">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSet"/>
</extension>
<path value="Consent.statusCode.sdtcValueSet"/>
<representation value="xmlAttr"/>
<definition
value="The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.valueSet"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
</type>
</element>
<element id="Consent.statusCode.sdtcValueSetVersion">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
<valueString value="valueSetVersion"/>
</extension>
<path value="Consent.statusCode.sdtcValueSetVersion"/>
<representation value="xmlAttr"/>
<definition
value="The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CD.sdtcValueSetVersion"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="Consent.statusCode.originalText">
<path value="Consent.statusCode.originalText"/>
<label value="Original Text"/>
<definition
value="The text or phrase used as the basis for the coding."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.originalText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
</type>
</element>
<element id="Consent.statusCode.qualifier">
<path value="Consent.statusCode.qualifier"/>
<label value="Qualifier"/>
<definition
value="Specifies additional codes that increase the specificity of the the primary code."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CR"/>
</type>
</element>
<element id="Consent.statusCode.translation">
<path value="Consent.statusCode.translation"/>
<representation value="typeAttr"/>
<label value="Translation"/>
<definition
value="A set of other concept descriptors that translate this concept descriptor into other code systems."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="CD.translation"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CD"/>
</type>
</element>
</snapshot>
<differential>
<element id="Consent">
<path value="Consent"/>
<min value="1"/>
<max value="1"/>
</element>
<element id="Consent.classCode">
<path value="Consent.classCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="CONS"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
</binding>
</element>
<element id="Consent.moodCode">
<path value="Consent.moodCode"/>
<representation value="xmlAttr"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="EVN"/>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
</binding>
</element>
<element id="Consent.id">
<path value="Consent.id"/>
<min value="0"/>
<max value="*"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="Consent.code">
<path value="Consent.code"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
</type>
<binding>
<strength value="example"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActCode"/>
</binding>
</element>
<element id="Consent.statusCode">
<path value="Consent.statusCode"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActStatus"/>
</binding>
</element>
<element id="Consent.statusCode.code">
<path value="Consent.statusCode.code"/>
<representation value="xmlAttr"/>
<comment
value="Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="completed"/>
</element>
</differential>
</StructureDefinition>
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 
|
|
Propose a change