Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0-ballot - ballot United States of America flag

This page is part of the electronic Long-Term Services and Supports Implementation Guide (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: eLTSS Questionnaire Profile

Official URL: http://hl7.org/fhir/us/eltss/StructureDefinition/Questionnaire-eltss Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: Questionnaire_eltss

Questionnaire resource mapping for eLTSS

Implementer mapping guidance

The following aids in finding the location of eLTSS data elements. See R4 FHIR Mapping page for complete guidance, here we are providing a subset of fields for convenience.

eLTSS Grouping eLTSS Data Element Name Data Element Definition (includes examples, expected list of values and usage note where applicable) FHIR R4 Resource Element(s) FHIR R4 Resource Element Cardinality (with US Core Constraints) Additional Mapping Details Important change
Person Centered Planning Person Setting Choice Indicator Indicator that reflects the setting in which the person resides is chosen by the individual. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Person Centered Planning Person Setting Choice Options The alternative home and community-based settings that were considered by the individual. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueString
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueString 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueString is the actual text of the response to a question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The values "string" (for a few words or short sentence) or "text" (potentially multi-paragraph) would apply here.
Person Centered Planning Service Options Given Indicator States whether or not the person was given a choice of services outlined in the plan. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Person Centered Planning Service Selection Indicator States whether or not the person participated in the selection of the services outlined in the plan. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Person Centered Planning Service Plan Agreement Indicator States whether or not the person agrees to the services outlined in the plan. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Person Centered Planning Service Provider Options Given Indicator States whether or not the person was offered a choice of providers for each service. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Person Centered Planning Service Provider Selection Agreement Indicator States whether or not the person feels he/she made an informed choice in selecting the provider for each service. CarePlan → supportingInfo(Questionnaire)

Questionnaire → item → linkID
Questionnaire → item → text
Questionnaire → item → type
------------------------------------------
QuestionnaireResponse
→ questionnaire(Questionnaire)
QuestionnaireResponse → item → linkID
QuestionnaireResponse → item → answer
→ valueBoolean
CarePlan
...supportingInfo(Questionnaire) 0..*
......item 0..*
.........linkID 1
.........text 0..1
.........type 1
------------------------
QuestionnaireResponse
...questionnaire(Questionnaire) 0..1
...item 0..*
......linkID 1
......answer 0..*
.........valueBoolean 0..1
1) Will use CarePlan → supportingInfo to reference the Questionnaire for the care plan being developed.
2) QuestionnaireResponse references the Questionnaire.
3) QuestionnaireResponse and Questionnaire both include one or more item elements, where each item documents a question or answer to a question.
4) item includes a mandatory linkID used to link the response to the question it applies to.
5) valueBoolean is the actual response to the question.
6) text is the actual text of the question in the Questionnaire.
7) type is required by FHIR and indicates what kind of question this is. Values must come from the QuestionnaireItemType value set which includes: group, display, boolean, decimal, integer, date, dateTime, etc. The value "boolean" would apply here. Boolean "true" would indicate "yes".
Data Requirements Not Specific to eLTSS Dataset Data Elements
This section documents data elements that are mandatory per FHIR XML schemas or US Core requirements, but that do not align with individual eLTSS Dataset data elements.
FHIR Data Element Name
Requirement Source
Data Element Definition FHIR R4 Resource Element(s) FHIR R4 Resource Element Cardinality (with US Core Constraints) Additional Mapping Details
QuestionnaireResponse Status
FHIR
The position of the questionnaire response within its overall lifecycle. QuestionnaireResponse → status QuestionnaireResponse
...status 1
1) status is required by FHIR and must use the QuestionnaireResponseStatus value set. Possible values are: in-progress, completed, amended, entered-in-error, and stopped.
Questionnaire Status
FHIR
The status of this questionnaire. Enables tracking the life-cycle of the content. Questionnaire → status Questionnaire
...status 1
1) status is required by FHIR and must use the PublicationStatus value set. Possible values are: draft, active, retired, and unknown.

Usage:

Formal Views of Profile Content

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

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire Questionnaire
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... item S0..*BackboneElementQuestions and sections within the Questionnaire
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireA structured set of questions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.statusrequiredPublicationStatus
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireA structured set of questions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the questionnaire
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text 0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required C0..1booleanWhether the item must be included in data results
.... repeats C0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item C0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredResourceType
Questionnaire.jurisdictionextensibleJurisdiction ValueSet
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire Questionnaire
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... item S0..*BackboneElementQuestions and sections within the Questionnaire
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireA structured set of questions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.statusrequiredPublicationStatus
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireA structured set of questions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire_eltss)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the questionnaire
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text 0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required C0..1booleanWhether the item must be included in data results
.... repeats C0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item C0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredResourceType
Questionnaire.jurisdictionextensibleJurisdiction ValueSet
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron