NHS Digital FHIR Implementation Guide (Retired - 2.1.50)

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

NHSDigital-QuestionnaireResponse

Profile url
https://fhir.nhs.uk/StructureDefinition/NHSDigital-QuestionnaireResponse


with QuestionnaireResponse

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierS Σ0..1Identifier
basedOnΣ C0..*Reference(CarePlan | ServiceRequest)
partOfΣ C0..*Reference(Observation | Procedure)
questionnaireS Σ1..1canonical(Questionnaire)
statusΣ ?!1..1codeBinding
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
encounterΣ C0..1Reference(Encounter)
authoredΣ1..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
linkId1..1string
definition0..1uri
text0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
valueAttachmentAttachment
valueBooleanboolean
valueCodingCoding
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIntegerinteger
valueQuantityQuantity
valueReferenceReference(Resource)
valueStringstring
valueTimetime
valueUriuri
item0..*see (item)
item0..*see (item)

from QuestionnaireResponse

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierS Σ0..1Identifier
basedOnΣ C0..*Reference(CarePlan | ServiceRequest)
partOfΣ C0..*Reference(Observation | Procedure)
questionnaireS Σ1..1canonical(Questionnaire)
statusΣ ?!1..1codeBinding
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
encounterΣ C0..1Reference(Encounter)
authoredΣ1..1dateTime
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayS Σ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
linkId1..1string
definition0..1uri
text0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
valueAttachmentAttachment
valueBooleanboolean
valueCodingCoding
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIntegerinteger
valueQuantityQuantity
valueReferenceReference(Resource)
valueStringstring
valueTimetime
valueUriuri
item0..*see (item)
item0..*see (item)

questionnaire

Questionnaire identifies which form is being answered in the QuestionnaireResponse.

  "questionnaire" : "https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption"

Search Parameters

Name Type Description Conformance Path
patient:identifier token The patient that is the subject of the questionnaire response SHALL QuestionnaireResponse.subject.where(resolve() is Patient) (Patient)
questionnaire reference The questionnaire the answers are provided for SHALL QuestionnaireResponse.questionnaire (Questionnaire)

Additional parameters can be on QuestionnaireResponse - Search Parameters

Mandatory Search Parameters

patient:identifier and questionnaire

SHALL support searching using the patient:identifier and questionnaire search parameters.

GET [baseUrl]/QuestionnaireResponse?patient:identifier={system|}[code]&questionnaire=[questionnaire]

Example:

GET [baseUrl]/QuestionnaireResponse?patient:identifier=9876543210&questionnaire=https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption

Return all QuestionnaireResponse resources for a Patient with an identifier 9876543210 and which are answering the https://fhir.nhs.uk/Questionnaire/COVIDVaccinationMedicalExemption questionaire.

Optional Search Parameters

patient:identifier

SHOULD support searching using the patient:identifier search parameter.

GET [baseUrl]/QuestionnaireResponse?patient:identifier={system|}[code]

Example:

GET [baseUrl]/QuestionnaireResponse?patient:identifier=9876543210

Return all QuestionnaireResponse resources for a Patient with an identifier 9876543210.

back to top