Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


QuestionnaireResponse

Guidance for populating and consuming the QuestionnaireResponse profile for hierarchichal uncategorised data

Introduction

The headings below list the elements of the QuestionnaireResponse profile and describes how to populate and consume them for hierarchichal uncategorised data.

QuestionnaireResponse elements

id

Data type: Id Optionality: Mandatory Cardinality: 1..1

The logical identifier of the QuestionnaireResponse profile.

meta.profile

Data type: uri Optionality: Mandatory Cardinality: 1..1

The QuestionnaireResponse profile URL.

Fixed value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-QuestionnaireResponse-1.

identifier

Data type: Identifier Optionality: Mandatory Cardinality: 1..*

This MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.

There may be more than one identifier where data has been migrated across practices or provider systems and different provider specific identifiers have been assigned.

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.

parent

Data type: Reference Optionality: Mandatory Cardinality: 1..1

Link to the ‘Observation’ that is the parent to this QuestionnaireResponse.

Every QuestionnaireResponse MUST have a parent Observation.

questionnaire

Data type: Reference Optionality: Required Cardinality: 0..1

Reference to the set of questions or form being answered.

status

Data type: code Optionality: Mandatory Cardinality: 1..1

The status of the QuestionnaireResponse.

Fixed value of ‘completed’

subject

Data type: Reference(Patient) Optionality: Mandatory Cardinality: 1..1

Reference to patient this QuestionnaireResponse is about.

context

Data type: Reference(Encounter) Optionality: Required Cardinality: 0..1

The Encounter within which the QuestionnaireResponse was authored.

authored

Data type: dateTime Optionality: Mandatory Cardinality: 1..1

When this QuestionnaireResponse was created on the system.

item.linkId

Data type: String Optionality: Mandatory Cardinality: 1..1

Pointer to a specific item from a linked Questionnaire. Where the QuestionnaireResponse does not link back to a Questionnaire this should be populated with the rubric of the ‘parent’ observation. If the ‘parent’ observation does not have a text description which can be used, then populate with ‘No information available’.

item.text

Data type: String Optionality: Required Cardinality: 0..1

A text description of the question this item is an answer to or name of the group.

item.answer

Data type: Reference Optionality: Required Cardinality: 0..*

Answer to the question or item contained in the group.

In the current build of GP Connect this will always be in the form of a reference to another resource.


All content is available under the Open Government Licence v3.0, except where otherwise stated