Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Extension: itemControl

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl

Version: 5.0.0-ballot

Name: itemControl

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: 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.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

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.

Comment:

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.

Context of Use: Use on Element ID Questionnaire.item or Element ID ElementDefinition

Summary

Name	Flags	Card.	Type	Description & Constraints
itemControl		0..1	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl itemControl: 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. Binding: Questionnaire Item UI Control Codes (extensible): User interface controls or widgets used for questionnaire items. Use on Element ID Questionnaire.item or Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl itemControl: 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. Use on Element ID Questionnaire.item or Element ID ElementDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"
value[x]	1..1	CodeableConcept	Value of extension Binding: Questionnaire Item UI Control Codes (extensible): User interface controls or widgets used for questionnaire items.
Documentation for this format

XML Template

<!-- itemControl -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // itemControl
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", // R! 
    "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
itemControl		0..1	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl itemControl: 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. Binding: Questionnaire Item UI Control Codes (extensible): User interface controls or widgets used for questionnaire items. Use on Element ID Questionnaire.item or Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl itemControl: 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. Use on Element ID Questionnaire.item or Element ID ElementDefinition
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"
value[x]	1..1	CodeableConcept	Value of extension Binding: Questionnaire Item UI Control Codes (extensible): User interface controls or widgets used for questionnaire items.
Documentation for this format

XML Template

<!-- itemControl -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // itemControl
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl", // R! 
    "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.