CH ORF (R4)
2.0.1 - trial-use Switzerland flag

This page is part of the CH ORF (R4) (v2.0.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH ORF Questionnaire

Official URL: http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-questionnaire Version: 2.0.1
Active as of 2023-12-28 Computable Name: ChOrfQuestionnaire

Copyright/Legal: CC0-1.0

Profile to define how a CH ORF-conformant Questionnaire resource must be structured. This is independent of the content and content structure of the questionnaire instance itself.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*SDCBaseQuestionnaireCH ORF Questionnaire
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ0..1stringBusiness version of the questionnaire
... title SΣ0..1stringName for this questionnaire (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

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

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

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

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

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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly 'choice' and 'open-choice' items can have answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*SDCBaseQuestionnaireCH ORF Questionnaire
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


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

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


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


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


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


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

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

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

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

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

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

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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly 'choice' and 'open-choice' items can have answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

This structure is derived from SDCBaseQuestionnaire

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*SDCBaseQuestionnaireCH ORF Questionnaire
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... assemble-expectation S0..1codeQuestionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... version SΣ0..1stringBusiness version of the questionnaire
... title SΣ0..1stringName for this questionnaire (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

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

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

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly SC0..1booleanDon't allow human editing
.... maxLength SC0..1integerNo more than this many characters
.... answerValueSet SC0..1canonical(SDC ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

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

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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly 'choice' and 'open-choice' items can have answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

Snapshot View

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

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... performerType S0..*codeResource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.


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

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


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


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


... item SC0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote 0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... terminologyServer 0..*urlPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


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

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

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

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

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

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

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

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly 'choice' and 'open-choice' items can have answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
sdc-1errorQuestionnaire.itemAn item cannot have an answerExpression if answerOption or answerValueSet is already present.
: extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty())

This structure is derived from SDCBaseQuestionnaire

Summary

 

Other representations of profile: CSV, Excel, Schematron