QuestionnaireSe

Introduction

QuestionnaireSe is created from the FHIR resource Questionnaire https://www.hl7.org/fhir/questionnaire.html). The Questionnaire resource is tightly coupled with the QuestionnaireResponse resource, where the Questionnaire resource holds the logic that the QuestionnaireResponse resource should follow.

Intended Use

QuestionnaireSe is used to fetch Questionnaires (Medical record templates) from COSMIC. The retrieved Questionnaires should be used for filling a QuestionnaireResponse which can be sent back to COSMIC.

Questionnaires can be retrieved both for when a healthcare professional will be the author, or when a patient will be the author.

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.

Profile Overview

QuestionnaireSe

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..1string
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
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
linkId1..1string
definition0..0uri
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
prefix0..1string
text1..1string
type1..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
question1..1string
operator1..1codeBinding
answerBooleanboolean
answerDecimaldecimal
answerIntegerinteger
answerDatedate
answerDateTimedateTime
answerTimetime
answerStringstring
answerCodingCoding
answerQuantityQuantity
answerReferenceReference(Resource)
enableBehaviorI0..1codeBinding
requiredI0..1boolean
repeatsI0..1boolean
readOnlyI0..1boolean
maxLengthI0..1integer
answerValueSetI0..0canonical(ValueSet)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
valueCodingCoding
initialSelected0..1boolean
itemI0..*see (item)

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

Get by id

Search search param; codes

HTTP Methods

Method Description
GET GET Questionnaire by id.

Query Operations

Supported Queries

  1. GET [baseURL]/Questionnaire/[id] (Read)

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
404 Questionnaire not found for the codes