Da Vinci - Documentation Templates and Rules
2.1.0-preview - STU 2 United States of America flag

Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions

Resource Profile: DTR Questionnaire for adaptive form Search

Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt-search Version: 2.1.0-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: DTRQuestionnaireAdaptSearch

The DTR adaptive Questionnaire is used to represent an adaptive Questionnaire when returning the empty Questionnaire in a Questionnaire package.

While aligned with the SDC Adaptive Questionnaire Search profile, this profile does not derive from that profile because elements that SDC make mustSupport for search purposes are not needed for the DTR use case. (EHRs do not need to search for relevant Questionnaires).

Usage:

Formal Views of Profile Content

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

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..* SDCBaseQuestionnaire A structured set of questions
... extension:terminologyServer S 0..* PreferredTerminologyServer Preferred terminology server
... extension:assemble-expectation 0..0
... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... extension 0..0
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.

... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... effectivePeriod S 0..1 Period Validity period for the Questionnaire
... item
.... extension:terminologyServer 0..* PreferredTerminologyServer Preferred terminology server

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire A structured set of questions
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer S 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
... styleSensitive 0..1 (Complex) Are styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode"
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.


... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-library"
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ 0..1 string Business version of the questionnaire
... title SΣ 0..1 string Name for this questionnaire (human friendly)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ 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.


... effectivePeriod SΣ 0..1 Period Validity period for the Questionnaire
... item SC 0..* BackboneElement Questions and sections within the Questionnaire
que-1: Group items must have nested items, display items cannot have nested items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only 'choice' and 'open-choice' items can have answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial[x] must be missing
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Unique id for item in questionnaire
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text S 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C 0..* BackboneElement Only allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... 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)
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength SC 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC ValueSet) Valueset containing permitted answers
.... answerOption SC 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 SC 0..* BackboneElement Initial value(s) when item is first rendered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 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..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Questionnaire.subjectTyperequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire A structured set of questions
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer S 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S 0..* code Resource 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.


... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
... styleSensitive 0..1 (Complex) Are styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode"
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.


... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-library"
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version SΣ 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 for this questionnaire (human friendly)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1 string Primitive value for string
Max Length: 1048576
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod SΣ 0..1 Period Validity period for the Questionnaire
... code Σ 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


... item SC 0..* BackboneElement Questions and sections within the Questionnaire
que-1: Group items must have nested items, display items cannot have nested items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only 'choice' and 'open-choice' items can have answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial[x] must be missing
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Unique id for item in questionnaire
.... definition 0..1 uri ElementDefinition - details for the item
.... code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text S 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C 0..* BackboneElement Only allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] 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 SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength SC 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC ValueSet) Valueset containing permitted answers
.... answerOption SC 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 SC 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] S 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..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Questionnaire.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Questionnaire.subjectTyperequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
Questionnaire.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/questionnaire-questions
from the FHIR Standard
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/questionnaire-questions
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard

Differential View

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..* SDCBaseQuestionnaire A structured set of questions
... extension:terminologyServer S 0..* PreferredTerminologyServer Preferred terminology server
... extension:assemble-expectation 0..0
... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... extension 0..0
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.

... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... effectivePeriod S 0..1 Period Validity period for the Questionnaire
... item
.... extension:terminologyServer 0..* PreferredTerminologyServer Preferred terminology server

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire A structured set of questions
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer S 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
... styleSensitive 0..1 (Complex) Are styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode"
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.


... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-library"
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ 0..1 string Business version of the questionnaire
... title SΣ 0..1 string Name for this questionnaire (human friendly)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ 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.


... effectivePeriod SΣ 0..1 Period Validity period for the Questionnaire
... item SC 0..* BackboneElement Questions and sections within the Questionnaire
que-1: Group items must have nested items, display items cannot have nested items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only 'choice' and 'open-choice' items can have answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial[x] must be missing
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Unique id for item in questionnaire
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text S 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C 0..* BackboneElement Only allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... 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)
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength SC 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC ValueSet) Valueset containing permitted answers
.... answerOption SC 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 SC 0..* BackboneElement Initial value(s) when item is first rendered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 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..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Questionnaire.subjectTyperequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire A structured set of questions
que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
que-2: The link ids for groups and questions must be unique within the questionnaire
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer S 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S 0..* code Resource 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.


... questionnaireAdaptive S 0..* boolean, url Marks a questionnaire as being adaptive.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive
... styleSensitive 0..1 (Complex) Are styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... value[x] 1..1 boolean Value of extension
Required Pattern: false
... entryMode S 0..* (Complex) sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode"
.... value[x] 0..1 code Value of extension
Binding: Questionnaire Entry Mode (required)
... signatureRequired S 0..1 CodeableConcept There's a cost to support this.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.


... cqf-library S 0..* (Complex) The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above.
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-library"
.... value[x] 1..1 canonical(SDCLibrary) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version SΣ 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 for this questionnaire (human friendly)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... titleRenderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... titleRenderingXhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1 string Primitive value for string
Max Length: 1048576
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod SΣ 0..1 Period Validity period for the Questionnaire
... code Σ 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


... item SC 0..* BackboneElement Questions and sections within the Questionnaire
que-1: Group items must have nested items, display items cannot have nested items
que-3: Display items cannot have a "code" asserted
que-4: A question cannot have both answerOption and answerValueSet
que-5: Only 'choice' and 'open-choice' items can have answerValueSet
que-6: Required and repeat aren't permitted for display items
que-8: Initial values can't be specified for groups or display items
que-9: Read-only can't be specified for "display" items
que-10: Maximum length can only be declared for simple question types
que-11: If one or more answerOption is present, initial[x] must be missing
que-12: If there are more than one enableWhen, enableBehavior must be specified
que-13: Can only have multiple initial values for repeating items
sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId S 1..1 string Unique id for item in questionnaire
.... definition 0..1 uri ElementDefinition - details for the item
.... code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text S 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C 0..* BackboneElement Only allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] 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 SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength SC 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC ValueSet) Valueset containing permitted answers
.... answerOption SC 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 SC 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] S 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..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Questionnaire.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Questionnaire.extension:entryMode.value[x]requiredQuestionnaireEntryMode
http://hl7.org/fhir/uv/sdc/ValueSet/entryMode
Questionnaire.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Questionnaire.subjectTyperequiredResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
Questionnaire.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/questionnaire-questions
from the FHIR Standard
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/questionnaire-questions
from the FHIR Standard
Questionnaire.item.typerequiredQuestionnaireItemType
http://hl7.org/fhir/ValueSet/item-type|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1
from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1
from the FHIR Standard
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron