QuestionnaireResponse REST Endpoints

Sort by

Task Path Method

Description

QuestionnaireResponse

This topic describes information for the QuestionnaireResponse resource.

Overview

The QuestionnaireResponse resource is a collection of answers to a given questionnaire typically used to request patient healthcare information. A given QuestionnaireResponse resource must belong to a corresponding Questionnaire resource. An example of a questionnaire is a form used to collect a patient's social history. Currently, only social history is supported. The resource should be leveraged as a snapshot in time and new data should be consistently retrieved through the API rather than stored within an application.

This resource supports the US Core QuestionnaireResponse Profile from HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site. The meta.security field is present only when confidential answers are present within the resource. Confidential answers contain extensions with their applied confidential label. See the HL7 FHIR Inline Security Label extension for more information.

The following fields are returned if valued:

• ID

• Questionnaire

• Status

• Subject

• Authored

• Item

  • ID

  • Link ID

  • Is Modifiable extension (for more information, see the Extensions section of this topic)

  • Note extension (for more information, see the Extensions section of this topic)

  • Text

  • Item

    • Link id

    • Text

    • Choice Answer extension (for more information, see the Extensions section of this topic)

    • Inline Security Label extension

    • valueString answers

    • valueCoding answers

    • valueQuantity answers

Terminology Bindings

• QuestionnaireResponse.answer.valueCoding

  Description: An answer from a list of available coding options.

  Details: For more information, see Nomenclature under the Proprietary Systems section in Proprietary Codes and Systems.

  System: https://fhir.cerner.com/<EHR source id>/nomenclature

• QuestionnaireResponse.meta.security

  Description: These tags connect specific resources to the overall security policy and infrastructure.

  Details: ValueSet

  System: http://terminology.hl7.org/CodeSystem/v3-ActCode

Extensions

Inline Security Label

Custom Extensions

URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}

ID	Value[x] Type	Description
is-modifiable	Boolean	Indication of whether data is modifiable or not. Only present when false.
choice-answer	Boolean	Indicates answers come from a list of options.
note	Annotation	Additional details about a given QuestionnaireResponse group item. Includes author and date/time information.

QuestionnaireResponse

The operations from the QuestionnaireResponse category.

Get a list of questionnaire responses

Method: get

Path: /QuestionnaireResponse/

Get a questionnaire response by ID

Method: get

Path: /QuestionnaireResponse/{id}

Update a questionnaire response

Method: put

Path: /QuestionnaireResponse/{id}