This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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: R3 R2

Extension-datadictionary.xml

Raw XML (canonical form)

Associates the structure definition with a collection of Data Elements

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="datadictionary"/>
  <url value="http://hl7.org/fhir/StructureDefinition/datadictionary"/>
  <name value="Associates the structure definition with a collection of Data Elements"/>
  <display value="Data Dictionary"/>
  <publisher value="Health Level Seven, Inc. - FHIR Core WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/special/committees/FHIR"/>
    </telecom>
  </contact>
  <description value="This extension associates a structure definition with a data dictionary - a collection
   of data elements that any instance of data that conforms to the structure definition must
   also conform to. The value of the extension is a uri the defines a query that identifies
   the collection of relevant data elements  This extension can be used on any structure
   definition that is a constraint on the resource types Observation and Questionnaire. THe
   profile specifies which elements are mandatory etc, but any elements in a resource that
   conforms to the structure definition must also conform to one of the defined data elements.
    For Observation: * Observation.code must be associated with a matching Data Element by
   DataElement.code.  * The structure definition should bind Observation.code to a value
   set that has the same codes as the collection of data elements (though it can be narrower)
   * the units and the quantity value should conform to the rules laid down in the matching
   Data Element  For Questionnaire: * todo."/>
  <status value="draft"/>
  <date value="2014-01-31"/>
  <type value="extension"/>
  <abstract value="false"/>
  <contextType value="resource"/>
  <context value="StructureDefinition"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <snapshot>
    <element>
      <path value="Extension"/>
      <short value="Associates the structure definition with a collection of Data Elements"/>
      <definition value="This extension associates a structure definition with a data dictionary - a collection
       of data elements that any instance of data that conforms to the structure definition must
       also conform to. The value of the extension is a uri the defines a query that identifies
       the collection of relevant data elements  This extension can be used on any structure
       definition that is a constraint on the resource types Observation and Questionnaire. THe
       profile specifies which elements are mandatory etc, but any elements in a resource that
       conforms to the structure definition must also conform to one of the defined data elements.
        For Observation: * Observation.code must be associated with a matching Data Element by
       DataElement.code.  * The structure definition should bind Observation.code to a value
       set that has the same codes as the collection of data elements (though it can be narrower)
       * the units and the quantity value should conform to the rules laid down in the matching
       Data Element  For Questionnaire: * todo."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element>
      <path value="Extension.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"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Extension.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="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Extension.url"/>
      <representation value="xmlAttr"/>
      <short value="identifies the meaning of the extension"/>
      <definition value="Source of the definition for the extension code - a logical name or a URL."/>
      <comments value="The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition should be version specific.  This will ideally be the URI for the Resource
       Profile defining the extension, with the code for the extension after a #."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/datadictionary"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Extension.valueString"/>
      <short value="Value of extension"/>
      <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see
       Extensibility in the spec for list)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Extension"/>
      <short value="Associates the structure definition with a collection of Data Elements"/>
      <definition value="This extension associates a structure definition with a data dictionary - a collection
       of data elements that any instance of data that conforms to the structure definition must
       also conform to. The value of the extension is a uri the defines a query that identifies
       the collection of relevant data elements  This extension can be used on any structure
       definition that is a constraint on the resource types Observation and Questionnaire. THe
       profile specifies which elements are mandatory etc, but any elements in a resource that
       conforms to the structure definition must also conform to one of the defined data elements.
        For Observation: * Observation.code must be associated with a matching Data Element by
       DataElement.code.  * The structure definition should bind Observation.code to a value
       set that has the same codes as the collection of data elements (though it can be narrower)
       * the units and the quantity value should conform to the rules laid down in the matching
       Data Element  For Questionnaire: * todo."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element>
      <path value="Extension.url"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/datadictionary"/>
    </element>
    <element>
      <path value="Extension.value[x]"/>
      <type>
        <code value="string"/>
      </type>
    </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.