Consolidated CDA Release 2.2
2.2 - CI Build Unknown state code 'US'

Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions

Resource Profile: USRealmHeader - XML Profile

Active as of 2023-05-30

XML representation of the 2.16.840.1.113883.10.20.22.1.1 resource profile.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="2.16.840.1.113883.10.20.22.1.1"/>
  <meta>
    <versionId value="5"/>
    <lastUpdated value="2022-05-13T19:09:34.462+00:00"/>
    <source value="#kniLtlGhdA7knl9h"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-2.16.840.1.113883.10.20.22.1.1-definitions.html#ClinicalDocument">ClinicalDocument</a><a name="ClinicalDocument"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/ahdis/cda-core-2.0//StructureDefinition-ClinicalDocument.html">CDAR2.ClinicalDocument</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Base for all types and resources</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.1.1"/>
  <identifier>
    <value value="urn:hl7ii:2.16.840.1.113883.10.20.22.1.1:2015-08-01"/>
  </identifier>
  <version value="2.2"/>
  <name value="USRealmHeader"/>
  <title value="US Realm Header"/>
  <status value="active"/>
  <date value="2023-05-30T19:31:57+00:00"/>
  <publisher value="Health Level Seven"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
  </contact>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166:-2"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <fhirVersion value="4.0.1"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="resource"/>
  <abstract value="false"/>
  <type value="ClinicalDocument"/>
  <baseDefinition
                  value="http://hl7.org/fhir/cda/StructureDefinition/ClinicalDocument"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="ClinicalDocument">
      <path value="ClinicalDocument"/>
      <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>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="ClinicalDocument.classCode">
      <path value="ClinicalDocument.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="DOCCLIN"/>
      <fixedCode value="DOCCLIN"/>
      <binding>
        <strength value="extensible"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClass"/>
      </binding>
    </element>
    <element id="ClinicalDocument.moodCode">
      <path value="ClinicalDocument.moodCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.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="ClinicalDocument.realmCode">
      <path value="ClinicalDocument.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="ClinicalDocument.realmCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="ClinicalDocument.typeId">
      <path value="ClinicalDocument.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="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.typeId"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ClinicalDocument.templateId">
      <path value="ClinicalDocument.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="ClinicalDocument.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ClinicalDocument.id">
      <path value="ClinicalDocument.id"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.id"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ClinicalDocument.code">
      <path value="ClinicalDocument.code"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.code"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <valueSet value="http://hl7.org/fhir/ValueSet/doc-typecodes"/>
      </binding>
    </element>
    <element id="ClinicalDocument.title">
      <path value="ClinicalDocument.title"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.title"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ST"/>
      </type>
    </element>
    <element id="ClinicalDocument.effectiveTime">
      <path value="ClinicalDocument.effectiveTime"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.effectiveTime"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="ClinicalDocument.confidentialityCode">
      <path value="ClinicalDocument.confidentialityCode"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.confidentialityCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
    </element>
    <element id="ClinicalDocument.languageCode">
      <path value="ClinicalDocument.languageCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.languageCode"/>
        <min value="0"/>
        <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-HumanLanguage"/>
      </binding>
    </element>
    <element id="ClinicalDocument.setId">
      <path value="ClinicalDocument.setId"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.setId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ClinicalDocument.versionNumber">
      <path value="ClinicalDocument.versionNumber"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.versionNumber"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/INT"/>
      </type>
    </element>
    <element id="ClinicalDocument.copyTime">
      <path value="ClinicalDocument.copyTime"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.copyTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="ClinicalDocument.recordTarget">
      <path value="ClinicalDocument.recordTarget"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.recordTarget"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/RecordTarget"/>
      </type>
    </element>
    <element id="ClinicalDocument.author">
      <path value="ClinicalDocument.author"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.author"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Author"/>
      </type>
    </element>
    <element id="ClinicalDocument.dataEnterer">
      <path value="ClinicalDocument.dataEnterer"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.dataEnterer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/DataEnterer"/>
      </type>
    </element>
    <element id="ClinicalDocument.informant">
      <path value="ClinicalDocument.informant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.informant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Informant"/>
      </type>
    </element>
    <element id="ClinicalDocument.custodian">
      <path value="ClinicalDocument.custodian"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.custodian"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Custodian"/>
      </type>
    </element>
    <element id="ClinicalDocument.informationRecipient">
      <path value="ClinicalDocument.informationRecipient"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.informationRecipient"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/InformationRecipient"/>
      </type>
    </element>
    <element id="ClinicalDocument.legalAuthenticator">
      <path value="ClinicalDocument.legalAuthenticator"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.legalAuthenticator"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/LegalAuthenticator"/>
      </type>
    </element>
    <element id="ClinicalDocument.authenticator">
      <path value="ClinicalDocument.authenticator"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.authenticator"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/Authenticator"/>
      </type>
    </element>
    <element id="ClinicalDocument.participant">
      <path value="ClinicalDocument.participant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.participant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/Participant1"/>
      </type>
    </element>
    <element id="ClinicalDocument.inFulfillmentOf">
      <path value="ClinicalDocument.inFulfillmentOf"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.inFulfillmentOf"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/InFulfillmentOf"/>
      </type>
    </element>
    <element id="ClinicalDocument.documentationOf">
      <path value="ClinicalDocument.documentationOf"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.documentationOf"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/DocumentationOf"/>
      </type>
    </element>
    <element id="ClinicalDocument.relatedDocument">
      <path value="ClinicalDocument.relatedDocument"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.relatedDocument"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/RelatedDocument"/>
      </type>
    </element>
    <element id="ClinicalDocument.authorization">
      <path value="ClinicalDocument.authorization"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ClinicalDocument.authorization"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/Authorization"/>
      </type>
    </element>
    <element id="ClinicalDocument.componentOf">
      <path value="ClinicalDocument.componentOf"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.componentOf"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/ComponentOf"/>
      </type>
    </element>
    <element id="ClinicalDocument.component">
      <path value="ClinicalDocument.component"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ClinicalDocument.component"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Component2"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="ClinicalDocument">
      <path value="ClinicalDocument"/>
    </element>
  </differential>
</StructureDefinition>