eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions
Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire |
Version: | 2022.1 |
Name: | ehealth-questionnaire |
Status: | Active as of 1/18/22, 9:57 AM |
Publisher: | Systematic | Trifork |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire
A Questionnaire is 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.
In the eHealth Infrastructure the Questionnaire resource is used in line with this. Questionnaires are built and maintained by Practitioners and presented to Patients by client applications in order to gather input and answers from Patients in the form of QuestionnaireResponse resources.
A question where possible answers are given as a list of options (of item.type
set to choice
) can allow multiple choices by setting item.repeats
to true
. When no further constraints are set, item.repeats
set to true
means that any number of the options can be provided as answer to the question in a QuestionnaireResponse. The standard extensions item.questionnaire-minOccurs
and item.questionnaire-maxOccurs
can be used to set such further constraints.
item.questionnaire-minOccurs
sets the minimum number of answers allowed, for instance 2 (of the number of options, say, 5). The element shall be set only when its value is greater than one.item.questionnaire-maxOccurs
sets the maximum number of answers allowed, for instance 3 (of the number of options, say 5). The element shall be set only when its value is greater than one.When exactly one answer shall be required, item.requied
shall be set to true
and item.repeats
shall be set to false
. When exactly one answer is permitted, item.requied
shall be set to false
and item.repeats
shall be set to false
. In these cases, the minOCcurs
and maxOccurs
shall not be used.
The Questionnaire resource supports the Question Feedback Pattern from DK QFDD questionnaires. This enables immediate feedback to the patient upon answering a question.
The feedback is pre-defined in the Questionnaire resource using the item.feedback
element, so that for each item a patient feedback can be prepared. The feedback will be shown to the patient if the patient’s answer to an item lies within a given interval. The mechanism only works for questions which can be answered with a numeric value. The interval is defined by the min
and a max
elements of the feedback extension. If the Patient answers the item with a numeric value in the interval given by min-max then the value
of the feedback extension is intended to be shown to the Patient.
In the recommendation
element, a questionnaire can optionally hold a “degree of recommendation” intended to aid the Practitioner in deciding whether or not the Questionnaire should be associated with an ActivityDefinition and used in one or more PlanDefinition.
For each item
and item.answerOption
in a Questionnaire, a small image can be associated through extensions item.ehealth-questionnaire-image
and item.answerOption.ehealth-questionnaire-image
, respectively. Both extensions are based on Binary containing the image data base64 encoded.
In the service, the Binary.contentType
is verified against a ValueSet with uri
http://ehealth.sundhed.dk/vs/questionnaire-item-image-format
while the size of Binary.data
must not exceed a configurable size, currently 266Kb (base64 encoded).
The item.ehealth-questionnaire-answerSignificance
element functions as a triaging indicator, describing the importance of answers to respective questions. answerSignificance
has two sub elements:
answerSignificance.significance
element which states the triaging coloranswerSignificance.answerCondition
contains the value or interval limits for comparison against the given answer.
answerCondition.value[x]
is the value to compare with an answer and contains various type depending on the need.answerCondition.operator
determines the relationship between the answerCondition.value[x]
and a given answer. When a single answerSignificance.answerCondition
is given, it represents a precise match or possibly open ended interval. Two answerSignificance.answerCondition
can specify an interval. To check that a written answer exists, use answerCondition.operator = exists
and answerCondition.valueBoolean = true
.The item.questionnaire-itemControl
element enables indication of what sort of user interface control type, for instance radio buttons, to use when displaying an item.
The elements item.text
, item.answerOption.value
, and item.inital.value
supports formatted text for valueString using the standard extension: http://hl7.org/fhir/extension-rendering-xhtml.html
Note that the original text without formatting must be added to the elements item.text
, item.answerOption.value
, and item.inital.value
, respectively, for those where the formatted extension has been used.
The extension rendering-styleSensitive indicates if clients must be able to display the formatted text for this Questionnaire, or if not capable to do this, at least indicate to the user that rendering is not appropriate.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Questionnaire
Summary
Mandatory: 3 elements (1 nested mandatory element)
Extensions
This structure refers to these extensions:
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-recommendation | 0..1 | CodeableConcept | Degree to which this questionnaire is recommended for use. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation Binding: QuestionnaireRecommendation (required) | |
ehealth-questionnaire-intendedOrganization | 0..* | Reference(ehealth-organization) {r} | The organization intended to use this questionnaire. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization | |
ehealth-revision | 0..1 | string | Business revision URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-questionnaire-type | 1..* | CodeableConcept | Concept that represents the overall questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-type Binding: Questionnaire Types (required) | |
rendering-styleSensitive | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 1..1 | string | Business version of the questionnaire |
name | ΣI | 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 | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
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: Jurisdiction (required) |
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 questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
questionnaire-minOccurs | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | |
questionnaire-maxOccurs | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | |
minValue | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | |
maxValue | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | |
questionnaire-sliderStepValue | 0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | |
ehealth-questionnaire-feedback | 0..1 | (Complex) | Feedback if reponse is within the defined range. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback | |
ehealth-overviewUsageMode | 0..* | CodeableConcept | Identifies whether the specified element and/or results of the element should appear in overview or table presentation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-overviewUsageMode Binding: Overview Usage Mode (required) | |
questionnaire-itemControl | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Questionnaire Item Control (required) | |
ehealth-questionnaire-image | 0..1 | (Complex) | The image for a questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-image | |
ehealth-questionnaire-answerSignificance | 0..* | (Complex) | The Answer significance for an answer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-answerSignificance | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | 0..1 | string | Primary text for the item | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
answerOption | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-image | 0..1 | (Complex) | The image for a questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-image | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
value[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | I | 0..* | BackboneElement | Initial value(s) when item is first rendered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
value[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Resource) | |||
item | I | 0..* | See item (Questionnaire) | Nested questionnaire items |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
Documentation for this format |
This structure is derived from Questionnaire
Summary
Mandatory: 3 elements (1 nested mandatory element)
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Questionnaire
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-recommendation | 0..1 | CodeableConcept | Degree to which this questionnaire is recommended for use. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation Binding: QuestionnaireRecommendation (required) | |
ehealth-questionnaire-intendedOrganization | 0..* | Reference(ehealth-organization) {r} | The organization intended to use this questionnaire. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization | |
ehealth-revision | 0..1 | string | Business revision URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-questionnaire-type | 1..* | CodeableConcept | Concept that represents the overall questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-type Binding: Questionnaire Types (required) | |
rendering-styleSensitive | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 1..1 | string | Business version of the questionnaire |
name | ΣI | 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 | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
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: Jurisdiction (required) |
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 questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
questionnaire-minOccurs | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | |
questionnaire-maxOccurs | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | |
minValue | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | |
maxValue | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | |
questionnaire-sliderStepValue | 0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | |
ehealth-questionnaire-feedback | 0..1 | (Complex) | Feedback if reponse is within the defined range. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback | |
ehealth-overviewUsageMode | 0..* | CodeableConcept | Identifies whether the specified element and/or results of the element should appear in overview or table presentation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-overviewUsageMode Binding: Overview Usage Mode (required) | |
questionnaire-itemControl | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Questionnaire Item Control (required) | |
ehealth-questionnaire-image | 0..1 | (Complex) | The image for a questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-image | |
ehealth-questionnaire-answerSignificance | 0..* | (Complex) | The Answer significance for an answer URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-answerSignificance | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | 0..1 | string | Primary text for the item | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
answerOption | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-image | 0..1 | (Complex) | The image for a questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-image | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
value[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | I | 0..* | BackboneElement | Initial value(s) when item is first rendered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
value[x]:All Types | Content/Rules for all Types | |||
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
rendering-xhtml | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Resource) | |||
item | I | 0..* | See item (Questionnaire) | Nested questionnaire items |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Questionnaire.language | preferred | CommonLanguages Max Binding: AllLanguages |
Questionnaire.status | required | PublicationStatus |
Questionnaire.subjectType | required | ResourceType |
Questionnaire.jurisdiction | required | Jurisdiction |
Questionnaire.code | example | QuestionnaireQuestionCodes |
Questionnaire.item.extension:itemControl.value[x] | extensible | QuestionnaireItemUIControlCodes |
Questionnaire.item.extension:itemControl.value[x]:valueCodeableConcept | required | QuestionnaireItemControl |
Questionnaire.item.code | example | QuestionnaireQuestionCodes |
Questionnaire.item.type | required | QuestionnaireItemType |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes |
Questionnaire.item.enableBehavior | required | EnableWhenBehavior |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes |
Id | Grade | Path | Details | Requirements |
que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |