3.0.1 - STU Ballot

This page is part of the Documentation Templates and Rules (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: DTRQuestionnaireSTU3

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-dtr/STU3/StructureDefinition/dtr-questionnaire-stu3

Formal Views of Profile Content

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

This structure is derived from CQIF-Questionnaire

Summary

Mandatory: 5 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

This structure is derived from CQIF-Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A questionnaire with the ability to specify behavior associated with questions or groups of questions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... cqif-library 1..*Reference(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqif-library
Slice: Unordered, Open by value:url
... cqif-library I0..*Reference(Library)A library containing logic referenced by the questionnaire
URL: http://hl7.org/fhir/StructureDefinition/cqif-library
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this questionnaire (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ0..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... 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
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ1..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example)
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... cqif-calculatedValue I0..1stringA calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqif-calculatedValue
Slice: Unordered, Open by value:url
dtrq-1: Non-group items must have the cqf-expression extension
.... cqif-condition I0..1stringA condition that determines whether or not the group is applicable
URL: http://hl7.org/fhir/StructureDefinition/cqif-condition
.... cqif-initialValue I0..1stringAn expression that provides the initial value for the answer to the question
URL: http://hl7.org/fhir/StructureDefinition/cqif-initialValue
.... cqif-calculatedValue I0..1stringAn expression that provides a calculated value for the answer to the question
URL: http://hl7.org/fhir/StructureDefinition/cqif-calculatedValue
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code ΣI0..*CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text Σ0..1stringPrimary text for the item
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!ΣI0..*BackboneElementOnly allow data when
que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question 1..1stringQuestion that determines whether item is enabled
..... hasAnswer I0..1booleanEnable when answered or not
..... answer[x] I0..1Value question must have
Binding: Questionnaire Answer Codes (example)
...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerUriuri
...... answerAttachmentAttachment
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(http://hl7.org/fhir/STU3/resource.html)
.... required I0..1booleanWhether the item must be included in data results
.... repeats I0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... options I0..1Reference(ValueSet)Valueset containing permitted answers
.... option I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cqif-optionCode I0..*CodeableConceptMeaning of the response option
URL: http://hl7.org/fhir/StructureDefinition/cqif-optionCode
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1Answer value
Binding: Questionnaire Answer Codes (example)
...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
.... initial[x] I0..1Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
..... initialBooleanboolean
..... initialDecimaldecimal
..... initialIntegerinteger
..... initialDatedate
..... initialDateTimedateTime
..... initialTimetime
..... initialStringstring
..... initialUriuri
..... initialAttachmentAttachment
..... initialCodingCoding
..... initialQuantityQuantity
..... initialReferenceReference(http://hl7.org/fhir/STU3/resource.html)
.... item I0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

This structure is derived from CQIF-Questionnaire

Summary

Mandatory: 5 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from CQIF-Questionnaire

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A questionnaire with the ability to specify behavior associated with questions or groups of questions
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... cqif-library 1..*Reference(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqif-library
Slice: Unordered, Open by value:url
... cqif-library I0..*Reference(Library)A library containing logic referenced by the questionnaire
URL: http://hl7.org/fhir/StructureDefinition/cqif-library
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this questionnaire (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ0..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... 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
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ1..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example)
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... cqif-calculatedValue I0..1stringA calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqif-calculatedValue
Slice: Unordered, Open by value:url
dtrq-1: Non-group items must have the cqf-expression extension
.... cqif-condition I0..1stringA condition that determines whether or not the group is applicable
URL: http://hl7.org/fhir/StructureDefinition/cqif-condition
.... cqif-initialValue I0..1stringAn expression that provides the initial value for the answer to the question
URL: http://hl7.org/fhir/StructureDefinition/cqif-initialValue
.... cqif-calculatedValue I0..1stringAn expression that provides a calculated value for the answer to the question
URL: http://hl7.org/fhir/StructureDefinition/cqif-calculatedValue
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code ΣI0..*CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text Σ0..1stringPrimary text for the item
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!ΣI0..*BackboneElementOnly allow data when
que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question 1..1stringQuestion that determines whether item is enabled
..... hasAnswer I0..1booleanEnable when answered or not
..... answer[x] I0..1Value question must have
Binding: Questionnaire Answer Codes (example)
...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerUriuri
...... answerAttachmentAttachment
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(http://hl7.org/fhir/STU3/resource.html)
.... required I0..1booleanWhether the item must be included in data results
.... repeats I0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... options I0..1Reference(ValueSet)Valueset containing permitted answers
.... option I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cqif-optionCode I0..*CodeableConceptMeaning of the response option
URL: http://hl7.org/fhir/StructureDefinition/cqif-optionCode
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1Answer value
Binding: Questionnaire Answer Codes (example)
...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
.... initial[x] I0..1Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
..... initialBooleanboolean
..... initialDecimaldecimal
..... initialIntegerinteger
..... initialDatedate
..... initialDateTimedateTime
..... initialTimetime
..... initialStringstring
..... initialUriuri
..... initialAttachmentAttachment
..... initialCodingCoding
..... initialQuantityQuantity
..... initialReferenceReference(http://hl7.org/fhir/STU3/resource.html)
.... item I0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Questionnaire.languageextensibleCommon Languages
Max Binding: All Languages
Questionnaire.statusrequiredPublicationStatus
Questionnaire.jurisdictionextensibleJurisdiction ValueSet
Questionnaire.codeexampleQuestionnaire Question Codes
Questionnaire.subjectTyperequiredResourceType
Questionnaire.item.codeexampleQuestionnaire Question Codes
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaire Answer Codes
Questionnaire.item.option.value[x]exampleQuestionnaire Answer Codes
Questionnaire.item.initial[x]exampleQuestionnaire Answer Codes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4QuestionnaireIf 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-3QuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
que-2QuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
ele-1Questionnaire.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.itemAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-9Questionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-8Questionnaire.itemDefault values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-6Questionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-5Questionnaire.itemOnly 'choice' items can have options
: (type ='choice' or type = 'open-choice') or (options.empty() and option.empty())
que-4Questionnaire.itemA question cannot have both option and options
: option.empty() or options.empty()
que-3Questionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-10Questionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()
que-1Questionnaire.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())
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.enableWhenAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-7Questionnaire.item.enableWhenenableWhen must contain either a 'answer' or a 'hasAnswer' element
: hasAnswer.exists() xor answer.exists()
ele-1Questionnaire.item.optionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Questionnaire.item.option.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.option.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.option.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.option.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()