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 - XML Profile

Active as of 2023-01-16

XML representation of the Consent logical model.

Raw xml | Download



<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 &quot;completed&quot;) and should be on file.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/cda/StructureDefinition/Consent"/>
  <version value="2.1.0-draft1"/>
  <name value="CDAR2.Consent"/>
  <title value="Consent (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-01-16T16:39:50+11:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Cross-Group Projects"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cgp@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 &quot;completed&quot;) and should be on file."/>
  <fhirVersion value="5.0.0-snapshot3"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="Consent"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="Consent">
      <path value="Consent"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="Base definition for all types defined in FHIR type system."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression
                    value="hasValue() or (children().count() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Consent.classCode">
      <path value="Consent.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Consent.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="CONS"/>
      <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="1"/>
      <max value="1"/>
      <base>
        <path value="Consent.moodCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="EVN"/>
      <fixedCode value="EVN"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
      </binding>
    </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="Consent.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </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/fhir/cda/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/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <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/fhir/cda/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"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Consent.statusCode.code"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="completed"/>
      <fixedCode value="completed"/>
    </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="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="CONS"/>
      <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="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="EVN"/>
      <fixedCode value="EVN"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
      </binding>
    </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="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Consent.id">
      <path value="Consent.id"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Consent.code">
      <path value="Consent.code"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <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/fhir/cda/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"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="completed"/>
      <fixedCode value="completed"/>
    </element>
  </differential>
</StructureDefinition>