Structured Data Capture
3.0.0 - STU 3 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: SDC Base Questionnaire

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire Version: 3.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SDCBaseQuestionnaire

Sets minimum expectations for questionnaire support for SDC-conformant systems, regardless of which SDC capabilities they’re making use of.

Scope and Usage

This profile sets base expectations for use of the Questionnaire resource in all use-cases supported by this implementation guide. It forms foundation for most other Questionnaire profiles within this guide and represents information that is going to be necessary regardless of how the Questionnaire is being used. It identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the Questionnaire use-cases.

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 0..*QuestionnaireA structured set of questions
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... url S1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version S0..1stringBusiness version of the questionnaire
... title S0..1stringName for this questionnaire (human friendly)
... status S1..1codedraft | active | retired | unknown
... subjectType S0..*codeResource that can be subject of QuestionnaireResponse
... item SC0..*BackboneElementQuestions and sections within the Questionnaire
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
.... required S0..1booleanWhether the item must be included in data results
.... repeats S0..1booleanWhether the item may repeat
.... readOnly S0..1booleanDon't allow human editing
.... maxLength S0..1integerNo more than this many characters
.... answerValueSet S0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption S0..*BackboneElementPermitted answer
.... initial S0..*BackboneElementInitial value(s) when item is first rendered
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
.... item S0..*Nested questionnaire items

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireA structured set of questions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ0..1stringBusiness version of the questionnaire
... title SΣ0..1stringName for this questionnaire (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..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
..... 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)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption SC0..*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 SC0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S1..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 SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredResourceType
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
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())
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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title SΣ0..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ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
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..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 S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..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 SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption SC0..*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 SC0..*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] S1..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 SC0..*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
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*QuestionnaireA structured set of questions
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... url S1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version S0..1stringBusiness version of the questionnaire
... title S0..1stringName for this questionnaire (human friendly)
... status S1..1codedraft | active | retired | unknown
... subjectType S0..*codeResource that can be subject of QuestionnaireResponse
... item SC0..*BackboneElementQuestions and sections within the Questionnaire
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
.... required S0..1booleanWhether the item must be included in data results
.... repeats S0..1booleanWhether the item may repeat
.... readOnly S0..1booleanDon't allow human editing
.... maxLength S0..1integerNo more than this many characters
.... answerValueSet S0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption S0..*BackboneElementPermitted answer
.... initial S0..*BackboneElementInitial value(s) when item is first rendered
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
.... item S0..*Nested questionnaire items

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ0..1stringBusiness version of the questionnaire
... title SΣ0..1stringName for this questionnaire (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..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
..... 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)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption SC0..*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 SC0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S1..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 SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredResourceType
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
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title SΣ0..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ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
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..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 S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..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 SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC Value Set)Valueset containing permitted answers
.... answerOption SC0..*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 SC0..*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] S1..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 SC0..*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
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Derived Questionnaires

It is possible to construct Questionnaires that are derived from a 'parent' Questionnaire. The derived Questionnaire is fully compatible with the base Questionnaire, but it may make certain changes:

  • It might remove certain optional items (see the optionalDisplay extension)
  • It might introduce additional extensions that allow the Questionnaire to be populated and/or extracted
  • It might tighten rendering expectations to align with the capabilities of particular rendering tools
  • It might provide translations of the Questionnaire into alternate languages

In all cases, the answers to the derived Questionnaire must be valid as answers against the 'base' Questionnaire. It is also legal for the QuestionnaireResponse.questionnaire to point to the base Questionnaire rather than the derived Questionnaire. A Questionnaire indicates that it is derived by pointing to the base Questionnaire using Questionnaire.derivedFrom. In this scenario, there must be exactly one 'derivedFrom' form specified.

Language and translations

In some environments, it may be necessary for a questionnaire to support multiple languages. The rendering tool would select the appropriate language based on a configuration setting, or perhaps would display all available languages and the user would read the one they are familiar with. Systems MAY choose to provide support for identifying language and translations. If they do, they MAY do so using the generic language and translation extensions FHIR defines based on the ISO21090 data type specification:

  • iso21090-st-language allows the language of a particular (or any other data type) to be identified
  • iso21090-st-translation allows additional repetitions in alternate languages to be communicated. (The language for each translation would be communicated using the above #language extension)

These extensions can be used on absolutely any string element on Questionnaire, ValueSet, or any other resource. The base string should be the primary language of the questionnaire. It is what will be rendered by systems that do not support the translation extension or by systems whose language preference is other than one of the languages provided.

The ISO 19763 specification permits declaring language on questionnaire titles, descriptions, display names for codes and many other strings. It also supports capturing multiple variants of these strings with distinct languages. These capabilities can be mirrored using the above extensions.

An alternative is to define an extension to the Questionnaire providing a pointer to an externally maintained set of extensions. This approach allows the translations to be maintained independently of the resource which has both positive and negative impacts, particularly with respect to resource signature.

Open Issue: Should this profile define such an extension and/or a resource for managing such translations?