STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Backboneelement.profile.xml

Raw XML (canonical form)

StructureDefinition for BackboneElement

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="BackboneElement"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <table border="0" cellpadding="0" cellspacing="0" style="border: 0px; 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 class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="The logical name of the element">Name</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Information about the use of the element">Flags</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a>
          </th>
          <th class="hierarchy" style="width: 100px">
            <a href="formats.html#table" title="Reference to the type of the element">Type</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Additional information about the element">Description &amp; Constraints</a>
            <span style="float: right">
              <a href="formats.html#table" title="Legend for this format">
                <img alt="doco" src="help16.png" style="background-color: inherit"/>
              </a>
            </span>
          </th>
        </tr>
        <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px;
           white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA
          YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5
          CYII=)">
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAMQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw
            /npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///////yH5BAEAAB8ALAAAAAAQABAAAAV24CeOZG
            mepqeqqOgxjBZFa+19r4ftWQUAgqDgltthMshMIJAZ4jYDHsBARSAmFOJvq+g6HIdEFgcYmBWNxoNAsDjGHgBnmV5bCoUDHLBIq9s
            FEhIdcAYJdYASFRUQhQkLCwkOFwcdEBAXhVabE52ecDahKy0oIQA7" style="background-color: white; background-color: inherit" title="Element"/> 
            <a href="datatypes-definitions.html#BackboneElement" title="BackboneElement : Base definition for all elements that are defined inside a resource
             - but not those in a data type.">BackboneElement</a>
            <a name="BackboneElement"> </a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"/>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"/>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="element.html">Element</a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Base for elements defined inside a resource</td>
        </tr>

        <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px;
           white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA
          YAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkRjgNAAAAAASUVORK5CYII=)">
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
            L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U
            29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAADdSURBVDjLY/j//z8DJZhhmBvw41KQ07dzbk5kG/Dtgu/Jb2fsT5JkwI+bqZ
            w/rsfYA21v+XE97f+PS5H/vx5Ra/98QN7+824ZTiIMSJr580bW/x+3iv//etD9/+fdpv/fzwX+/3LY6P/n7TIzCRtwPYYZaPvGH7d
            KgAb0AA1o/v/tQsh/oO0bP26TZiYqDIB+1/1+wef/z3vN/3/erPr/5aAOyHZdogMRGPIe38/7gvz+Gej3z18OG/8H2u5BvAFn7GO/
            Htdv/3pAQejzXjkhoO3tH7dIxY7EpEwMBgAr6O5Q8udliwAAAABJRU5ErkJggg==" style="background-color: white; background-color: inherit" title="Extension"/> 
            <a href="datatypes-definitions.html#BackboneElement.modifierExtension" title="BackboneElement.modifierExtension : May be used to represent additional information that
             is not part of the basic definition of the element, and that modifies the understanding
             of the element that contains it. Usually modifier elements provide negation or qualification.
             In order to make the use of extensions safe and manageable, there is a strict set of governance
             applied to the definition and use of extensions. Though any implementer is allowed to
             define an extension, there is a set of requirements that SHALL be met as part of the definition
             of the extension. Applications processing a resource are required to check for modifier
             extensions.">modifierExtension</a>
            <a name="BackboneElement.modifierExtension"> </a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <span title="This element is a modifier element">?! </span>
            <span title="This element is included in summaries">Σ</span>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..*</td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="extensibility.html#Extension">Extension</a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Extensions that cannot be ignored</td>
        </tr>

        <tr>
          <td class="hierarchy" colspan="5">
            <br/>
            <a href="formats.html#table" title="Legend for this format">
              <img alt="doco" src="help16.png" style="background-color: inherit"/> Documentation for this format
            </a>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/BackboneElement"/>
  <name value="BackboneElement"/>
  <status value="draft"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2016-03-31T08:01:25+11:00"/>
  <description value="Base StructureDefinition for BackboneElement Type"/>
  <fhirVersion value="1.4.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <kind value="datatype"/>
  <abstract value="true"/>
  <baseType value="Element"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element>
      <path value="BackboneElement"/>
      <short value="Base for elements defined inside a resource"/>
      <definition value="Base definition for all elements that are defined inside a resource - but not those in
       a data type."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="BackboneElement.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="BackboneElement.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="BackboneElement.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="BackboneElement"/>
      <short value="Base for elements defined inside a resource"/>
      <definition value="Base definition for all elements that are defined inside a resource - but not those in
       a data type."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="BackboneElement.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.