Questionnaire - FHIR Resource (stu3)


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

Validate an Questionnaire FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate When the questionnaire was approved by publisher
codetrueCoding Concept that represents the overall questionnaire
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the questionnaire
effectivePeriodfalsePeriod When the questionnaire is expected to be used
experimentalfalseboolean For testing purposes, not real usage
identifiertrueIdentifier Additional identifier for the questionnaire
itemtrueData Type C? Questions and sections within the Questionnaire
jurisdictiontrueCodeableConcept Intended jurisdiction for questionnaire (if applicable)
lastReviewDatefalsedate When the questionnaire was last reviewed
namefalsestring Name for this questionnaire (computer friendly)
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this questionnaire is defined
statusfalsecode draft | active | retired | unknown
subjectTypetruecode Resource that can be subject of QuestionnaireResponse
titlefalsestring Name for this questionnaire (human friendly)
urlfalseuri Logical URI to reference this questionnaire (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the questionnaire

Questionnaire Example

{
  "status": "draft",
  "title": "Cancer Quality Forum Questionnaire 2012",
  "resourceType": "Questionnaire",
  "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>"
  },
  "subjectType": [
    "Patient"
  ],
  "url": "http://hl7.org/fhir/Questionnaire/3141",
  "item": [
    {
      "linkId": "1",
      "code": [
        {
          "code": "COMORBIDITY",
          "system": "http://example.org/system/code/sections"
        }
      ],
      "type": "group",
      "item": [
        {
          "code": [
            {
              "code": "COMORB",
              "system": "http://example.org/system/code/questions"
            }
          ],
          "linkId": "1.1",
          "item": [
            {
              "linkId": "1.1.1",
              "code": [
                {
                  "code": "CARDIAL",
                  "system": "http://example.org/system/code/sections"
                }
              ],
              "type": "group",
              "enableWhen": [
                {
                  "answerCoding": {
                    "code": "Y",
                    "system": "http://hl7.org/fhir/v2/0136"
                  },
                  "question": "1.1"
                }
              ],
              "item": [
                {
                  "code": [
                    {
                      "code": "COMORBCAR",
                      "system": "http://example.org/system/code/questions"
                    }
                  ],
                  "linkId": "1.1.1.1",
                  "item": [
                    {
                      "linkId": "1.1.1.1.1",
                      "prefix": "1.1.1",
                      "code": [
                        {
                          "code": "COMCAR00",
                          "system": "http://example.org/system/code/questions",
                          "display": "Angina Pectoris"
                        },
                        {
                          "code": "194828000",
                          "system": "http://snomed.info/sct",
                          "display": "Angina (disorder)"
                        }
                      ],
                      "type": "choice",
                      "options": {
                        "reference": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                      }
                    },
                    {
                      "linkId": "1.1.1.1.2",
                      "prefix": "1.1.2",
                      "code": [
                        {
                          "code": "22298006",
                          "system": "http://snomed.info/sct",
                          "display": "Myocardial infarction (disorder)"
                        }
                      ],
                      "type": "choice",
                      "options": {
                        "reference": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                      }
                    }
                  ],
                  "prefix": "1.1",
                  "type": "choice",
                  "options": {
                    "reference": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                  }
                },
                {
                  "linkId": "1.1.1.2",
                  "prefix": "1.2",
                  "code": [
                    {
                      "code": "COMORBVAS",
                      "system": "http://example.org/system/code/questions"
                    }
                  ],
                  "type": "choice",
                  "options": {
                    "reference": "http://hl7.org/fhir/ValueSet/yesnodontknow"
                  }
                }
              ]
            }
          ],
          "prefix": "1",
          "type": "choice",
          "options": {
            "reference": "http://hl7.org/fhir/ValueSet/yesnodontknow"
          }
        }
      ]
    },
    {
      "linkId": "2",
      "code": [
        {
          "code": "HISTOPATHOLOGY",
          "system": "http://example.org/system/code/sections"
        }
      ],
      "type": "group",
      "item": [
        {
          "linkId": "2.1",
          "code": [
            {
              "code": "ABDOMINAL",
              "system": "http://example.org/system/code/sections"
            }
          ],
          "type": "group",
          "item": [
            {
              "linkId": "2.1.2",
              "code": [
                {
                  "code": "STADPT",
                  "system": "http://example.org/system/code/questions",
                  "display": "pT category"
                }
              ],
              "type": "choice"
            }
          ]
        }
      ]
    }
  ],
  "date": "2012-01",
  "id": "3141"
}

Questionnaire Structure


  
{
  "resourceType" : "Questionnaire",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this questionnaire (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the questionnaire
  "version" : "<string>", // Business version of the questionnaire
  "name" : "<string>", // Name for this questionnaire (computer friendly)
  "title" : "<string>", // Name for this questionnaire (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the questionnaire
  "purpose" : "<markdown>", // Why this questionnaire is defined
  "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
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for questionnaire (if applicable)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "code" : [{ Coding }], // Concept that represents the overall questionnaire
  "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse
  "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
      "hasAnswer" : <boolean>, // C? Enable when answered or not
      // answer[x]: Value question must have. One of these 12:
      "answerBoolean" : <boolean>
      "answerDecimal" : <decimal>
      "answerInteger" : <integer>
      "answerDate" : "<date>"
      "answerDateTime" : "<dateTime>"
      "answerTime" : "<time>"
      "answerString" : "<string>"
      "answerUri" : "<uri>"
      "answerAttachment" : { Attachment }
      "answerCoding" : { Coding }
      "answerQuantity" : { Quantity }
      "answerReference" : { Reference(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
    "options" : { Reference(ValueSet) }, // C? Valueset containing permitted answers
    "option" : [{ // C? Permitted answer
      // value[x]: Answer value. One of these 5:
      "valueInteger" : <integer>
      "valueDate" : "<date>"
      "valueTime" : "<time>"
      "valueString" : "<string>"
      "valueCoding" : { Coding }
    }],
    // initial[x]: Default value when item is first rendered. One of these 12:
    "initialBoolean" : <boolean>,
    "initialDecimal" : <decimal>,
    "initialInteger" : <integer>,
    "initialDate" : "<date>",
    "initialDateTime" : "<dateTime>",
    "initialTime" : "<time>",
    "initialString" : "<string>",
    "initialUri" : "<uri>",
    "initialAttachment" : { Attachment },
    "initialCoding" : { Coding },
    "initialQuantity" : { Quantity },
    "initialReference" : { 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 the like so:

https://api.1up.health/fhir/stu3/Questionnaire?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextitem.code
datedatedate
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
titletexttitle
urluriurl
versiontextversion