This page is part of the Structured Data Capture FHIR IG (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

This is a pre-release of a future version of SDC (expected to be STU 2). The current version is STU 2.
For a full list of available versions, see the Directory of published versions .

9.3.8 Extension: Optional Display? - XML Profile

XML representation of the sdc-questionnaire-optionalDisplay Extension


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="sdc-questionnaire-optionalDisplay"/>
  <url
       value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"/>
  <name value="Optional Display?"/>
  <display value="Optional Display?"/>
  <status value="draft"/>
  <publisher
             value="Health Level Seven International (Orders and Observations - Structured Data Capture)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value
             value="http://wiki.siframework.org/Structured+Data+Capture+Initiative"/>
    </telecom>
  </contact>
  <date value="2014-04-21"/>
  <description
               value="If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user."/>
  <requirements
                value="Some "complex" questionnaires may have questions, sections or groups which are "non-essential" and can be safely skipped without a need for the user to even see them.  This is distinct from questions that don't need to be answered, but which must be shown to the user and the user must consciously choose to skip."/>
  <fhirVersion value="1.6.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="resource"/>
  <context value="Questionnaire.item"/>
  <context value="Questionnaire.item.item"/>
  <type value="Extension"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Extension:optionaldisplay">
      <path value="Extension"/>
      <name value="optionalDisplay"/>
      <short value="Extension"/>
      <definition
                  value="If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user."/>
      <comments
                value="If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional."/>
      <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="children().count() > id.count()"/>
        <xpath value="@value|f:*|h:div"/>
      </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')])"/>
      </constraint>
      <isModifier value="false"/>
    </element>
    <element id="Extension:optionaldisplay.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="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Extension:optionaldisplay.extension">
      <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="*"/>
      <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:optionaldisplay.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/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:optionaldisplay.valueBoolean">
      <path value="Extension.valueBoolean"/>
      <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="boolean"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Extension:optionaldisplay">
      <path value="Extension"/>
      <name value="optionalDisplay"/>
      <definition
                  value="If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user."/>
      <comments
                value="If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional."/>
      <min value="0"/>
      <max value="1"/>
      <isModifier value="false"/>
    </element>
    <element id="Extension:optionaldisplay.url">
      <path value="Extension.url"/>
      <fixedUri
                value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"/>
    </element>
    <element id="Extension:optionaldisplay.value[x]">
      <path value="Extension.value[x]"/>
      <type>
        <code value="boolean"/>
      </type>
    </element>
  </differential>
</StructureDefinition>