STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: R4B R4 R3 R2

Extension-elementdefinition-question.xml

Raw XML (canonical form)

Prompt for element phrased as question

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="elementdefinition-question"/>
  <url value="http://hl7.org/fhir/StructureDefinition/elementdefinition-question"/>
  <name value="Prompt for element phrased as question"/>
  <status value="draft"/>
  <publisher value="Health Level Seven, Inc. - FHIR Core WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/special/committees/FHIR"/>
    </telecom>
  </contact>
  <date value="2015-02-28"/>
  <description value="The default/suggested phrasing to use when prompting a human to capture the data element
   in question form (e.g. In a survey)."/>
  <fhirVersion value="1.8.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="complex-type"/>
  <abstract value="false"/>
  <contextType value="datatype"/>
  <context value="ElementDefinition"/>
  <type value="Extension"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Extension:promptforelementphrasedasquestion">
      <path value="Extension"/>
      <short value="Prompt for element phrased as question"/>
      <definition value="The default/suggested phrasing to use when prompting a human to capture the data element
       in question form (e.g. In a survey)."/>
      <comments value="Question and label serve similar purposes in they both can be used to prompt for capturing
       a data element.  Whether the question form or label form should be used will depend on
       the type of instrument being used to capture the information.  The ordering is in order
       of preference.  I.e. Most preferred question form is listed first.  Note that this is
       for alternate phrasings of the question.  Language translations are handled using the
       ISO 21090 string translation extensions."/>
      <min value="0"/>
      <max value="*"/>
      <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="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>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (MIF-level)"/>
      </mapping>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.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:promptforelementphrasedasquestion.extension:extension">
      <path value="Extension.extension"/>
      <sliceName value="extension"/>
      <short value="Extension"/>
      <definition value="An Extension"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.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."/>
      <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 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/elementdefinition-question"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.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="1"/>
      <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:promptforelementphrasedasquestion">
      <path value="Extension"/>
      <short value="Prompt for element phrased as question"/>
      <definition value="The default/suggested phrasing to use when prompting a human to capture the data element
       in question form (e.g. In a survey)."/>
      <comments value="Question and label serve similar purposes in they both can be used to prompt for capturing
       a data element.  Whether the question form or label form should be used will depend on
       the type of instrument being used to capture the information.  The ordering is in order
       of preference.  I.e. Most preferred question form is listed first.  Note that this is
       for alternate phrasings of the question.  Language translations are handled using the
       ISO 21090 string translation extensions."/>
      <min value="0"/>
      <max value="*"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (MIF-level)"/>
      </mapping>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.extension:extension">
      <path value="Extension.extension"/>
      <sliceName value="extension"/>
      <max value="0"/>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.url">
      <path value="Extension.url"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/elementdefinition-question"/>
    </element>
    <element id="Extension:promptforelementphrasedasquestion.value[x]">
      <path value="Extension.value[x]"/>
      <min value="1"/>
      <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.