Structured Data Capture
4.0.0-ballot - STU 4 ballot International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: Advanced Behavior Questionnaire

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-behave Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: SDCQuestionnaireBehave
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.16

Defines additional capabilities for controlling data entry and calculating values within the questionnaire.

Scope and Usage

This profile adds additional constraints and extensions to the base SDC Base Questionnaire Profile that support the design of questionnaires with more sophisticated behavior and flow-control, including calculated values, determining what portions of the questionnaire to show based on previous answers, etc. This profile identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the questionnaire response population use-case. Further information on how this use-case is implemented as well as guidance on the elements and extensions included in the profile can be found on the Form Behavior page.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
.... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... extension:performerType S 0..* code Resource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.
.... extension:assemble-expectation S 0..1 code Questionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
.... extension:entryMode S 0..1 code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... version SΣ 0..1 string Business version of the questionnaire
... title SΣ 0..1 string Name for this questionnaire (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... item SC 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14, sdc-behave-2, sdc-behave-1, sdc-behave-3
.... Slices for extension Content/Rules for all slices
..... extension:hidden S 0..1 boolean Don't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
..... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
..... extension:itemOptionalDisplay 0..1 boolean Can suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/minValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ Slices for extension Content/Rules for all slices
......... extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/maxValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ Slices for extension Content/Rules for all slices
......... extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity"
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity"
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId SC 1..1 string Unique id for item in questionnaire
Constraints: que-15
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
.... enableWhen ?!SC 0..* BackboneElement Only allow data when
Constraints: que-7
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] SC 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 SC 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... repeats SC 0..1 boolean Whether the item may repeat
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... readOnly SC 0..1 boolean Don't allow human editing
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
.... answerOption SC 0..* BackboneElement Permitted answer
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
.... initial SC 0..* BackboneElement Initial value(s) when item is first rendered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item SC 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningQuestionnaireName 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-1warningQuestionnaire.urlWarning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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
que-14warningQuestionnaire.itemCan only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
: extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists()
que-15errorQuestionnaire.item.linkIdLink ids must be 255 characters or less
: $this.length() <= 255
que-1aerrorQuestionnaire.itemGroup items must have nested items when Questionanire is complete
: (type='group' and %resource.status='complete') implies item.empty().not()
que-1bwarningQuestionnaire.itemGroups should have items
: type='group' implies item.empty().not()
que-1cerrorQuestionnaire.itemDisplay items cannot have child items
: type='display' implies item.empty()
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())
sdc-2errorQuestionnaireIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3best practiceQuestionnaireSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
... Slices for extension Content/Rules for all slices
.... extension:entryMode S 0..* code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: sdc-behave-2, sdc-behave-1, sdc-behave-3
.... Slices for extension Content/Rules for all slices
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... value[x] 1..1 date, dateTime, time, decimal, integer, Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... value[x] 1..1 date, dateTime, time, decimal, integer, Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... enableWhen S 0..* BackboneElement Only allow data when
..... question S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
..... answer[x] S 1..1 boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) Value for question comparison based on operator
.... enableBehavior S 0..1 code all | any
.... required 0..1 boolean Whether the item must be included in data results
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... repeats
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... readOnly
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerValueSet
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:answerValueSetExpression 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerOption
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
.... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... extension:performerType S 0..* code Resource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.
.... extension:assemble-expectation S 0..1 code Questionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
.... extension:entryMode S 0..1 code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣC 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version SΣ 0..1 string Business version of the questionnaire
... name ΣC 0..1 string Name for this questionnaire (computer friendly)
... title SΣ 0..1 string Name for this questionnaire (human friendly)
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 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 SC 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14, sdc-behave-2, sdc-behave-1, sdc-behave-3
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:hidden S 0..1 boolean Don't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
..... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
..... extension:itemOptionalDisplay 0..1 boolean Can suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
...... value[x] 1..1 integer Value of extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
....... value 0..1 integer Primitive value for integer
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
...... value[x] 1..1 integer Value of extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
....... value 0..1 integer Primitive value for integer
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/minValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/maxValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity"
...... value[x] 0..1 Quantity Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
....... unit Σ 0..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity"
...... value[x] 0..1 Quantity Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
....... unit Σ 0..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId SC 1..1 string Unique id for item in questionnaire
Constraints: que-15
.... definition 0..1 uri ElementDefinition - details for the item
.... code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
.... enableWhen ?!SC 0..* BackboneElement Only allow data when
Constraints: que-7
..... 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 S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] SC 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 SC 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... repeats SC 0..1 boolean Whether the item may repeat
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... readOnly SC 0..1 boolean Don't allow human editing
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... maxLength C 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 string Primitive value for canonical
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:answerValueSetExpression 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 string Primitive value for string
Max Length:1048576
.... answerOption SC 0..* BackboneElement Permitted answer
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
..... initialSelected 0..1 boolean Whether option is selected by default
.... initial SC 0..* BackboneElement Initial value(s) when item is first rendered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item SC 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningQuestionnaireName 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-1warningQuestionnaire.urlWarning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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
que-14warningQuestionnaire.itemCan only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
: extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists()
que-15errorQuestionnaire.item.linkIdLink ids must be 255 characters or less
: $this.length() <= 255
que-1aerrorQuestionnaire.itemGroup items must have nested items when Questionanire is complete
: (type='group' and %resource.status='complete') implies item.empty().not()
que-1bwarningQuestionnaire.itemGroups should have items
: type='group' implies item.empty().not()
que-1cerrorQuestionnaire.itemDisplay items cannot have child items
: type='display' implies item.empty()
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())
sdc-2errorQuestionnaireIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3best practiceQuestionnaireSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())

This structure is derived from SDCBaseQuestionnaire

Summary

Must-Support: 31 elements

Extensions

This structure refers to these extensions:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
.... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... extension:performerType S 0..* code Resource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.
.... extension:assemble-expectation S 0..1 code Questionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
.... extension:entryMode S 0..1 code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... version SΣ 0..1 string Business version of the questionnaire
... title SΣ 0..1 string Name for this questionnaire (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... item SC 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14, sdc-behave-2, sdc-behave-1, sdc-behave-3
.... Slices for extension Content/Rules for all slices
..... extension:hidden S 0..1 boolean Don't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
..... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
..... extension:itemOptionalDisplay 0..1 boolean Can suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/minValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ Slices for extension Content/Rules for all slices
......... extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/maxValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ Slices for extension Content/Rules for all slices
......... extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity"
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity"
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId SC 1..1 string Unique id for item in questionnaire
Constraints: que-15
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
.... enableWhen ?!SC 0..* BackboneElement Only allow data when
Constraints: que-7
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] SC 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 SC 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... repeats SC 0..1 boolean Whether the item may repeat
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... readOnly SC 0..1 boolean Don't allow human editing
..... value 0..1 boolean Primitive value for boolean
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
.... answerOption SC 0..* BackboneElement Permitted answer
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
.... initial SC 0..* BackboneElement Initial value(s) when item is first rendered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item SC 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningQuestionnaireName 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-1warningQuestionnaire.urlWarning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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
que-14warningQuestionnaire.itemCan only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
: extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists()
que-15errorQuestionnaire.item.linkIdLink ids must be 255 characters or less
: $this.length() <= 255
que-1aerrorQuestionnaire.itemGroup items must have nested items when Questionanire is complete
: (type='group' and %resource.status='complete') implies item.empty().not()
que-1bwarningQuestionnaire.itemGroups should have items
: type='group' implies item.empty().not()
que-1cerrorQuestionnaire.itemDisplay items cannot have child items
: type='display' implies item.empty()
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())
sdc-2errorQuestionnaireIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3best practiceQuestionnaireSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())

Differential View

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
... Slices for extension Content/Rules for all slices
.... extension:entryMode S 0..* code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: sdc-behave-2, sdc-behave-1, sdc-behave-3
.... Slices for extension Content/Rules for all slices
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... value[x] 1..1 integer Value of extension
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... value[x] 1..1 date, dateTime, time, decimal, integer, Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... value[x] 1..1 date, dateTime, time, decimal, integer, Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... value[x] 0..1 Quantity Value of extension
....... Slices for extension Content/Rules for all slices
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... enableWhen S 0..* BackboneElement Only allow data when
..... question S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
..... answer[x] S 1..1 boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) Value for question comparison based on operator
.... enableBehavior S 0..1 code all | any
.... required 0..1 boolean Whether the item must be included in data results
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... repeats
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... readOnly
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerValueSet
..... value
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:answerValueSetExpression 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... answerOption
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Behavior Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
.... extension:versionAlgorithm S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D
.... extension:copyrightLabel 0..1 string Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
.... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... extension:performerType S 0..* code Resource that can record answers to this Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType
Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire.
.... extension:assemble-expectation S 0..1 code Questionnaire is modular
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation
Binding: Questionnaire Assemble Expectation (required)
.... extension:entryMode S 0..1 code sequential | prior-edit | random
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode
Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire
.... extension:submissionEndpoint S 0..* uri Where to send answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
.... extension:signatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
.... extension:constraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
.... extension:library 0..* canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
.... extension:launchContext 0..* (Complex) Context resources needed for Questionnaire
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext
.... extension:variable 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
.... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣC 1..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version SΣ 0..1 string Business version of the questionnaire
... name ΣC 0..1 string Name for this questionnaire (computer friendly)
... title SΣ 0..1 string Name for this questionnaire (human friendly)
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 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 SC 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14, sdc-behave-2, sdc-behave-1, sdc-behave-3
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:hidden S 0..1 boolean Don't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... extension:terminologyServer 0..* url Preferred terminology server
URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer
..... extension:designNote 0..1 markdown Design comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
..... extension:itemOptionalDisplay 0..1 boolean Can suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... extension:disabledDisplay 0..1 code Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
..... extension:answerExpression S 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression
..... extension:usageMode S 0..1 code capture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item.
..... extension:itemSignatureRequired 0..* CodeableConcept Is signature needed?
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Binding: SignatureTypeCodes (preferred): The type of signature needed.
..... extension:itemMinOccurs S 0..1 (Complex) Minimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
...... value[x] 1..1 integer Value of extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMinOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
....... value 0..1 integer Primitive value for integer
..... extension:itemMaxOccurs S 0..1 (Complex) Maximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
...... value[x] 1..1 integer Value of extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:itemMaxOccursExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
....... value 0..1 integer Primitive value for integer
..... extension:minLength S 0..1 integer At least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... extension:minValue S 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/minValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... extension:minValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:maxValue S 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/maxValue"
...... value[x] 1..1 Value of extension
....... value[x]All Types Content/Rules for all Types
........ id 0..1 string Unique id for inter-element referencing
........ Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... extension:maxValueCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... valueDate date
....... valueDateTime dateTime
....... valueTime time
....... valueDecimal decimal
....... valueInteger integer
....... valueQuantity Quantity
..... extension:minQuantity 0..1 (Complex) Must be >= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity"
...... value[x] 0..1 Quantity Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:minQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
....... unit Σ 0..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... extension:maxQuantity 0..1 (Complex) Must be <= this value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity"
...... value[x] 0..1 Quantity Value of extension
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:maxQuantityCalculated 0..1 Expression A calculated value
URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
....... value Σ 0..1 decimal Numerical value (with implicit precision)
....... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
....... unit Σ 0..1 string Unit representation
....... system ΣC 0..1 uri System that defines coded unit form
....... code Σ 0..1 code Coded form of the unit
..... extension:maxDecimalPlaces S 0..1 integer Maximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... extension:mimeType S 0..* code Type of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
..... extension:maxSize 0..1 decimal Max size in bytes
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... extension:answerOptionsToggleExpression S 0..* (Complex) Expression constraining allowed answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression
..... extension:unitOption S 0..* Coding Unit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... extension:unitValueSet S 0..1 canonical(ValueSet) Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... extension:unitOpen 0..1 code Used to denote if user can specify alternate codes
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen
Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers
..... extension:unitSupplementalSystem 0..1 canonical() This extension indicates the code system the additional units are drawn from
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem
..... extension:allowedResource S 0..* code Allowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... extension:allowedProfile 0..* canonical(StructureDefinition) Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
..... extension:candidateExpression 0..1 Expression Expression for possible answers
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression
..... extension:lookupQuestionnaire 0..1 canonical() Questionnaire to populate a reference
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire
..... extension:itemConstraint 0..* (Complex) A constraint on the target resource
URL: http://hl7.org/fhir/StructureDefinition/targetConstraint
..... extension:initialExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression
..... extension:calculatedExpression 0..1 Expression Expression-determined initial value
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression
..... extension:enableWhenExpression S 0..1 Expression Expression for when to enable the item
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression
..... extension:keyboardType 0..1 Coding Keyboard Type
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-keyboard
Binding: Questionnaire Item Keyboard Type (extensible): Keyboard types that can be used for text entry.
..... extension:assembleDefinitionRoot S 0..* boolean, uri Assemble Definition Root
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleDefinitionRoot
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... linkId SC 1..1 string Unique id for item in questionnaire
Constraints: que-15
.... definition 0..1 uri ElementDefinition - details for the item
.... code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
.... prefix S 0..1 string E.g. "1(a)", "2.5.3"
.... text 0..1 string Primary text for the item
.... type S 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
.... enableWhen ?!SC 0..* BackboneElement Only allow data when
Constraints: que-7
..... 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 S 1..1 string Question that determines whether item is enabled
..... operator S 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] SC 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 SC 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:requiredExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... repeats SC 0..1 boolean Whether the item may repeat
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:repeatsExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... readOnly SC 0..1 boolean Don't allow human editing
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 boolean Primitive value for boolean
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:readOnlyExpression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 boolean Primitive value for boolean
.... maxLength C 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional content defined by implementations
..... value 0..1 string Primitive value for canonical
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:answerValueSetExpression 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
...... value 0..1 string Primitive value for string
Max Length:1048576
.... answerOption SC 0..* BackboneElement Permitted answer
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:optionExclusive S 0..1 boolean Option is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
...... extension:itemWeight S 0..1 decimal Assigned Ordinal Value
URL: http://hl7.org/fhir/StructureDefinition/itemWeight
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
..... initialSelected 0..1 boolean Whether option is selected by default
.... initial SC 0..* BackboneElement Initial value(s) when item is first rendered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... value[x] S 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueBoolean boolean
...... valueDecimal decimal
...... valueInteger integer
...... valueDate date
...... valueDateTime dateTime
...... valueTime time
...... valueString string
...... valueUri uri
...... valueAttachment Attachment
...... valueCoding Coding
...... valueQuantity Quantity
...... valueReference Reference(Resource)
.... item SC 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningQuestionnaireName 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-1warningQuestionnaire.urlWarning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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
que-14warningQuestionnaire.itemCan only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
: extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists()
que-15errorQuestionnaire.item.linkIdLink ids must be 255 characters or less
: $this.length() <= 255
que-1aerrorQuestionnaire.itemGroup items must have nested items when Questionanire is complete
: (type='group' and %resource.status='complete') implies item.empty().not()
que-1bwarningQuestionnaire.itemGroups should have items
: type='group' implies item.empty().not()
que-1cerrorQuestionnaire.itemDisplay items cannot have child items
: type='display' implies item.empty()
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())
sdc-2errorQuestionnaireIf version is present, versionAlgorithm must be present.
: version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists()
sdc-3best practiceQuestionnaireSemver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
: extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists())
sdc-behave-1errorQuestionnaire.itemAn item cannot have both initial.value and initialExpression
: initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty()
sdc-behave-2errorQuestionnaire.itemAn item cannot have both enableWhen and enableWhenExpression
: enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty()
sdc-behave-3best practiceQuestionnaire.itemFor items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units.
: (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())

This structure is derived from SDCBaseQuestionnaire

Summary

Must-Support: 31 elements

Extensions

This structure refers to these extensions:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron