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

Active as of 2023-01-16

XML representation of the Author logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Author"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Represents the humans and/or machines that authored the document.</p>
      <p>In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is &quot;Medical Student Progress Note&quot;. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply &quot;Physician Progress Note&quot; and the value of Author.functionCode is &quot;rounding physician&quot;), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.</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/Author"/>
  <version value="2.1.0-draft1"/>
  <name value="CDAR2.Author"/>
  <title value="Author (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="Represents the humans and/or machines that authored the document. In some cases, the role or function of the author is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is &quot;Medical Student Progress Note&quot;. The role of the author can also be recorded in the Author.functionCode or AssignedAuthor.code attribute. If either of these attributes is included, they should be equivalent to or further specialize the role inherent in the ClinicalDocument.code (such as where the ClinicalDocument.code is simply &quot;Physician Progress Note&quot; and the value of Author.functionCode is &quot;rounding physician&quot;), and shall not conflict with the role inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation."/>
  <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="Author"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="Author">
      <path value="Author"/>
      <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="Author.nullFlavor">
      <path value="Author.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="Author.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
      </binding>
    </element>
    <element id="Author.typeCode">
      <path value="Author.typeCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Author.typeCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <fixedCode value="AUT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
      </binding>
    </element>
    <element id="Author.contextControlCode">
      <path value="Author.contextControlCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Author.contextControlCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <fixedCode value="OP"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ContextControl"/>
      </binding>
    </element>
    <element id="Author.realmCode">
      <path value="Author.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="Author.realmCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="Author.typeId">
      <path value="Author.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="Author.typeId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Author.templateId">
      <path value="Author.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="Author.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Author.functionCode">
      <path value="Author.functionCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Author.functionCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
    </element>
    <element id="Author.time">
      <path value="Author.time"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Author.time"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Author.assignedAuthor">
      <path value="Author.assignedAuthor"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Author.assignedAuthor"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="Author">
      <path value="Author"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="Author.nullFlavor">
      <path value="Author.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"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
      </binding>
    </element>
    <element id="Author.typeCode">
      <path value="Author.typeCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <fixedCode value="AUT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ParticipationType"/>
      </binding>
    </element>
    <element id="Author.contextControlCode">
      <path value="Author.contextControlCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <fixedCode value="OP"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ContextControl"/>
      </binding>
    </element>
    <element id="Author.realmCode">
      <path value="Author.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="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="Author.typeId">
      <path value="Author.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"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Author.templateId">
      <path value="Author.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="Author.functionCode">
      <path value="Author.functionCode"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
    </element>
    <element id="Author.time">
      <path value="Author.time"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Author.assignedAuthor">
      <path value="Author.assignedAuthor"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor"/>
      </type>
    </element>
  </differential>
</StructureDefinition>