BfArM Digitale Anwendungen
3.0.2-RC1 - draft

BfArM Digitale Anwendungen - Local Development build (v3.0.2-RC1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HiisQuestionnaire

Official URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaire Version: 3.0.2-RC1
Draft as of 2026-02-25 Computable Name: HiisQuestionnaire

Definition of a questionnaire that is answered by the manufacturer of an interface for a medical aid or implant as part of an application for inclusion in the HIIS catalog.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 SC 0..* Questionnaire Questionnaire
Constraints: que-0, que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 0..1 uri URL
.... identifier:hiisQuestionnaireId SΣ 1..1 Identifier HIIS Questionnaire ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... title SΣ 0..1 string Name
... status ?!SΣ 1..1 code Status
Binding: ValueSet for HiisQuestionnaireStatus (required)
... date SΣ 0..1 dateTime Date
... description S 0..1 markdown Description
... item SC 0..* BackboneElement Assessments
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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Assessment-ID
.... text S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... 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 SC 0..* BackboneElement Question blocks
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId S 1..1 string Question block-ID
..... text S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... 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 SC 0..* BackboneElement Questions
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... linkId S 1..1 string Question-ID
...... text S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... 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 SC 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption SC 0..* BackboneElement Permitted answer
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for value[x] 1..1 Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
........ valueInteger integer
........ valueDate date
........ valueTime time
........ valueString string
........ valueCoding Coding
........ valueReference Reference(Resource)
........ value[x]:valueString S 0..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.identifier:hiisQuestionnaireId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
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.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x]:valueString Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.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 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 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-7 error Questionnaire.item.enableWhen, Questionnaire.item.item.enableWhen, Questionnaire.item.item.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
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

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire S 0..* Questionnaire Questionnaire
... url S 0..1 uri URL
... Slices for identifier S 1..* Identifier IDs
Slice: Unordered, Open by value:system
.... identifier:hiisQuestionnaireId S 1..1 Identifier HIIS Questionnaire ID
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value S 1..1 string The value that is unique
... title S 0..1 string Name
... date S 0..1 dateTime Date
... description S 0..1 markdown Description
... item S 0..* BackboneElement Assessments
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... linkId S 1..1 string Assessment-ID
.... text S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... item S 0..* BackboneElement Question blocks
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... linkId S 1..1 string Question block-ID
..... text S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... item S 0..* BackboneElement Questions
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... linkId S 1..1 string Question-ID
...... text S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... answerValueSet S 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption S 0..* BackboneElement Permitted answer
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... Slices for value[x] 1..1 integer, date, time, string, Coding, Reference(Resource) Answer value
Slice: Unordered, Open by type:$this
........ value[x]:valueString S 0..1 string Answer value

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire SC 0..* Questionnaire Questionnaire
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 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 SΣ 0..1 uri URL
... Slices for identifier SΣ 1..* Identifier IDs
Slice: Unordered, Open by value:system
.... identifier:hiisQuestionnaireId SΣ 1..1 Identifier HIIS Questionnaire ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version Σ 0..1 string Business version of the questionnaire
... name ΣC 0..1 string Name for this questionnaire (computer friendly)
... title SΣ 0..1 string Name
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code Status
Binding: ValueSet for HiisQuestionnaireStatus (required)
... 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 SΣ 0..1 dateTime Date
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Description
... 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 Σ 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
... item SC 0..* BackboneElement Assessments
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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Assessment-ID
.... 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 S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... 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 SC 0..* BackboneElement Question blocks
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId S 1..1 string Question block-ID
..... 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 S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... 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 SC 0..* BackboneElement Questions
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... linkId S 1..1 string Question-ID
...... 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 S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... 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 SC 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption SC 0..* BackboneElement Permitted answer
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for value[x] 1..1 Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
........ valueInteger integer
........ valueDate date
........ valueTime time
........ valueString string
........ valueCoding Coding
........ valueReference Reference(Resource)
........ value[x]:valueString S 0..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.identifier:hiisQuestionnaireId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Questionnaire.identifier:hiisQuestionnaireId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
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.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
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.item.​code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.item.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x]:valueString Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.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 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 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-7 error Questionnaire.item.enableWhen, Questionnaire.item.item.enableWhen, Questionnaire.item.item.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
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

This structure is derived from Questionnaire

Summary

Mandatory: 4 elements
Must-Support: 32 elements
Fixed: 1 element

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.identifier
  • The element 1 is sliced based on the value of Questionnaire.item.item.item.answerOption.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire SC 0..* Questionnaire Questionnaire
Constraints: que-0, que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 0..1 uri URL
.... identifier:hiisQuestionnaireId SΣ 1..1 Identifier HIIS Questionnaire ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... title SΣ 0..1 string Name
... status ?!SΣ 1..1 code Status
Binding: ValueSet for HiisQuestionnaireStatus (required)
... date SΣ 0..1 dateTime Date
... description S 0..1 markdown Description
... item SC 0..* BackboneElement Assessments
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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Assessment-ID
.... text S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... 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 SC 0..* BackboneElement Question blocks
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId S 1..1 string Question block-ID
..... text S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... 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 SC 0..* BackboneElement Questions
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... linkId S 1..1 string Question-ID
...... text S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... 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 SC 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption SC 0..* BackboneElement Permitted answer
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for value[x] 1..1 Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
........ valueInteger integer
........ valueDate date
........ valueTime time
........ valueString string
........ valueCoding Coding
........ valueReference Reference(Resource)
........ value[x]:valueString S 0..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.identifier:hiisQuestionnaireId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
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.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x]:valueString Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.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 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 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-7 error Questionnaire.item.enableWhen, Questionnaire.item.item.enableWhen, Questionnaire.item.item.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
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

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire S 0..* Questionnaire Questionnaire
... url S 0..1 uri URL
... Slices for identifier S 1..* Identifier IDs
Slice: Unordered, Open by value:system
.... identifier:hiisQuestionnaireId S 1..1 Identifier HIIS Questionnaire ID
..... system S 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value S 1..1 string The value that is unique
... title S 0..1 string Name
... date S 0..1 dateTime Date
... description S 0..1 markdown Description
... item S 0..* BackboneElement Assessments
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... linkId S 1..1 string Assessment-ID
.... text S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... item S 0..* BackboneElement Question blocks
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... linkId S 1..1 string Question block-ID
..... text S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... item S 0..* BackboneElement Questions
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... linkId S 1..1 string Question-ID
...... text S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... answerValueSet S 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption S 0..* BackboneElement Permitted answer
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... Slices for value[x] 1..1 integer, date, time, string, Coding, Reference(Resource) Answer value
Slice: Unordered, Open by type:$this
........ value[x]:valueString S 0..1 string Answer value

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire SC 0..* Questionnaire Questionnaire
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 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 SΣ 0..1 uri URL
... Slices for identifier SΣ 1..* Identifier IDs
Slice: Unordered, Open by value:system
.... identifier:hiisQuestionnaireId SΣ 1..1 Identifier HIIS Questionnaire ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.bfarm.de/Identifier/HiisQuestionnaireId
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version Σ 0..1 string Business version of the questionnaire
... name ΣC 0..1 string Name for this questionnaire (computer friendly)
... title SΣ 0..1 string Name
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code Status
Binding: ValueSet for HiisQuestionnaireStatus (required)
... 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 SΣ 0..1 dateTime Date
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Description
... 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 Σ 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
... item SC 0..* BackboneElement Assessments
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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Assessment-ID
.... 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 S 0..1 string Name
.... type S 1..1 code Assessment type
Binding: ValueSet for HiisQuestionnaireItemType (required)
.... 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 SC 0..* BackboneElement Question blocks
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... linkId S 1..1 string Question block-ID
..... 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 S 0..1 string Name
..... type S 1..1 code Question block type
Binding: ValueSet for HiisQuestionnaireItemType (required)
..... 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 SC 0..* BackboneElement Questions
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... linkId S 1..1 string Question-ID
...... 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 S 0..1 string Question text
...... type S 1..1 code Question type
Binding: ValueSet for HiisQuestionnaireQuestionItemType (required)
...... 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 SC 0..1 canonical(ValueSet) Valueset containing permitted answers
Example Selection from countries: http://hl7.org/fhir/ValueSet/iso3166-1-2
Example Selection from EBM codes: https://fhir.bfarm.de/ValueSet/HiisEbm
Example Selection from ICD codes: http://fhir.de/ValueSet/bfarm/icd-10-gm
Example Selection from languages: http://hl7.org/fhir/ValueSet/all-languages
...... answerOption SC 0..* BackboneElement Permitted answer
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:description S 0..1 (Complex) Descriptive texts
URL: https://fhir.bfarm.de/StructureDefinition/HiisQuestionnaireItemDescription
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... Slices for value[x] 1..1 Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
........ valueInteger integer
........ valueDate date
........ valueTime time
........ valueString string
........ valueCoding Coding
........ valueReference Reference(Resource)
........ value[x]:valueString S 0..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.identifier:hiisQuestionnaireId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Questionnaire.identifier:hiisQuestionnaireId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Questionnaire.status Base required ValueSet for HiisQuestionnaireStatus 📦3.0.2-RC1 This IG
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.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
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.item.​code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​type Base required ValueSet for HiisQuestionnaireItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.item.​answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​initial.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.type Base required ValueSet for HiisQuestionnaireQuestionItemType 📦3.0.2-RC1 This IG
Questionnaire.item.item.​item.enableWhen.operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableWhen.answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.answerOption.value[x]:valueString Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.item.​item.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 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 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-7 error Questionnaire.item.enableWhen, Questionnaire.item.item.enableWhen, Questionnaire.item.item.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
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

This structure is derived from Questionnaire

Summary

Mandatory: 4 elements
Must-Support: 32 elements
Fixed: 1 element

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.identifier
  • The element 1 is sliced based on the value of Questionnaire.item.item.item.answerOption.value[x]

 

Other representations of profile: CSV, Excel, Schematron