FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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: R3 R2

Extension-datadictionary.xml

Orders and Observations Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

datadictionary

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="datadictionary"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="oo"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/datadictionary"/> 
  <name value="datadictionary"/> 
  <title value="Data Dictionary"/> 
  <status value="draft"/> 
  <date value="2014-01-31"/> 
  <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 that 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 unit and the quantity value should conform to the rules laid down in the matching
   Data Element

For Questionnaire:
* todo."/> 
  <fhirVersion value="3.0.2"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <contextType value="resource"/> 
  <context value="StructureDefinition"/> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <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 that 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 unit and the quantity value should conform to the rules laid down in the matching
       Data Element

For Questionnaire:
* todo."/> 
      <comment value="The query can select a set of data element resources, or identify a bundle that is a collection
       of data elements."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <condition value="ele-1"/> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() | (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="Extension"/> 
      </constraint> 
    </element> 
    <element id="Extension.id">
      <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). This may be any
       string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <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."/> 
      <comment 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 id="Extension.url">
      <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."/> 
      <comment 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 SHALL be a URI for the Structure Definition defining the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/datadictionary"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.valueString">
      <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"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <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 that 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 unit and the quantity value should conform to the rules laid down in the matching
       Data Element

For Questionnaire:
* todo."/> 
      <comment value="The query can select a set of data element resources, or identify a bundle that is a collection
       of data elements."/> 
      <min value="0"/> 
      <max value="1"/> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/datadictionary"/> 
    </element> 
    <element id="Extension.valueString">
      <path value="Extension.valueString"/> 
      <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.