QuestionnaireSeLite

Introduction

QuestionnaireSeLite is created from the FHIR resource Questionnaire.

Intended Use

Intended use for the QuestionnaireSeLite profile is to apply for searching out a list of Questionnaires with limited contents (i.e. items are not included). This is done by providing one or several codes as the search parameter. The bundled list that is retrieved from the search should be used to get an overview of available Questionnaires, which complete contents can later be retrieved through QuestionnaireSe.

Specific Rules and Limitations

Type Description
Rule It is mandatory to provide one or several codings to be able to retrieve any Questionnaires through the API.
Rule It is mandatory for the Questionnaire to have a name (title) to be able to retrieve the Questionnaire.
Rule It is mandatory to use the Snomed code for Patient (16154003) when retrieving questionnaires for patient use. If this code is not specified, the API will return healthcare professional templates.
Rule To request healthcare professional templates, the Snomed code for Healthcare professional (223366009) is used.
Rule The useContext for patient should only be used for this API. Only templates that have been agreed on should be used.
Limitation Only one of the template contexts patient/healthcare professional can be requested at the time.

Profile Overview

QuestionnaireSeLite

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ1..1uri
identifierΣ0..0Identifier
versionΣ0..1string
nameΣ I0..0string
titleΣ1..1string
derivedFrom0..0canonical(Questionnaire)
statusΣ ?!1..1codeBindingFixed Value
experimentalΣ0..0boolean
subjectTypeΣ0..0codeBinding
dateΣ0..0dateTime
publisherΣ0..0string
contactΣ0..0ContactDetail
description0..1markdown
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
codeΣ1..1CodingBinding
valueCodeableConceptCodeableConcept
jurisdictionΣ0..0CodeableConceptBinding
purpose0..0markdown
copyright0..0markdown
approvalDate0..0date
lastReviewDate0..0date
effectivePeriodΣ I0..0Period
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean

Versions

COS version Profile version Required COSMIC version Date Description
2.4.0 1.0.0 R8.3.04 Feb 2022 Initial version, support for GET.

Supported Operations

HTTP Methods

Method Description
GET GET Questionnaires by given codes.

Query Operations

Search Parameters

Parameter Format Comment
code token Codes given in Questionnaire.code
useContext token Codes given in Questionnaire.useContext.PatientQuestionnaire

Supported Queries

  1. GET [baseURL]/Questionnaire/?search?code= (Search)
  2. GET [baseURL]/Questionnaire/_search?code=http://snomed.info/sct|259008006&context=http://snomed.info/sct|116154003 (Search)

Supported SearchInclude Operations

N/A

Supported RevInclude Operations

N/A

Error Codes

In the table below, a few error messages specific for Questionnaire are listed.

Code Description Comment
400 Codes should be valid Tokens with system and value
400 Unsupported Context is provided for context parameter
404 Questionnaire not found for the codes