R6 Ballot (2nd Draft)

Publish-box (todo)

Example CodeSystem/item-type (JSON)

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

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

Definition for Code SystemQuestionnaireItemType

{
  "resourceType" : "CodeSystem",
  "id" : "item-type",
  "meta" : {
    "lastUpdated" : "2024-08-12T19:52:12.437+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem item-type</b></p><a name=\"item-type\"> </a><a name=\"hcitem-type\"> </a><a name=\"item-type-en-AU\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Last updated: 2021-01-05T10:01:24.148+11:00</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"shareablecodesystem.html\">Shareable CodeSystem</a></p></div><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>Not Selectable</td><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><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/item-type</code> defines the following codes in a Is-A hierarchy:</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\">\u00a0\u00a0boolean<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\">\u00a0\u00a0decimal<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/StructureDefinition/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\">\u00a0\u00a0integer<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/StructureDefinition/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\">\u00a0\u00a0date<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\">\u00a0\u00a0dateTime<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\">\u00a0\u00a0time<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\">\u00a0\u00a0string<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\">\u00a0\u00a0text<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\">\u00a0\u00a0url<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\">\u00a0\u00a0coding<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\">\u00a0\u00a0attachment<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\">\u00a0\u00a0reference<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\">\u00a0\u00a0quantity<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>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  }],
  "url" : "http://hl7.org/fhir/item-type",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.445"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.438"
  }],
  "version" : "6.0.0-ballot2",
  "name" : "QuestionnaireItemType",
  "title" : "Questionnaire Item Type",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Distinguishes groups from questions and display text and indicates data type for questions.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/item-type",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "property" : [{
    "code" : "notSelectable",
    "uri" : "http://hl7.org/fhir/concept-properties#notSelectable",
    "description" : "Indicates that the code is abstract - only intended to be used as a selector for other concepts",
    "type" : "boolean"
  }],
  "concept" : [{
    "code" : "group",
    "display" : "Group",
    "definition" : "An item with no direct answer but should have at least one child item."
  },
  {
    "code" : "display",
    "display" : "Display",
    "definition" : "Text for display that will not capture an answer or have child items."
  },
  {
    "code" : "question",
    "display" : "Question",
    "definition" : "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" : "notSelectable",
      "valueBoolean" : true
    }],
    "concept" : [{
      "code" : "boolean",
      "display" : "Boolean",
      "definition" : "Question with a yes/no answer (valueBoolean)."
    },
    {
      "code" : "decimal",
      "display" : "Decimal",
      "definition" : "Question with is a real number answer (valueDecimal).  There is an extension 'http://hl7.org/fhir/StructureDefinition/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."
    },
    {
      "code" : "integer",
      "display" : "Integer",
      "definition" : "Question with an integer answer (valueInteger).  There is an extension 'http://hl7.org/fhir/StructureDefinition/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."
    },
    {
      "code" : "date",
      "display" : "Date",
      "definition" : "Question with a date answer (valueDate)."
    },
    {
      "code" : "dateTime",
      "display" : "Date Time",
      "definition" : "Question with a date and time answer (valueDateTime)."
    },
    {
      "code" : "time",
      "display" : "Time",
      "definition" : "Question with a time (hour:minute:second) answer independent of date. (valueTime)."
    },
    {
      "code" : "string",
      "display" : "String",
      "definition" : "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."
    },
    {
      "code" : "text",
      "display" : "Text",
      "definition" : "Question with a long (potentially multi-paragraph) free-text entry answer (valueString)."
    },
    {
      "code" : "url",
      "display" : "Url",
      "definition" : "Question with a URL (website, FTP site, etc.) answer (valueUri)."
    },
    {
      "code" : "coding",
      "display" : "Coding",
      "definition" : "Question with a Coding - generally drawn from a list of possible answers (valueCoding)"
    },
    {
      "code" : "attachment",
      "display" : "Attachment",
      "definition" : "Question with binary content such as an image, PDF, etc. as an answer (valueAttachment)."
    },
    {
      "code" : "reference",
      "display" : "Reference",
      "definition" : "Question with a reference to another resource (practitioner, organization, etc.) as an answer (valueReference)."
    },
    {
      "code" : "quantity",
      "display" : "Quantity",
      "definition" : "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."
    }]
  }]
}

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.