QuestionnaireResponse

https://www.hl7.org/fhir/STU3/questionnaireresponse.html

Status

In development. API spec subject to change.

Overview

Each [[Consultation Response]] in PKB will map to a FHIR QuestionnaireResponse.

Relevant PKB Entities

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescriptionExamples (more)
searchGET/QuestionnaireResponse
  • authored. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].
  • based-on. Optional. Multi-value support: none. Modifier support: [<type>].
  • patient. Optional. Multi-value support: none. Modifier support: [<type>].
  • questionnaire. Optional. Multi-value support: none. Modifier support: [<type>].
  • _revinclude=Provenance:target
  • Patient
  • Professional
  • Team Coordinator
  • System User
Search for questionnaire responses./QuestionnaireResponse?based-on=ProcedureRequest/f2e1a976-9df0-46b7-8ac4-5ece166197ee

/QuestionnaireResponse?authored=2019-08-01&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&questionnaire=Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d

Mappings

FHIRPKBNotes
Resource id[[Consultation Response.Data Point ID]]
Resource meta
  • meta: Meta
    • lastUpdated = [[Data Point.Persisted Timestamp]]
    • security: Coding
      • system = "http://fhir.patientsknowbest.com/codesystem/privacy-label"
      • code = [[Data Point.Privacy Label]]
[[Data Point.Privacy Label]] code mappings (PKB → FHIR):
  • GENERAL_HEALTH → GENERAL_HEALTH
  • MENTAL_HEALTH → MENTAL_HEALTH
  • SEXUAL_HEALTH → SEXUAL_HEALTH
  • SOCIAL_CARE → SOCIAL_CARE

QuestionnaireResponse.basedOn
  • basedOn: Reference
    • reference = the relative URL of the ProcedureRequest resource
QuestionnaireResponse.questionnaire
  • questionnaire: Reference
    • reference = the relative URL of the Questionnaire resource
    • display = [[Consultation Response->Consultation.Name]]

QuestionnaireResponse.status[[Consultation Response.Status]]

[[Consultation Response.Status]] code mappings (PKB → FHIR):
  • DRAFT → in-progress
  • SENT → completed

QuestionnaireResponse.subject
  • subject: Reference
    • reference = the relative URL of the Patient resource
    • display = [[User.Title]] [[User.Given Name]] [[User.Family Name]]

QuestionnaireResponse.authored
[[Consultation Response.Completion Timestamp]]

QuestionnaireResponse.itemFor each collection of [[Consultation Response→Consultation Response Item]] as grouped by [[Consultation Response Item→Consultation Item]]:
  • item[x]: BackboneElement
    • linkId = [[Consultation Response Item→Consultation Item.ID]]
    • text = [[Consultation Response Item→Consultation Item.Text]]
    • For each [[Consultation Response Item]] in the group:
      • answer: BackboneElement
        • valueString = [[Consultation Response Item.Text]]
 
Subpages (1): Examples
Comments