0.1.0 - ci-build

collabreefhirdocumentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Collabree Questionnaire Profile

Official URL: https://fhir.collabree.com/fhir/StructureDefinition/collabree-questionnaire Version: 0.1.0
Draft as of 2025-11-04 Computable Name: CollabreeQuestionnaire

Profile for questionnaires used in the Collabree adherence tracking system with multi-language support and scoring capabilities

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-0, que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 1..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Required Pattern: en
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 Coding Category
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... Slices for extension Content/Rules for all slices
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... code Σ 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display Σ 1..1 string Representation defined by the system
... Slices for item C 1..1 BackboneElement Questions and sections within the Questionnaire
Slice: Unordered, Closed by value:linkId
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
.... item:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId 1..1 string Unique id for item in questionnaire
..... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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)
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 0..* BackboneElement Permitted answer
...... 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.
....... valueInteger integer
....... valueDate date
....... valueTime time
....... valueString string
....... valueCoding Coding
....... valueReference Reference(Resource)
..... initial C 0..* BackboneElement Initial value(s) when item is first rendered
...... 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.
....... 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:question C 1..1 BackboneElement Question
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId 1..1 string Unique id for item in questionnaire
..... text 1..1 string Primary text for the item
..... 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.
Required Pattern: choice
..... enableWhen ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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)
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 1..* BackboneElement Permitted answer
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
..... initial C 0..* BackboneElement Initial value(s) when item is first rendered
...... 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.
....... 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-0 warning Questionnaire Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1 error Questionnaire.item, Questionnaire.item:question 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item, Questionnaire.item:question Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item, Questionnaire.item:question A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen, Questionnaire.item:question.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item, Questionnaire.item:question Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item, Questionnaire.item:question Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item, Questionnaire.item:question If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item, Questionnaire.item:question Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* Questionnaire A structured set of questions
... language 1..1 code Language of the resource content
Required Pattern: en
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... code 1..1 Coding Category
.... Slices for extension Content/Rules for all slices
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display 1..1 string Representation defined by the system
.... item:question 1..1 BackboneElement Question
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... text 1..1 string Primary text for the item
..... type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Required Pattern: choice
..... answerOption 1..* BackboneElement Permitted answer
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... value[x] 1..1 string Answer value

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-0, que-2
... id Σ 0..1 id 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 1..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Required Pattern: en
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 Σ 0..1 string Business version of the questionnaire
... name ΣC 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.
Required Pattern: active
... 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 ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... 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 Σ 1..1 Coding Category
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... 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
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display Σ 1..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... Slices for item C 1..1 BackboneElement Questions and sections within the Questionnaire
Slice: Unordered, Closed by value:linkId
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
.... item:All Slices Content/Rules for all slices
..... 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
..... linkId 1..1 string Unique id for item in questionnaire
..... definition 0..1 uri ElementDefinition - details for the item
..... code C 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
..... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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 C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... required C 0..1 boolean Whether the item must be included in data results
..... repeats C 0..1 boolean Whether the item may repeat
..... readOnly C 0..1 boolean Don't allow human editing
..... maxLength C 0..1 integer No more than this many characters
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 0..* BackboneElement Permitted answer
...... 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 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... valueInteger integer
....... valueDate date
....... valueTime time
....... valueString string
....... valueCoding Coding
....... valueReference Reference(Resource)
...... initialSelected 0..1 boolean Whether option is selected by default
..... initial C 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.
....... 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 C 0..* See item (Questionnaire) Nested questionnaire items
.... item:question C 1..1 BackboneElement Question
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... 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 C 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 1..1 string Primary text for the item
..... 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.
Required Pattern: choice
..... enableWhen ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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 C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... required C 0..1 boolean Whether the item must be included in data results
..... repeats C 0..1 boolean Whether the item may repeat
..... readOnly C 0..1 boolean Don't allow human editing
..... maxLength C 0..1 integer No more than this many characters
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 1..* BackboneElement Permitted answer
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... initialSelected 0..1 boolean Whether option is selected by default
..... initial C 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.
....... 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 C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.subjectType Base required ResourceType 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG
Questionnaire.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item:question.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-0 warning Questionnaire Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1 error Questionnaire.item, Questionnaire.item:question 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item, Questionnaire.item:question Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item, Questionnaire.item:question A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen, Questionnaire.item:question.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item, Questionnaire.item:question Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item, Questionnaire.item:question Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item, Questionnaire.item:question If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item, Questionnaire.item:question Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 10 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Questionnaire.item (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-0, que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 1..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Required Pattern: en
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code Σ 1..1 Coding Category
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... Slices for extension Content/Rules for all slices
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... code Σ 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display Σ 1..1 string Representation defined by the system
... Slices for item C 1..1 BackboneElement Questions and sections within the Questionnaire
Slice: Unordered, Closed by value:linkId
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
.... item:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId 1..1 string Unique id for item in questionnaire
..... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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)
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 0..* BackboneElement Permitted answer
...... 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.
....... valueInteger integer
....... valueDate date
....... valueTime time
....... valueString string
....... valueCoding Coding
....... valueReference Reference(Resource)
..... initial C 0..* BackboneElement Initial value(s) when item is first rendered
...... 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.
....... 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:question C 1..1 BackboneElement Question
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId 1..1 string Unique id for item in questionnaire
..... text 1..1 string Primary text for the item
..... 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.
Required Pattern: choice
..... enableWhen ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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)
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 1..* BackboneElement Permitted answer
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
..... initial C 0..* BackboneElement Initial value(s) when item is first rendered
...... 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.
....... 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-0 warning Questionnaire Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1 error Questionnaire.item, Questionnaire.item:question 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item, Questionnaire.item:question Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item, Questionnaire.item:question A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen, Questionnaire.item:question.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item, Questionnaire.item:question Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item, Questionnaire.item:question Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item, Questionnaire.item:question If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item, Questionnaire.item:question Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* Questionnaire A structured set of questions
... language 1..1 code Language of the resource content
Required Pattern: en
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... code 1..1 Coding Category
.... Slices for extension Content/Rules for all slices
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... code 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display 1..1 string Representation defined by the system
.... item:question 1..1 BackboneElement Question
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... text 1..1 string Primary text for the item
..... type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Required Pattern: choice
..... answerOption 1..* BackboneElement Permitted answer
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... value[x] 1..1 string Answer value

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-0, que-2
... id Σ 0..1 id 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 1..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Required Pattern: en
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 Σ 0..1 string Business version of the questionnaire
... name ΣC 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.
Required Pattern: active
... 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 ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... 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 Σ 1..1 Coding Category
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... 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
..... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... system Σ 0..1 uri Identity of the terminology system
Required Pattern: http://loinc.org
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
Binding: Collabree Questionnaire Category Value Set (required)
.... display Σ 1..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... Slices for item C 1..1 BackboneElement Questions and sections within the Questionnaire
Slice: Unordered, Closed by value:linkId
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
.... item:All Slices Content/Rules for all slices
..... 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
..... linkId 1..1 string Unique id for item in questionnaire
..... definition 0..1 uri ElementDefinition - details for the item
..... code C 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
..... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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 C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... required C 0..1 boolean Whether the item must be included in data results
..... repeats C 0..1 boolean Whether the item may repeat
..... readOnly C 0..1 boolean Don't allow human editing
..... maxLength C 0..1 integer No more than this many characters
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 0..* BackboneElement Permitted answer
...... 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 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... valueInteger integer
....... valueDate date
....... valueTime time
....... valueString string
....... valueCoding Coding
....... valueReference Reference(Resource)
...... initialSelected 0..1 boolean Whether option is selected by default
..... initial C 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.
....... 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 C 0..* See item (Questionnaire) Nested questionnaire items
.... item:question C 1..1 BackboneElement Question
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... 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 C 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 1..1 string Primary text for the item
..... 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.
Required Pattern: choice
..... enableWhen ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
...... 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] C 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 C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... required C 0..1 boolean Whether the item must be included in data results
..... repeats C 0..1 boolean Whether the item may repeat
..... readOnly C 0..1 boolean Don't allow human editing
..... maxLength C 0..1 integer No more than this many characters
..... answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
..... answerOption C 1..* BackboneElement Permitted answer
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:feedbackMessage 1..1 (Complex) Collabree Questionnaire Answer Option Feedback Message
URL: http://fhir.collabree.com/fhir/Extensions/questionnaire-answer-option-feedback-message
....... extension:translation 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... extension:score 1..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value[x] 1..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... initialSelected 0..1 boolean Whether option is selected by default
..... initial C 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.
....... 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 C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.subjectType Base required ResourceType 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.code.code Base required Collabree Questionnaire Category Value Set 📦0.1.0 This IG
Questionnaire.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item:question.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item:question.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-0 warning Questionnaire Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1 error Questionnaire.item, Questionnaire.item:question 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item, Questionnaire.item:question Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item, Questionnaire.item:question A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen, Questionnaire.item:question.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item, Questionnaire.item:question Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item, Questionnaire.item:question Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item, Questionnaire.item:question 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, Questionnaire.item:question If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item, Questionnaire.item:question If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item, Questionnaire.item:question Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 10 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Questionnaire.item (Closed)

 

Other representations of profile: CSV, Excel, Schematron