Questionnaire - FHIR Resource (r4)

This Questionnaire Resource uses the FHIR API standard for access and structure.

Validate an Questionnaire FHIR Resource (r4)

Questionnaire Attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this questionnaire, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://hl7.org/fhir/Questionnaire/3141"

Learn more about the (Questionnaire) url FHIR attribute

Description: Additional identifier for the questionnaire

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (Questionnaire) identifier FHIR attribute

Description: Business version of the questionnaire

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version":

Learn more about the (Questionnaire) version FHIR attribute

Description: C? Name for this questionnaire (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name":

Learn more about the (Questionnaire) name FHIR attribute

Description: Name for this questionnaire (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title": "Cancer Quality Forum Questionnaire 2012"

Learn more about the (Questionnaire) title FHIR attribute

Description: Instantiates protocol or definition

FHIR Version: r4

Attribute Type : canonical(Questionnaire)

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"derivedFrom":

Learn more about the (Questionnaire) derivedFrom FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (Questionnaire) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental":

Learn more about the (Questionnaire) experimental FHIR attribute

Description: Resource that can be subject of QuestionnaireResponse

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subjectType": [
  "Patient"
]

Learn more about the (Questionnaire) subjectType FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2012-01"

Learn more about the (Questionnaire) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher":

Learn more about the (Questionnaire) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact":

Learn more about the (Questionnaire) contact FHIR attribute

Description: Natural language description of the questionnaire

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (Questionnaire) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (Questionnaire) useContext FHIR attribute

Description: Intended jurisdiction for questionnaire (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction":

Learn more about the (Questionnaire) jurisdiction FHIR attribute

Description: Why this questionnaire is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (Questionnaire) purpose FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (Questionnaire) copyright FHIR attribute

Description: When the questionnaire was approved by publisher

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"approvalDate":

Learn more about the (Questionnaire) approvalDate FHIR attribute

Description: When the questionnaire was last reviewed

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lastReviewDate":

Learn more about the (Questionnaire) lastReviewDate FHIR attribute

Description: When the questionnaire is expected to be used

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"effectivePeriod":

Learn more about the (Questionnaire) effectivePeriod FHIR attribute

Description: Concept that represents the overall questionnaire

FHIR Version: r4

Attribute Type : Coding

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code":

Learn more about the (Questionnaire) code FHIR attribute

Description: C? Questions and sections within the Questionnaire

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"item": [
  {
    "linkId": "1",
    "code": [
      {
        "system": "http://example.org/system/code/sections",
        "code": "COMORBIDITY"
      }
    ],
    "type": "group",
    "item": [
      {
        "linkId": "1.1",
        "code": [
          {
            "system": "http://example.org/system/code/questions",
            "code": "COMORB"
          }
        ],
        "prefix": "1",
        "type": "choice",
        "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow",
        "item": [
          {
            "linkId": "1.1.1",
            "code": [
              {
                "system": "http://example.org/system/code/sections",
                "code": "CARDIAL"
              }
            ],
            "type": "group",
            "enableWhen": [
              {
                "question": "1.1",
                "operator": "=",
                "answerCoding": {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0136",
                  "code": "Y"
                }
              }
            ],
            "item": [
              {
                "linkId": "1.1.1.1",
                "code": [
                  {
                    "system": "http://example.org/system/code/questions",
                    "code": "COMORBCAR"
                  }
                ],
                "prefix": "1.1",
                "type": "choice",
                "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow",
                "item": [
                  {
                    "linkId": "1.1.1.1.1",
                    "code": [
                      {
                        "system": "http://example.org/system/code/questions",
                        "code": "COMCAR00",
                        "display": "Angina Pectoris"
                      },
                      {
                        "system": "http://snomed.info/sct",
                        "code": "194828000",
                        "display": "Angina (disorder)"
                      }
                    ],
                    "prefix": "1.1.1",
                    "type": "choice",
                    "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                  },
                  {
                    "linkId": "1.1.1.1.2",
                    "code": [
                      {
                        "system": "http://snomed.info/sct",
                        "code": "22298006",
                        "display": "Myocardial infarction (disorder)"
                      }
                    ],
                    "prefix": "1.1.2",
                    "type": "choice",
                    "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                  }
                ]
              },
              {
                "linkId": "1.1.1.2",
                "code": [
                  {
                    "system": "http://example.org/system/code/questions",
                    "code": "COMORBVAS"
                  }
                ],
                "prefix": "1.2",
                "type": "choice",
                "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "linkId": "2",
    "code": [
      {
        "system": "http://example.org/system/code/sections",
        "code": "HISTOPATHOLOGY"
      }
    ],
    "type": "group",
    "item": [
      {
        "linkId": "2.1",
        "code": [
          {
            "system": "http://example.org/system/code/sections",
            "code": "ABDOMINAL"
          }
        ],
        "type": "group",
        "item": [
          {
            "linkId": "2.1.2",
            "code": [
              {
                "system": "http://example.org/system/code/questions",
                "code": "STADPT",
                "display": "pT category"
              }
            ],
            "type": "choice"
          }
        ]
      }
    ]
  }
]

Learn more about the (Questionnaire) item FHIR attribute

Questionnaire Example

{
  "resourceType": "Questionnaire",
  "id": "3141",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <pre>\n            1.Comorbidity?\n              1.1 Cardial Comorbidity\n                1.1.1 Angina?\n                1.1.2 MI?\n              1.2 Vascular Comorbidity?\n              ...\n            Histopathology\n              Abdominal\n                pT category?\n              ...\n          </pre>\n    </div>"
  },
  "url": "http://hl7.org/fhir/Questionnaire/3141",
  "title": "Cancer Quality Forum Questionnaire 2012",
  "status": "draft",
  "subjectType": [
    "Patient"
  ],
  "date": "2012-01",
  "item": [
    {
      "linkId": "1",
      "code": [
        {
          "system": "http://example.org/system/code/sections",
          "code": "COMORBIDITY"
        }
      ],
      "type": "group",
      "item": [
        {
          "linkId": "1.1",
          "code": [
            {
              "system": "http://example.org/system/code/questions",
              "code": "COMORB"
            }
          ],
          "prefix": "1",
          "type": "choice",
          "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow",
          "item": [
            {
              "linkId": "1.1.1",
              "code": [
                {
                  "system": "http://example.org/system/code/sections",
                  "code": "CARDIAL"
                }
              ],
              "type": "group",
              "enableWhen": [
                {
                  "question": "1.1",
                  "operator": "=",
                  "answerCoding": {
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0136",
                    "code": "Y"
                  }
                }
              ],
              "item": [
                {
                  "linkId": "1.1.1.1",
                  "code": [
                    {
                      "system": "http://example.org/system/code/questions",
                      "code": "COMORBCAR"
                    }
                  ],
                  "prefix": "1.1",
                  "type": "choice",
                  "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow",
                  "item": [
                    {
                      "linkId": "1.1.1.1.1",
                      "code": [
                        {
                          "system": "http://example.org/system/code/questions",
                          "code": "COMCAR00",
                          "display": "Angina Pectoris"
                        },
                        {
                          "system": "http://snomed.info/sct",
                          "code": "194828000",
                          "display": "Angina (disorder)"
                        }
                      ],
                      "prefix": "1.1.1",
                      "type": "choice",
                      "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                    },
                    {
                      "linkId": "1.1.1.1.2",
                      "code": [
                        {
                          "system": "http://snomed.info/sct",
                          "code": "22298006",
                          "display": "Myocardial infarction (disorder)"
                        }
                      ],
                      "prefix": "1.1.2",
                      "type": "choice",
                      "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                    }
                  ]
                },
                {
                  "linkId": "1.1.1.2",
                  "code": [
                    {
                      "system": "http://example.org/system/code/questions",
                      "code": "COMORBVAS"
                    }
                  ],
                  "prefix": "1.2",
                  "type": "choice",
                  "answerValueSet": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "linkId": "2",
      "code": [
        {
          "system": "http://example.org/system/code/sections",
          "code": "HISTOPATHOLOGY"
        }
      ],
      "type": "group",
      "item": [
        {
          "linkId": "2.1",
          "code": [
            {
              "system": "http://example.org/system/code/sections",
              "code": "ABDOMINAL"
            }
          ],
          "type": "group",
          "item": [
            {
              "linkId": "2.1.2",
              "code": [
                {
                  "system": "http://example.org/system/code/questions",
                  "code": "STADPT",
                  "display": "pT category"
                }
              ],
              "type": "choice"
            }
          ]
        }
      ]
    }
  ]
}

Questionnaire Structure

{
  "resourceType" : "Questionnaire",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this questionnaire, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the questionnaire
  "version" : "<string>", // Business version of the questionnaire
  "name" : "<string>", // C? Name for this questionnaire (computer friendly)
  "title" : "<string>", // Name for this questionnaire (human friendly)
  "derivedFrom" : [{ canonical(Questionnaire) }], // Instantiates protocol or definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the questionnaire
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for questionnaire (if applicable)
  "purpose" : "<markdown>", // Why this questionnaire is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the questionnaire was approved by publisher
  "lastReviewDate" : "<date>", // When the questionnaire was last reviewed
  "effectivePeriod" : { Period }, // When the questionnaire is expected to be used
  "code" : [{ Coding }], // Concept that represents the overall questionnaire
  "item" : [{ // C? Questions and sections within the Questionnaire
    "linkId" : "<string>", // R!  Unique id for item in questionnaire
    "definition" : "<uri>", // ElementDefinition - details for the item
    "code" : [{ Coding }], // C? Corresponding concept for this item in a terminology
    "prefix" : "<string>", // E.g. "1(a)", "2.5.3"
    "text" : "<string>", // Primary text for the item
    "type" : "<code>", // R!  group | display | boolean | decimal | integer | date | dateTime +
    "enableWhen" : [{ // Only allow data when
      "question" : "<string>", // R!  Question that determines whether item is enabled
      "operator" : "<code>", // R!  exists | = | != | > | < | >= | <=
      // answer[x]: Value for question comparison based on operator. One of these 10:
      "answerBoolean" : <boolean>
      "answerDecimal" : <decimal>
      "answerInteger" : <integer>
      "answerDate" : "<date>"
      "answerDateTime" : "<dateTime>"
      "answerTime" : "<time>"
      "answerString" : "<string>"
      "answerCoding" : { Coding }
      "answerQuantity" : { Quantity }
      "answerReference" : { Reference(Any) }
    }],
    "enableBehavior" : "<code>", // C? all | any
    "required" : <boolean>, // C? Whether the item must be included in data results
    "repeats" : <boolean>, // C? Whether the item may repeat
    "readOnly" : <boolean>, // C? Don't allow human editing
    "maxLength" : <integer>, // C? No more than this many characters
    "answerValueSet" : { canonical(ValueSet) }, // C? Valueset containing permitted answers
    "answerOption" : [{ // C? Permitted answer
      // value[x]: Answer value. One of these 6:
      "valueInteger" : <integer>,
      "valueDate" : "<date>",
      "valueTime" : "<time>",
      "valueString" : "<string>",
      "valueCoding" : { Coding },
      "valueReference" : { Reference(Any) },
      "initialSelected" : <boolean> // Whether option is selected by default
    }],
    "initial" : [{ // C? Initial value(s) when item is first rendered
      // value[x]: Actual value for initializing the question. One of these 12:
      "valueBoolean" : <boolean>
      "valueDecimal" : <decimal>
      "valueInteger" : <integer>
      "valueDate" : "<date>"
      "valueDateTime" : "<dateTime>"
      "valueTime" : "<time>"
      "valueString" : "<string>"
      "valueUri" : "<uri>"
      "valueAttachment" : { Attachment }
      "valueCoding" : { Coding }
      "valueQuantity" : { Quantity }
      "valueReference" : { Reference(Any) }
    }],
    "item" : [{ Content as for Questionnaire.item }] // C? Nested questionnaire items
  }]
}

Questionnaire Search Parameters

The following search parameters can be used to query Questionnaire resources. Just submit them like so:

https://api.1up.health/fhir/r4/Questionnaire?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`code`	`text`	`item.code`
`context`	`text`	`useContext.value`
`context-quantity`	`quantity`	`useContext.value`
`context-type`	`text`	`useContext.code`
`context-type-quantity`	`composite`	`useContext`
`context-type-value`	`composite`	`useContext`
`date`	`date`	`date`
`definition`	`uri`	`item.definition`
`description`	`text`	`description`
`effective`	`date`	`effectivePeriod`
`identifier`	`text`	`identifier`
`jurisdiction`	`text`	`jurisdiction`
`name`	`text`	`name`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`subject-type`	`text`	`subjectType`
`title`	`text`	`title`
`url`	`uri`	`url`
`version`	`text`	`version`