This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
itemControl
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="questionnaire-itemControl"/> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="1"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.4.642.5.1239"/> </identifier> <version value="5.0.0-ballot"/> <name value="itemControl"/> <status value="draft"/> <experimental value="false"/> <date value="2013-07-04"/> <publisher value="HL7"/> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org"/> </telecom> </contact> <description value="The type of data entry control or structure that should be used to render the item. Certain item controls only make sense for certain types of items. For example, a radio button doesn't make sense for a question where repeats=true; few systems will know how to implement a 'slider' control if the question type is 'Attachment', etc. Form fillers are allowed to ignore item controls that don't make sense (or that they don't know how to handle) for the type of item the extension appears on. If the extension is ignored, the form filler will use whatever display control it supports that works best for the type of item present. Similarly, form authoring tools may raise validation issues or prohibit the selection of certain control types based on the characteristics of the item."/> <fhirVersion value="5.0.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <context> <type value="element"/> <expression value="Questionnaire.item"/> </context> <context> <type value="element"/> <expression value="ElementDefinition"/> </context> <type value="Extension"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> <derivation value="constraint"/> <snapshot> <element id="Extension"> <path value="Extension"/> <short value="E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc."/> <definition value="The type of data entry control or structure that should be used to render the item."/> <comment value="Different controls may be appropriate for different item types. It is up to the system rendering a questionnaire as to what controls it will support and for which data types. See additional guidance and examples in the [SDC implementation guide](http://build.fhir.org/ig/HL7 /sdc/rendering.html#itemControl)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/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="http://hl7.org/fhir/StructureDefinition/Extension"/> </constraint> <isModifier value="false"/> </element> <element id="Extension.id"> <path value="Extension.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <isModifier value="false"/> <isSummary value="false"/> <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="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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/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="http://hl7.org/fhir/StructureDefinition/Extension"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> </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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="uri"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]"/> <short value="Value of extension"/> <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensi bility.html) for a list)."/> <requirements value="The data type is CodeableConcept to allow for additional codings that might provide finer-grained control information or specification of specific controls in different rendering environments. CodeableConcept.text is generally unnecessary for this element and should not be sent alone as the use-case for this element is for computable interpretation by rendering engines."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ItemControl"/> </extension> <strength value="extensible"/> <description value="User interface controls or widgets used for questionnaire items."/> <valueSet value="http://hl7.org/fhir/ValueSet/questionnaire-item-control"/> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> </snapshot> <differential> <element id="Extension"> <path value="Extension"/> <short value="E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc."/> <definition value="The type of data entry control or structure that should be used to render the item."/> <comment value="Different controls may be appropriate for different item types. It is up to the system rendering a questionnaire as to what controls it will support and for which data types. See additional guidance and examples in the [SDC implementation guide](http://build.fhir.org/ig/HL7 /sdc/rendering.html#itemControl)."/> <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"/> <fixedUri value="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"/> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]"/> <requirements value="The data type is CodeableConcept to allow for additional codings that might provide finer-grained control information or specification of specific controls in different rendering environments. CodeableConcept.text is generally unnecessary for this element and should not be sent alone as the use-case for this element is for computable interpretation by rendering engines."/> <min value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ItemControl"/> </extension> <strength value="extensible"/> <description value="User interface controls or widgets used for questionnaire items."/> <valueSet value="http://hl7.org/fhir/ValueSet/questionnaire-item-control"/> </binding> </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.