Questionnaire
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Questionnaire/[id] |
| Vread | GET | /fhir/R4/Questionnaire/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Questionnaire/[id] |
| Patch | PATCH | /fhir/R4/Questionnaire/[id] |
| Delete | DELETE | /fhir/R4/Questionnaire/[id] |
| Create | POST | /fhir/R4/Questionnaire |
| Search | GET | /fhir/R4/Questionnaire |
| History | GET | /fhir/R4/Questionnaire/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
url | uri | 0..1 | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the questionnaire |
version | string | 0..1 | Business version of the questionnaire |
name | string | 0..1 | Name for this questionnaire (computer friendly) |
title | string | 0..1 | Name for this questionnaire (human friendly) |
derivedFrom | canonical | 0..* | Instantiates protocol or definition |
status | code | 1..1 | draft | active | retired | unknown |
experimental | boolean | 0..1 | For testing purposes, not real usage |
subjectType | code | 0..* | Resource that can be subject of QuestionnaireResponse |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the questionnaire |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for questionnaire (if applicable) |
purpose | markdown | 0..1 | Why this questionnaire is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
approvalDate | date | 0..1 | When the questionnaire was approved by publisher |
lastReviewDate | date | 0..1 | When the questionnaire was last reviewed |
effectivePeriod | Period | 0..1 | When the questionnaire is expected to be used |
code | Coding | 0..* | Concept that represents the overall questionnaire |
item | BackboneElement | 0..* | Questions and sections within the Questionnaire |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
code | token | A code that corresponds to one of its items in the questionnaire |
context | token | A use context assigned to the questionnaire |
context-quantity | quantity | A quantity- or range-valued use context assigned to the questionnaire |
context-type | token | A type of use context assigned to the questionnaire |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the questionnaire |
context-type-value | composite | A use context type and value assigned to the questionnaire |
date | date | The questionnaire publication date |
definition | uri | ElementDefinition - details for the item |
description | string | The description of the questionnaire |
effective | date | The time during which the questionnaire is intended to be in use |
identifier | token | External identifier for the questionnaire |
jurisdiction | token | Intended jurisdiction for the questionnaire |
name | string | Computationally friendly name of the questionnaire |
publisher | string | Name of the publisher of the questionnaire |
status | token | The current status of the questionnaire |
subject-type | token | Resource that can be subject of QuestionnaireResponse |
title | string | The human-friendly name of the questionnaire |
url | uri | The uri that identifies the questionnaire |
version | token | The business version of the questionnaire |
Reference
Official FHIR R4 spec: Questionnaire.
Maturity: Trial Use 3 (FMM 3).