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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 17 of 19 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlΣ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the questionnaire |
versionΣ | 0..1 | string | Business version of the questionnaire |
nameΣ | 0..1 | string | Name for this questionnaire (computer friendly) |
titleΣ | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
subjectTypeΣ | 0..* | code | Resource that can be subject of QuestionnaireResponseBinding (required): resource-types |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the questionnaire |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this questionnaire is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed |
effectivePeriodΣ | 0..1 | Period | When the questionnaire is expected to be used |
codeΣ | 0..* | Coding | Concept that represents the overall questionnaireBinding (example): questionnaire-questions |
item | 0..* | BackboneElement | Questions and sections within the Questionnaire |
linkIdRequired | 1..1 | string | Unique id for item in questionnaire |
definition | 0..1 | uri | ElementDefinition - details for the item |
code | 0..* | Coding | Corresponding concept for this item in a terminologyBinding (example): questionnaire-questions |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" |
text | 0..1 | string | Primary text for the item |
typeRequired | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime +Binding (required): item-type |
enableWhen?! | 0..* | BackboneElement | Only allow data when |
questionRequired | 1..1 | string | Question that determines whether item is enabled |
operatorRequired | 1..1 | code | exists | = | != | > | < | >= | <=Binding (required): questionnaire-enable-operator |
answer[x]Required | 1..1 | boolean | decimal | integer | date | dateTime | time | string | Coding | Quantity | Reference(Resource) | Value for question comparison based on operatorBinding (example): questionnaire-answers |
enableBehavior | 0..1 | code | all | anyBinding (required): questionnaire-enable-behavior |
required | 0..1 | boolean | Whether the item must be included in data results |
repeats | 0..1 | boolean | Whether the item may repeat |
readOnly | 0..1 | boolean | Don't allow human editing |
maxLength | 0..1 | integer | No more than this many characters |
answerValueSet | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
answerOption | 0..* | BackboneElement | Permitted answer |
value[x]Required | 1..1 | integer | date | time | string | Coding | Reference(Resource) | Answer valueBinding (example): questionnaire-answers |
initialSelected | 0..1 | boolean | Whether option is selected by default |
initial | 0..* | BackboneElement | Initial value(s) when item is first rendered |
value[x]Required | 1..1 | boolean | decimal | integer | date | dateTime | time | string | uri | Attachment | Coding | Quantity | Reference(Resource) | Actual value for initializing the questionBinding (example): questionnaire-answers |
item | 0..* | Same as Questionnaire.item | Nested questionnaire items |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/Questionnaire?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
code | token | A code that corresponds to one of its items in the questionnaire Questionnaire.item.code | ||
context | token | A use context assigned to the questionnaire (Questionnaire.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the questionnaire (Questionnaire.useContext.value.ofType(Quantity)) | (Questionnaire.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the questionnaire Questionnaire.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the questionnaire Questionnaire.useContext | ||
context-type-value | composite | A use context type and value assigned to the questionnaire Questionnaire.useContext | ||
date | date | The questionnaire publication date Questionnaire.date | ||
definition | uri | ElementDefinition - details for the item Questionnaire.item.definition | ||
description | string | The description of the questionnaire Questionnaire.description | ||
effective | date | The time during which the questionnaire is intended to be in use Questionnaire.effectivePeriod | ||
identifier | token | External identifier for the questionnaire Questionnaire.identifier | ||
jurisdiction | token | Intended jurisdiction for the questionnaire Questionnaire.jurisdiction | ||
name | string | Computationally friendly name of the questionnaire Questionnaire.name | ||
publisher | string | Name of the publisher of the questionnaire Questionnaire.publisher | ||
status | token | The current status of the questionnaire Questionnaire.status | ||
subject-type | token | Resource that can be subject of QuestionnaireResponse Questionnaire.subjectType | ||
title | string | The human-friendly name of the questionnaire Questionnaire.title | ||
url | uri | The uri that identifies the questionnaire Questionnaire.url | ||
version | token | The business version of the questionnaire Questionnaire.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken