2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Questionnaire.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for Questionnaire

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "publisher": "HL7 FHIR Project (Patient Care)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions."
      }
    ],
    "linkId": "Questionnaire",
    "title": "A structured set of questions",
    "required": true,
    "repeats": false,
    "group": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Questionnaire.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.id.value",
            "text": "Logical id of this artefact",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."
          }
        ],
        "linkId": "Questionnaire.meta",
        "text": "Metadata about the resource",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "uri"
          }
        ],
        "linkId": "Questionnaire.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.implicitRules.value",
            "text": "A set of rules under which this content was created",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "Questionnaire.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.language.value",
            "text": "language",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
          }
        ],
        "linkId": "Questionnaire.text",
        "text": "Text summary of the resource, for human interpretation",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."
          }
        ],
        "linkId": "Questionnaire.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "This records identifiers associated with this question set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "Questionnaire.identifier",
        "text": "External Ids for this questionnaire",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.identifier.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Questionnaire.identifier.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Questionnaire.identifier.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The version number assigned by the publisher for business reasons.  It may remain the same when the resource is updated."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Questionnaire.version",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.version.value",
            "text": "Logical id for this version of Questionnaire",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The lifecycle status of the questionnaire as a whole."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "Questionnaire.status",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.status.value",
            "text": "status",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The date that this questionnaire was last changed."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "datetime"
          }
        ],
        "linkId": "Questionnaire.date",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.date.value",
            "text": "Date this version was authored",
            "type": "dateTime",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Organization or person responsible for developing and maintaining the questionnaire."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Questionnaire.publisher",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.publisher.value",
            "text": "Organization/individual who designed the questionnaire",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Contact details to assist a user in finding and communicating with the publisher."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "ContactPoint"
          }
        ],
        "linkId": "Questionnaire.telecom",
        "text": "Contact information of the publisher",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Questionnaire.telecom.system",
            "text": "type:",
            "type": "choice",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Questionnaire.telecom.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Questionnaire.telecom.use",
            "text": "use:",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A collection of related questions (or further groupings of questions)."
          }
        ],
        "linkId": "Questionnaire.group",
        "title": "Grouped questions",
        "text": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.  Information on this root group applies to the questionnaire as a whole.",
        "required": true,
        "repeats": false,
        "group": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "unique id for the element within a resource (for internal references)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "Questionnaire.group.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.id.value",
                "text": "xml:id (or equivalent in JSON)",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireAnswers resource. May be omitted if there is no expectation to link answers back to a questionnaire.  This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning.  GUIDs or sequential numbers are appropriate here."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "Questionnaire.group.linkId",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.linkId.value",
                "text": "To link questionnaire with questionnaire answers",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "The human-readable name for this section of the questionnaire. The title of the \"root\" group is the title for the questionnaire."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "Questionnaire.group.title",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.title.value",
                "text": "Name to be displayed for group",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Identifies a how this group of questions is known in a particular terminology such as LOINC. The code(s) for the \"root\" group apply to the questionnaire as a whole."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Coding"
              }
            ],
            "linkId": "Questionnaire.group.concept",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.concept.value",
                "text": "Concept that represents this section on a questionnaire",
                "type": "open-choice",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Additional text for the group, used for display purposes. Common extensions are defined for more specialized types of display text."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "Questionnaire.group.text",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.text.value",
                "text": "Additional text for the group",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "If true, indicates that the group must be present and have required questions within it answered.  If false, the group may be skipped when answering the questionnaire."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "boolean"
              }
            ],
            "linkId": "Questionnaire.group.required",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.required.value",
                "text": "Must group be included in data results?",
                "type": "boolean",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Whether the group may occur multiple times in the instance, containing multiple sets of answers."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "boolean"
              }
            ],
            "linkId": "Questionnaire.group.repeats",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Questionnaire.group.repeats.value",
                "text": "Whether the group may repeat",
                "type": "boolean",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "A sub-group within a group. The ordering of groups within this group is relevant."
              }
            ],
            "linkId": "Questionnaire.group.group",
            "title": "Nested questionnaire group",
            "required": false,
            "repeats": true
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Set of questions within this group. The order of questions within the group is relevant."
              }
            ],
            "linkId": "Questionnaire.group.question",
            "title": "Questions in this group",
            "required": false,
            "repeats": true,
            "group": [
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "unique id for the element within a resource (for internal references)."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "Questionnaire.group.question.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.id.value",
                    "text": "xml:id (or equivalent in JSON)",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireAnswers]]] resource. May be omitted if there is no expectation to link answers back to a questionnaire.  This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning.  GUIDs or sequential numbers are appropriate here."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "Questionnaire.group.question.linkId",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.linkId.value",
                    "text": "To link questionnaire with questionnaire answers",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Identifies a how this question is known in a particular terminology such as LOINC."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Coding"
                  }
                ],
                "linkId": "Questionnaire.group.question.concept",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.concept.value",
                    "text": "Concept that represents this question on a questionnaire",
                    "type": "open-choice",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "The actual question as shown to the user to prompt them for an answer. Common extensions are defined for more specialized types of display text."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "Questionnaire.group.question.text",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.text.value",
                    "text": "Text of the question as it is shown to the user",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected. Additional constraints on the type of answer can be conveyed by extensions."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "code"
                  }
                ],
                "linkId": "Questionnaire.group.question.type",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.type.value",
                    "text": "type",
                    "type": "choice",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "If true, indicates that the question must be answered and have required groups within it also present.  If false, the question and any contained groups may be skipped when answering the questionnaire."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "boolean"
                  }
                ],
                "linkId": "Questionnaire.group.question.required",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.required.value",
                    "text": "Must question be answered in data results?",
                    "type": "boolean",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "If true, the question may have more than one answer. Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "boolean"
                  }
                ],
                "linkId": "Questionnaire.group.question.repeats",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Questionnaire.group.question.repeats.value",
                    "text": "Can question  have multiple answers?",
                    "type": "boolean",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Reference to a valueset containing the possible options."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "Questionnaire.group.question.options",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/ValueSet?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "Questionnaire.group.question.options.value",
                    "text": "Valueset containing the possible options",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Nested group, containing nested question for this question. The order of groups within the question is relevant."
                  }
                ],
                "linkId": "Questionnaire.group.question.group",
                "title": "Nested questionnaire group",
                "required": false,
                "repeats": true
              }
            ]
          }
        ]
      }
    ]
  }
}

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.