QuestionnaireResponse - FHIR Resource (r4)

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

Validate an QuestionnaireResponse FHIR Resource (r4)

QuestionnaireResponse Attributes

AttributeField is listTypeDescription

Description: Unique id for this set of answers

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": {
  "system": "http://example.org/fhir/NamingSystem/questionnaire-ids",
  "value": "Q12349876"
}

Learn more about the (QuestionnaireResponse) identifier FHIR attribute

Description: Request fulfilled by this QuestionnaireResponse

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"basedOn": [
  {
    "reference": "#order"
  }
]

Learn more about the (QuestionnaireResponse) basedOn FHIR attribute

Description: Part of this action

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"partOf": [
  {
    "reference": "Procedure/f201"
  }
]

Learn more about the (QuestionnaireResponse) partOf FHIR attribute

Description: Form being answered

FHIR Version: r4

Attribute Type : canonical(Questionnaire)

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"questionnaire":

Learn more about the (QuestionnaireResponse) questionnaire FHIR attribute

Description: in-progress | completed | amended | entered-in-error | stopped

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": "completed"

Learn more about the (QuestionnaireResponse) status FHIR attribute

Description: The subject of the questions

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject": {
  "reference": "#patsub"
}

Learn more about the (QuestionnaireResponse) subject FHIR attribute

Description: Encounter created as part of

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"encounter": {
  "reference": "Encounter/example"
}

Learn more about the (QuestionnaireResponse) encounter FHIR attribute

Description: Date the answers were gathered

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:

"authored": "2013-02-19T14:15:00-05:00"

Learn more about the (QuestionnaireResponse) authored FHIR attribute

Description: "author" : { Reference(Device|Practitioner|PractitionerRole|Patient|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author": {
  "reference": "#questauth"
}

Learn more about the (QuestionnaireResponse) author FHIR attribute

Description: The person who answered the questions

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"source":

Learn more about the (QuestionnaireResponse) source FHIR attribute

Description: Groups and questions

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",
    "item": [
      {
        "linkId": "1.1",
        "answer": [
          {
            "valueCoding": {
              "system": "http://cancer.questionnaire.org/system/code/yesno",
              "code": "1",
              "display": "Yes"
            },
            "item": [
              {
                "linkId": "1.1.1",
                "item": [
                  {
                    "linkId": "1.1.1.1",
                    "answer": [
                      {
                        "valueCoding": {
                          "system": "http://cancer.questionnaire.org/system/code/yesno",
                          "code": "1"
                        }
                      }
                    ]
                  },
                  {
                    "linkId": "1.1.1.2",
                    "answer": [
                      {
                        "valueCoding": {
                          "system": "http://cancer.questionnaire.org/system/code/yesno",
                          "code": "1"
                        }
                      }
                    ]
                  },
                  {
                    "linkId": "1.1.1.3",
                    "answer": [
                      {
                        "valueCoding": {
                          "system": "http://cancer.questionnaire.org/system/code/yesno",
                          "code": "0"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

Learn more about the (QuestionnaireResponse) item FHIR attribute

QuestionnaireResponse Example

{
  "resourceType": "QuestionnaireResponse",
  "id": "3141",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <pre>\n            Comorbidity? YES\n              Cardial Comorbidity? YES\n                Angina? YES\n                MI? NO\n              Vascular Comorbidity?\n                (no answers)\n              ...\n            Histopathology\n              Abdominal\n                pT category: 1a\n              ...\n          </pre>\n    </div>"
  },
  "contained": [
    {
      "resourceType": "Patient",
      "id": "patsub",
      "identifier": [
        {
          "system": "http://cancer.questionnaire.org/systems/id/patientnr",
          "value": "A34442332"
        },
        {
          "type": {
            "text": "Dutch BSN"
          },
          "system": "urn:oid:2.16.840.1.113883.2.4.6.3",
          "value": "188912345"
        }
      ],
      "gender": "male",
      "birthDate": "1972-11-30"
    },
    {
      "resourceType": "ServiceRequest",
      "id": "order",
      "status": "unknown",
      "intent": "order",
      "subject": {
        "reference": "#patsub"
      },
      "requester": {
        "reference": "Practitioner/example"
      }
    },
    {
      "resourceType": "Practitioner",
      "id": "questauth",
      "identifier": [
        {
          "type": {
            "text": "AUMC, Den Helder"
          },
          "system": "http://cancer.questionnaire.org/systems/id/org",
          "value": "AUMC"
        }
      ]
    }
  ],
  "identifier": {
    "system": "http://example.org/fhir/NamingSystem/questionnaire-ids",
    "value": "Q12349876"
  },
  "basedOn": [
    {
      "reference": "#order"
    }
  ],
  "partOf": [
    {
      "reference": "Procedure/f201"
    }
  ],
  "status": "completed",
  "subject": {
    "reference": "#patsub"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "authored": "2013-02-19T14:15:00-05:00",
  "author": {
    "reference": "#questauth"
  },
  "item": [
    {
      "linkId": "1",
      "item": [
        {
          "linkId": "1.1",
          "answer": [
            {
              "valueCoding": {
                "system": "http://cancer.questionnaire.org/system/code/yesno",
                "code": "1",
                "display": "Yes"
              },
              "item": [
                {
                  "linkId": "1.1.1",
                  "item": [
                    {
                      "linkId": "1.1.1.1",
                      "answer": [
                        {
                          "valueCoding": {
                            "system": "http://cancer.questionnaire.org/system/code/yesno",
                            "code": "1"
                          }
                        }
                      ]
                    },
                    {
                      "linkId": "1.1.1.2",
                      "answer": [
                        {
                          "valueCoding": {
                            "system": "http://cancer.questionnaire.org/system/code/yesno",
                            "code": "1"
                          }
                        }
                      ]
                    },
                    {
                      "linkId": "1.1.1.3",
                      "answer": [
                        {
                          "valueCoding": {
                            "system": "http://cancer.questionnaire.org/system/code/yesno",
                            "code": "0"
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

QuestionnaireResponse Structure

{
  "resourceType" : "QuestionnaireResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Unique id for this set of answers
  "basedOn" : [{ Reference(CarePlan|ServiceRequest) }], // Request fulfilled by this QuestionnaireResponse
  "partOf" : [{ Reference(Observation|Procedure) }], // Part of this action
  "questionnaire" : { canonical(Questionnaire) }, // Form being answered
  "status" : "<code>", // R!  in-progress | completed | amended | entered-in-error | stopped
  "subject" : { Reference(Any) }, // The subject of the questions
  "encounter" : { Reference(Encounter) }, // Encounter created as part of
  "authored" : "<dateTime>", // Date the answers were gathered
  "author" : { Reference(Device|Practitioner|PractitionerRole|Patient|
   RelatedPerson|Organization) }, // Person who received and recorded the answers
  "source" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) }, // The person who answered the questions
  "item" : [{ // Groups and questions
    "linkId" : "<string>", // R!  Pointer to specific item from Questionnaire
    "definition" : "<uri>", // ElementDefinition - details for the item
    "text" : "<string>", // Name for group or question text
    "answer" : [{ // The response(s) to the question
      // value[x]: Single-valued answer to 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 QuestionnaireResponse.item }] // Nested groups and questions
    }],
    "item" : [{ Content as for QuestionnaireResponse.item }] // Nested questionnaire response items
  }]
}

QuestionnaireResponse Search Parameters

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

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

Search Parameter	Field Type	Resource Fields Searched
`author`	`reference`	`author`
`authored`	`date`	`authored`
`based-on`	`reference`	`basedOn`
`encounter`	`reference`	`encounter`
`identifier`	`text`	`identifier`
`part-of`	`reference`	`partOf`
`patient`	`reference`	`subject.where`
`questionnaire`	`reference`	`questionnaire`
`source`	`reference`	`source`
`status`	`text`	`status`
`subject`	`reference`	`subject`