Vaccination CDS Implementation Guide
0.1.0 - ci-build
Vaccination CDS Implementation Guide, published by Euvabeco. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/EUVABECO/VCDS/ and changes regularly. See the Directory of published versions
Official URL: https://euvabeco.net/vcds-ig/StructureDefinition/Questionnaire | Version: 0.1.0 | |||
Draft as of 2024-10-25 | Computable Name: Questionnaire |
In this questionnaire, the relevant conditions for the CDS are identified with a persistent code from the Conditions code system.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | Questionnaire | A structured set of questions | |
version | 1..1 | string | Version of the CDS rules corresponding to the questionnaire | |
item | ||||
code | 0..* | Coding | Mandatory for actual conditions Binding: Persistent codes for conditions (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.item.code | required | Conditions (a valid code from Conditions used in a patient profile)https://euvabeco.net/vcds-ig/ValueSet/Conditions from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | C | 0..* | Questionnaire | A structured set of questions cnl-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 |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
version | Σ | 1..1 | string | Version of the CDS rules corresponding to the questionnaire |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | C | 0..* | Questionnaire | A structured set of questions cnl-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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Business identifier for questionnaire | ||||
version | Σ | 1..1 | string | Version of the CDS rules corresponding to the questionnaire | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
derivedFrom | Σ | 0..* | canonical(Questionnaire) | Based on Questionnaire | ||||
status | ?!ΣC | 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 | Σ | 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/steward (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: JurisdictionValueSet (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 | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
item | C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or 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 cannot be present. Use answerOption.initialSelected instead que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) | ||||
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 | ||||
linkId | C | 1..1 | string | Unique id for item in questionnaire que-15: Link ids should be 255 characters or less | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
code | C | 0..* | Coding | Mandatory for actual conditions Binding: Persistent codes for conditions (required) | ||||
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |||||
text | 0..1 | string | Primary text for the item | |||||
type | C | 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 | The linkId of question that determines whether item is enabled/disabled | |||||
operator | C | 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. | ||||
disabledDisplay | 0..1 | code | hidden | protected Binding: QuestionnaireItemDisabledDisplay (required): Defines how disabled elements should be rendered | |||||
required | C | 0..1 | boolean | Whether the item must be included in data results | ||||
repeats | C | 0..1 | boolean | Whether the item may repeat | ||||
readOnly | C | 0..1 | boolean | Don't allow human editing | ||||
maxLength | C | 0..1 | integer | No more than these many characters | ||||
answerConstraint | C | 0..1 | code | optionsOnly | optionsOrType | optionsOrString Binding: QuestionnaireAnswerConstraint (required): Indicates differnt modes for restricting values when options or valueset are specified | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | ValueSet containing permitted answers | ||||
answerOption | C | 0..* | BackboneElement | Permitted answer | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
valueReference | Reference(Resource) | |||||||
initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
initial | C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | 0..* | See item (Questionnaire) | Nested questionnaire items | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Questionnaire.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 from the FHIR Standard | |
Questionnaire.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | |
Questionnaire.item.code | required | Conditions (a valid code from Conditions used in a patient profile)https://euvabeco.net/vcds-ig/ValueSet/Conditions from this IG | |
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|5.0.0 from the FHIR Standard | |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0 from the FHIR Standard | |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|5.0.0 from the FHIR Standard | |
Questionnaire.item.disabledDisplay | required | QuestionnaireItemDisabledDisplayhttp://hl7.org/fhir/ValueSet/questionnaire-disabled-display|5.0.0 from the FHIR Standard | |
Questionnaire.item.answerConstraint | required | QuestionnaireAnswerConstrainthttp://hl7.org/fhir/ValueSet/questionnaire-answer-constraint|5.0.0 from the FHIR Standard | |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Questionnaire.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet : (type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 1 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) : answerConstraint.exists() implies answerOption.exists() or answerValueSet.exists() | |
que-15 | warning | Questionnaire.item.linkId | Link ids should be 255 characters or less : $this.length() <= 255 |
This structure is derived from Questionnaire
Differential View
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | Questionnaire | A structured set of questions | |
version | 1..1 | string | Version of the CDS rules corresponding to the questionnaire | |
item | ||||
code | 0..* | Coding | Mandatory for actual conditions Binding: Persistent codes for conditions (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.item.code | required | Conditions (a valid code from Conditions used in a patient profile)https://euvabeco.net/vcds-ig/ValueSet/Conditions from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | C | 0..* | Questionnaire | A structured set of questions cnl-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 |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
version | Σ | 1..1 | string | Version of the CDS rules corresponding to the questionnaire |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | C | 0..* | Questionnaire | A structured set of questions cnl-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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Business identifier for questionnaire | ||||
version | Σ | 1..1 | string | Version of the CDS rules corresponding to the questionnaire | ||||
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
versionAlgorithmString | string | |||||||
versionAlgorithmCoding | Coding | |||||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
derivedFrom | Σ | 0..* | canonical(Questionnaire) | Based on Questionnaire | ||||
status | ?!ΣC | 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 | Σ | 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/steward (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: JurisdictionValueSet (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 | |||||
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |||||
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed by the publisher | |||||
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
item | C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or 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 cannot be present. Use answerOption.initialSelected instead que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items que-14: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) | ||||
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 | ||||
linkId | C | 1..1 | string | Unique id for item in questionnaire que-15: Link ids should be 255 characters or less | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
code | C | 0..* | Coding | Mandatory for actual conditions Binding: Persistent codes for conditions (required) | ||||
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |||||
text | 0..1 | string | Primary text for the item | |||||
type | C | 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 | The linkId of question that determines whether item is enabled/disabled | |||||
operator | C | 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. | ||||
disabledDisplay | 0..1 | code | hidden | protected Binding: QuestionnaireItemDisabledDisplay (required): Defines how disabled elements should be rendered | |||||
required | C | 0..1 | boolean | Whether the item must be included in data results | ||||
repeats | C | 0..1 | boolean | Whether the item may repeat | ||||
readOnly | C | 0..1 | boolean | Don't allow human editing | ||||
maxLength | C | 0..1 | integer | No more than these many characters | ||||
answerConstraint | C | 0..1 | code | optionsOnly | optionsOrType | optionsOrString Binding: QuestionnaireAnswerConstraint (required): Indicates differnt modes for restricting values when options or valueset are specified | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | ValueSet containing permitted answers | ||||
answerOption | C | 0..* | BackboneElement | Permitted answer | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
valueReference | Reference(Resource) | |||||||
initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
initial | C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | 0..* | See item (Questionnaire) | Nested questionnaire items | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Questionnaire.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|5.0.0 from the FHIR Standard | |
Questionnaire.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | |
Questionnaire.item.code | required | Conditions (a valid code from Conditions used in a patient profile)https://euvabeco.net/vcds-ig/ValueSet/Conditions from this IG | |
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|5.0.0 from the FHIR Standard | |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|5.0.0 from the FHIR Standard | |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|5.0.0 from the FHIR Standard | |
Questionnaire.item.disabledDisplay | required | QuestionnaireItemDisabledDisplayhttp://hl7.org/fhir/ValueSet/questionnaire-disabled-display|5.0.0 from the FHIR Standard | |
Questionnaire.item.answerConstraint | required | QuestionnaireAnswerConstrainthttp://hl7.org/fhir/ValueSet/questionnaire-answer-constraint|5.0.0 from the FHIR Standard | |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Questionnaire.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet : (type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 1 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) : answerConstraint.exists() implies answerOption.exists() or answerValueSet.exists() | |
que-15 | warning | Questionnaire.item.linkId | Link ids should be 255 characters or less : $this.length() <= 255 |
This structure is derived from Questionnaire
Other representations of profile: CSV, Excel, Schematron