Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
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 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
| Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt-search | Version: 2.1.0 | |||
| 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).
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions Constraints: que-0, que-2 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| extension:terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| extension: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. |
 extension:questionnaireAdaptive |
S | 1..* | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |
 value[x] |
0..1 | url | Value of extension | |
| extension: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 | |
| extension:entryMode |
S | 0..1 | (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) | |
| extension: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. |
 extension: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 | |
| extension:titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
 extension: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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode | |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1From the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1From the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |
This structure is derived from SDCBaseQuestionnaire
| Path | Conformance | ValueSet | URI |
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions Constraints: que-0, que-2 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| extension:terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | ||||
| extension: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. | ||||
| extension:questionnaireAdaptive |
S | 1..* | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | ||||
| 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-questionnaireAdaptive" | |||||
| value[x] |
0..1 | url | Value of extension | |||||
| extension: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 | |||||
| extension:entryMode |
S | 0..1 | (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) | |||||
| extension: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. | ||||
| extension: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 | |||||
| extension:titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| extension: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. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode | ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionFrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsFrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsFrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |
This structure is derived from SDCBaseQuestionnaire
Summary
Mandatory: 2 elements
Must-Support: 6 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions Constraints: que-0, que-2 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| extension:terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| extension: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. |
| extension:questionnaireAdaptive |
S | 1..* | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |
| value[x] |
0..1 | url | Value of extension | |
| extension: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 | |
| extension:entryMode |
S | 0..1 | (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) | |
| extension: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. |
| extension: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 | |
| extension:titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| extension: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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode | |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | |
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1From the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1From the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |
Differential View
This structure is derived from SDCBaseQuestionnaire
| Path | Conformance | ValueSet | URI |
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions Constraints: que-0, que-2 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| extension:terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | ||||
| extension: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. | ||||
| extension:questionnaireAdaptive |
S | 1..* | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | ||||
| 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-questionnaireAdaptive" | |||||
| value[x] |
0..1 | url | Value of extension | |||||
| extension: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 | |||||
| extension:entryMode |
S | 0..1 | (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) | |||||
| extension: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. | ||||
| extension: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 | |||||
| extension:titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| extension: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. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Questionnaire.extension:entryMode.value[x] | required | QuestionnaireEntryModehttp://hl7.org/fhir/uv/sdc/ValueSet/entryMode | ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1From the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionFrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsFrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsFrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |
This structure is derived from SDCBaseQuestionnaire
Summary
Mandatory: 2 elements
Must-Support: 6 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.us.davinci-dtr#2.1.0 based on FHIR 4.0.1. Generated 2025-06-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
Slices for extension