Release 5 Ballot

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: R5 R4B R4 R3

Example CodeSystem/item-type (XML)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code SystemQuestionnaireItemType

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="item-type"/> 
  <meta> 
    <lastUpdated value="2022-09-07T11:58:29.429+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> 
        <b> Properties</b> 
      </p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> URL</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Description</b> 
          </td> 
        </tr> 
        <tr> 
          <td> notSelectable</td> 
          <td> http://hl7.org/fhir/concept-properties#notSelectable</td> 
          <td> boolean</td> 
          <td> Indicates that the code is abstract - only intended to be used as a selector for other
             concepts</td> 
        </tr> 
      </table> 
      <p> This code system 
        <code> http://hl7.org/fhir/item-type</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td> 
            <b> Lvl</b> 
          </td> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
          <td> 
            <b> Not Selectable</b> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">group
            <a name="item-type-group"> </a> 
          </td> 
          <td> Group</td> 
          <td> An item with no direct answer but should have at least one child item.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">display
            <a name="item-type-display"> </a> 
          </td> 
          <td> Display</td> 
          <td> Text for display that will not capture an answer or have child items.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">question
            <a name="item-type-question"> </a> 
          </td> 
          <td> Question</td> 
          <td> An item that defines a specific answer to be captured, and which may have child items.
             (the answer provided in the QuestionnaireResponse should be of the defined datatype).</td> 
          <td> true</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  boolean
            <a name="item-type-boolean"> </a> 
          </td> 
          <td> Boolean</td> 
          <td> Question with a yes/no answer (valueBoolean).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  decimal
            <a name="item-type-decimal"> </a> 
          </td> 
          <td> Decimal</td> 
          <td> Question with is a real number answer (valueDecimal).  There is an extension 'http://hl7.org/fhir/St
            ructureDefinition/questionnaire-unit' that can be used to computably convey the unit of
             measure associated with the answer for use when performing data extraction to an element
             of type Quantity.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  integer
            <a name="item-type-integer"> </a> 
          </td> 
          <td> Integer</td> 
          <td> Question with an integer answer (valueInteger).  There is an extension 'http://hl7.org/fhir/Structur
            eDefinition/questionnaire-unit' that can be used to computably convey the unit of measure
             associated with the answer for use when performing data extraction to an element of type
             Quantity.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  date
            <a name="item-type-date"> </a> 
          </td> 
          <td> Date</td> 
          <td> Question with a date answer (valueDate).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  dateTime
            <a name="item-type-dateTime"> </a> 
          </td> 
          <td> Date Time</td> 
          <td> Question with a date and time answer (valueDateTime).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  time
            <a name="item-type-time"> </a> 
          </td> 
          <td> Time</td> 
          <td> Question with a time (hour:minute:second) answer independent of date. (valueTime).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  string
            <a name="item-type-string"> </a> 
          </td> 
          <td> String</td> 
          <td> Question with a short (few words to short sentence) free-text entry answer (valueString).
              Strings SHOULD NOT contain carriage return or newline characters.  If multi-line answers
             are needed, use the 'text' type.</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  text
            <a name="item-type-text"> </a> 
          </td> 
          <td> Text</td> 
          <td> Question with a long (potentially multi-paragraph) free-text entry answer (valueString).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  url
            <a name="item-type-url"> </a> 
          </td> 
          <td> Url</td> 
          <td> Question with a URL (website, FTP site, etc.) answer (valueUri).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  coding
            <a name="item-type-coding"> </a> 
          </td> 
          <td> Coding</td> 
          <td> Question with a Coding - generally drawn from a list of possible answers (valueCoding)</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  attachment
            <a name="item-type-attachment"> </a> 
          </td> 
          <td> Attachment</td> 
          <td> Question with binary content such as an image, PDF, etc. as an answer (valueAttachment).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  reference
            <a name="item-type-reference"> </a> 
          </td> 
          <td> Reference</td> 
          <td> Question with a reference to another resource (practitioner, organization, etc.) as an
             answer (valueReference).</td> 
          <td/>  
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  quantity
            <a name="item-type-quantity"> </a> 
          </td> 
          <td> Quantity</td> 
          <td> Question with a combination of a numeric value and unit as an answer. (valueSimpleQuantity)
              There are two extensions ('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption'
             and 'http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet')  that can be
             used to define what unit should be selected for the Quantity.code and Quantity.system.</td> 
          <td/>  
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <url value="http://hl7.org/fhir/item-type"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.445"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="QuestionnaireItemType"/> 
  <title value="QuestionnaireItemType"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Distinguishes groups from questions and display text and indicates data type for questions."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/item-type"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <property> 
    <code value="notSelectable"/> 
    <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/> 
    <description value="Indicates that the code is abstract - only intended to be used as a selector for other
     concepts"/> 
    <type value="boolean"/> 
  </property> 
  <concept> 
    <code value="group"/> 
    <display value="Group"/> 
    <definition value="An item with no direct answer but should have at least one child item."/> 
  </concept> 
  <concept> 
    <code value="display"/> 
    <display value="Display"/> 
    <definition value="Text for display that will not capture an answer or have child items."/> 
  </concept> 
  <concept> 
    <code value="question"/> 
    <display value="Question"/> 
    <definition value="An item that defines a specific answer to be captured, and which may have child items.
     (the answer provided in the QuestionnaireResponse should be of the defined datatype)."/> 
    <property> 
      <code value="notSelectable"/> 
      <valueBoolean value="true"/> 
    </property> 
    <concept> 
      <code value="boolean"/> 
      <display value="Boolean"/> 
      <definition value="Question with a yes/no answer (valueBoolean)."/> 
    </concept> 
    <concept> 
      <code value="decimal"/> 
      <display value="Decimal"/> 
      <definition value="Question with is a real number answer (valueDecimal).  There is an extension 'http://hl7.org/fhir/St
      ructureDefinition/questionnaire-unit' that can be used to computably convey the unit of
       measure associated with the answer for use when performing data extraction to an element
       of type Quantity."/> 
    </concept> 
    <concept> 
      <code value="integer"/> 
      <display value="Integer"/> 
      <definition value="Question with an integer answer (valueInteger).  There is an extension 'http://hl7.org/fhir/Structur
      eDefinition/questionnaire-unit' that can be used to computably convey the unit of measure
       associated with the answer for use when performing data extraction to an element of type
       Quantity."/> 
    </concept> 
    <concept> 
      <code value="date"/> 
      <display value="Date"/> 
      <definition value="Question with a date answer (valueDate)."/> 
    </concept> 
    <concept> 
      <code value="dateTime"/> 
      <display value="Date Time"/> 
      <definition value="Question with a date and time answer (valueDateTime)."/> 
    </concept> 
    <concept> 
      <code value="time"/> 
      <display value="Time"/> 
      <definition value="Question with a time (hour:minute:second) answer independent of date. (valueTime)."/> 
    </concept> 
    <concept> 
      <code value="string"/> 
      <display value="String"/> 
      <definition value="Question with a short (few words to short sentence) free-text entry answer (valueString).
        Strings SHOULD NOT contain carriage return or newline characters.  If multi-line answers
       are needed, use the 'text' type."/> 
    </concept> 
    <concept> 
      <code value="text"/> 
      <display value="Text"/> 
      <definition value="Question with a long (potentially multi-paragraph) free-text entry answer (valueString)."/> 
    </concept> 
    <concept> 
      <code value="url"/> 
      <display value="Url"/> 
      <definition value="Question with a URL (website, FTP site, etc.) answer (valueUri)."/> 
    </concept> 
    <concept> 
      <code value="coding"/> 
      <display value="Coding"/> 
      <definition value="Question with a Coding - generally drawn from a list of possible answers (valueCoding)"/> 
    </concept> 
    <concept> 
      <code value="attachment"/> 
      <display value="Attachment"/> 
      <definition value="Question with binary content such as an image, PDF, etc. as an answer (valueAttachment)."/> 
    </concept> 
    <concept> 
      <code value="reference"/> 
      <display value="Reference"/> 
      <definition value="Question with a reference to another resource (practitioner, organization, etc.) as an
       answer (valueReference)."/> 
    </concept> 
    <concept> 
      <code value="quantity"/> 
      <display value="Quantity"/> 
      <definition value="Question with a combination of a numeric value and unit as an answer. (valueSimpleQuantity)
        There are two extensions ('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption'
       and 'http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet')  that can be
       used to define what unit should be selected for the Quantity.code and Quantity.system."/> 
    </concept> 
  </concept> 
</CodeSystem> 

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.