Questionnaire

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

Status

In development. API spec subject to change.

Overview

Each [[Consultation]] in PKB will map to a single FHIR Questionnaire.

Relevant PKB Entities

Endpoints

InteractionHTTPURLSupported ParametersPermitted User TypesDescriptionExamples
readGET/Questionnaire/<id>N/A
  • Patient
  • Professional
  • Team Coordinator
  • System User
Retrieve a specific Questionnaire./Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d
searchGET/Questionnaire
None.
  • Patient
  • Professional
  • Team Coordinator
  • System User
Search for Questionnaire resources./Questionnaire

Mappings

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

Questionnaire.title
[[Consultation.Name]]

Questionnaire.status"active"
Questionnaire.date
[[Consultation.Creation Timestamp]]

Questionnaire.item
For each [[Consultation->Consultation Item]]
  • item[x]: BackboneElement
    • linkId = [[Consultation Item.ID]]
    • text = [[Consultation Item.Text]]
    • type = [[Consultation Item.Type]]
    • <conditional>
    • If [[Consultation Item.Type]] is TITLE:
      • omit the repeats element
    • Else If [[Consultation Item.Type]] is CHECKBOX: 
      • repeats = true
    • Else:
      • repeats = false
    • <conditional>
    • If [[Consultation Item.Type]] is RADIO or CHECKBOX, add an option element for each [[Consultation Item Option]]:
    • option: BackboneElement
      • valueString = [[Consultation Item Option.Text]]
    • Else: omit the option element
[[Consultation Item.Type]] code mappings (PKB → FHIR):
  • TITLE → display
  • TEXT → text
  • RADIO → choice
  • CHECKBOX → choice

Comments