FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

Codesystem-item-type.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

Definition for Code System QuestionnaireItemType

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="item-type"/> 
  <meta> 
    <lastUpdated value="2019-10-24T11:53:00+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> QuestionnaireItemType</h2> 
      <div> 
        <p> Distinguishes groups from questions and display text and indicates data type for questions</p> 

      </div> 
      <p> 
        <b> Properties</b> 
      </p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> URL</b> 
          </td> 
          <td> 
            <b> Description</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
        </tr> 
        <tr> 
          <td> notSelectable</td> 
          <td> http://hl7.org/fhir/concept-properties#notSelectable</td> 
          <td> Indicates that the code is abstract - only intended to be used as a selector for other
             concepts</td> 
          <td> boolean</td> 
        </tr> 
      </table> 
      <p> This code system http://hl7.org/fhir/item-type defines the following codes:</p> 
      <table class="codes">
        <tr> 
          <td> 
            <b> Lvl</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td> 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> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td> 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> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td> question
            <a name="item-type-question"> </a> 
          </td> 
          <td> Question</td> 
          <td> An item that defines a specific answer to be captured, and may have child items.
(the answer provided in the QuestionnaireResponse should be of the defined datatype)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   boolean
            <a name="item-type-boolean"> </a> 
          </td> 
          <td> Boolean</td> 
          <td> Question with a yes/no answer (valueBoolean)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   decimal
            <a name="item-type-decimal"> </a> 
          </td> 
          <td> Decimal</td> 
          <td> Question with is a real number answer (valueDecimal)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   integer
            <a name="item-type-integer"> </a> 
          </td> 
          <td> Integer</td> 
          <td> Question with an integer answer (valueInteger)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   date
            <a name="item-type-date"> </a> 
          </td> 
          <td> Date</td> 
          <td> Question with a date answer (valueDate)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   dateTime
            <a name="item-type-dateTime"> </a> 
          </td> 
          <td> Date Time</td> 
          <td> Question with a date and time answer (valueDateTime)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   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> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   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)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   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> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   url
            <a name="item-type-url"> </a> 
          </td> 
          <td> Url</td> 
          <td> Question with a URL (website, FTP site, etc.) answer (valueUri)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   choice
            <a name="item-type-choice"> </a> 
          </td> 
          <td> Choice</td> 
          <td> Question with a Coding drawn from a list of options (specified in either the option property,
             or via the valueset referenced in the options property) as an answer (valueCoding)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   open-choice
            <a name="item-type-open-choice"> </a> 
          </td> 
          <td> Open Choice</td> 
          <td> Answer is a Coding drawn from a list of options (as with the choice type) or a free-text
             entry in a string (valueCoding or valueString)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   attachment
            <a name="item-type-attachment"> </a> 
          </td> 
          <td> Attachment</td> 
          <td> Question with binary content such as a image, PDF, etc. as an answer (valueAttachment)</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   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> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td>   quantity
            <a name="item-type-quantity"> </a> 
          </td> 
          <td> Quantity</td> 
          <td> Question with a combination of a numeric value and unit, potentially with a comparator
             (&lt;, &gt;, etc.) as an answer. (valueQuantity)
There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that
             can be used to define what unit whould be captured (or the a unit that has a ucum conversion
             from the provided unit)</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="Informative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </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.1.438"/> 
  </identifier> 
  <version value="3.0.2"/> 
  <name value="QuestionnaireItemType"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2019-10-24T11:53:00+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"/> 
  <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 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)"/> 
    </concept> 
    <concept> 
      <code value="integer"/> 
      <display value="Integer"/> 
      <definition value="Question with an integer answer (valueInteger)"/> 
    </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)"/> 
    </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="choice"/> 
      <display value="Choice"/> 
      <definition value="Question with a Coding drawn from a list of options (specified in either the option property,
       or via the valueset referenced in the options property) as an answer (valueCoding)"/> 
    </concept> 
    <concept> 
      <code value="open-choice"/> 
      <display value="Open Choice"/> 
      <definition value="Answer is a Coding drawn from a list of options (as with the choice type) or a free-text
       entry in a string (valueCoding or valueString)"/> 
    </concept> 
    <concept> 
      <code value="attachment"/> 
      <display value="Attachment"/> 
      <definition value="Question with binary content such as a 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, potentially with a comparator
       (&lt;, &gt;, etc.) as an answer. (valueQuantity)
There is an extension 'http://hl7.org/fhir/StructureDefinition/questionnaire-unit' that
       can be used to define what unit whould be captured (or the a unit that has a ucum conversion
       from the provided unit)"/> 
    </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.