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
urlΣ1..1uri
versionΣ0..1string
titleΣ1..1string
statusΣ ?!1..1codeBindingFixed Value
publisherΣ0..1string
description0..1markdown

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