Structured Data Capture
4.0.0 - STU 4 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 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 Rendering Questionnaire

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

Defines additional capabilities for controlling the rendering of 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 rendering, including tables, specialized controls, styled text, 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 rendering 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 Advanced Rendering page.

Usages:

You can also check for usages in the FHIR IG Statistics

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 Rendering Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3, sdc-rend-2
... 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)
... 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... 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-rend-1
.... 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:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... 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"
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text 0..1 string Primary text for the item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for value[x] S 1..1 Answer value
Slice: Unordered, Closed by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
...... value[x]:valueCoding SC 0..1 Coding Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Constraints: sdc-base-1, sdc-base-2
...... value[x]:valueString S 0..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value[x]:valueReference SC 0..1 Reference(Resource) Answer value
Constraints: sdc-base-4
.... 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.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.answerOption.value[x]exampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueCodingexampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueStringexampleQuestionnaireAnswerCodes(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-base-1errorQuestionnaire.item.answerOption.value[x]:valueCodingAnswerOption.valueCoding must have at least one of code or display
: code.exists() or display.exists()
sdc-base-2errorQuestionnaire.item.answerOption.value[x]:valueCodingIf code exists, system must exist
: code.exists() implies system.exists()
sdc-base-4errorQuestionnaire.item.answerOption.value[x]:valueReferenceReference must have at least one of reference, display, and identifier
: reference.exists() or display.exists() or identifier.exists()
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Rendering Questionnaire
Constraints: sdc-rend-2
... 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
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: sdc-rend-1
.... Slices for extension Content/Rules for all slices
..... extension:itemOptionalDisplay 0..1 OptionalDisplayExtension Can suppress from display to user
..... extension:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... prefix
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCoding 0..1 Coding Answer value
....... display
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:optionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:optionDisplay-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
......... extension:optionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value[x]:valueString 0..1 string Answer value
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Rendering Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3, sdc-rend-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
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)
... 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)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1 string Primitive value for string
Max Length:1048576
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 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-rend-1
.... 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:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... 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"
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1 string Primitive value for string
Max Length:1048576
.... text 0..1 string Primary text for the item
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 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
.... 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 ?!C 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 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... enableBehavior C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength C 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
.... 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for value[x] S 1..1 Answer value
Slice: Unordered, Closed by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
...... value[x]:valueCoding SC 0..1 Coding Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Constraints: sdc-base-1, sdc-base-2
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:optionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:optionDisplay-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
......... extension:optionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... value[x]:valueString S 0..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1 string Primitive value for string
Max Length:1048576
...... value[x]:valueReference SC 0..1 Reference(Resource) Answer value
Constraints: sdc-base-4
..... 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.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.answerOption.value[x]:valueCodingexampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueStringexampleQuestionnaireAnswerCodes(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-base-1errorQuestionnaire.item.answerOption.value[x]:valueCodingAnswerOption.valueCoding must have at least one of code or display
: code.exists() or display.exists()
sdc-base-2errorQuestionnaire.item.answerOption.value[x]:valueCodingIf code exists, system must exist
: code.exists() implies system.exists()
sdc-base-4errorQuestionnaire.item.answerOption.value[x]:valueReferenceReference must have at least one of reference, display, and identifier
: reference.exists() or display.exists() or identifier.exists()
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())

This structure is derived from SDCBaseQuestionnaire

Summary

Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Rendering Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3, sdc-rend-2
... 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)
... 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... 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-rend-1
.... 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:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... 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"
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text 0..1 string Primary text for the item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 0..1 Expression An dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
.... 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 ?!C 0..* BackboneElement Only allow data when
Constraints: que-7
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... question 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for value[x] S 1..1 Answer value
Slice: Unordered, Closed by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
...... value[x]:valueCoding SC 0..1 Coding Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Constraints: sdc-base-1, sdc-base-2
...... value[x]:valueString S 0..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value[x]:valueReference SC 0..1 Reference(Resource) Answer value
Constraints: sdc-base-4
.... 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.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.answerOption.value[x]exampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueCodingexampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueStringexampleQuestionnaireAnswerCodes(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-base-1errorQuestionnaire.item.answerOption.value[x]:valueCodingAnswerOption.valueCoding must have at least one of code or display
: code.exists() or display.exists()
sdc-base-2errorQuestionnaire.item.answerOption.value[x]:valueCodingIf code exists, system must exist
: code.exists() implies system.exists()
sdc-base-4errorQuestionnaire.item.answerOption.value[x]:valueReferenceReference must have at least one of reference, display, and identifier
: reference.exists() or display.exists() or identifier.exists()
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())

Differential View

This structure is derived from SDCBaseQuestionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Rendering Questionnaire
Constraints: sdc-rend-2
... 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
... title
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: sdc-rend-1
.... Slices for extension Content/Rules for all slices
..... extension:itemOptionalDisplay 0..1 OptionalDisplayExtension Can suppress from display to user
..... extension:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... prefix
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCoding 0..1 Coding Answer value
....... display
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:optionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:optionDisplay-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
......... extension:optionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value[x]:valueString 0..1 string Answer value
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* SDCBaseQuestionnaire Advanced Rendering Questionnaire
Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3, sdc-rend-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
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)
... 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)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:title-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... extension:title-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
..... extension:title-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1 string Primitive value for string
Max Length:1048576
... derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subjectType SΣ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the questionnaire
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this questionnaire is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 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-rend-1
.... 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:itemMedia 0..1 Attachment Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
..... extension:itemShortText 0..1 string Short text for the item.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText
..... extension:openLabel 0..1 string Image to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel
..... extension:itemControl S 0..1 CodeableConcept E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items.
..... extension:choiceOrientation 0..1 code horizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed.
..... extension:displayCategory S 0..1 CodeableConcept Purpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item.
..... extension:supportHyperlink 0..* (Complex) A labeled hyperlink for user guidance
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportHyperlink
..... extension:choiceColumn 0..* (Complex) Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... extension:width 0..1 Quantity Width of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... extension:sliderStepValue 0..1 integer Increment value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... extension:entryFormat S 0..1 string User prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... extension:collapsible 0..1 code Indicates whether the child items of a group or question item is displayed in collapsible form.
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible
Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items.
..... extension:columnCount 0..1 positiveInt Number of columns for layout
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-columnCount
..... 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.
.... 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"
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:itemLabel-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:itemLabel-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:itemLabel-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1 string Primitive value for string
Max Length:1048576
.... text 0..1 string Primary text for the item
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:groupText-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... extension:groupText-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
...... extension:groupText-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:expression S 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
.... 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 ?!C 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 1..1 string Question that determines whether item is enabled
..... operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
..... answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... enableBehavior C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
.... required SC 0..1 boolean Whether the item must be included in data results
.... repeats SC 0..1 boolean Whether the item may repeat
.... readOnly SC 0..1 boolean Don't allow human editing
.... maxLength C 0..1 integer No more than this many characters
.... answerValueSet SC 0..1 canonical(SDC Value Set) Valueset containing permitted answers
.... 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:itemAnswerMedia 0..1 Attachment Answer Media to display
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
...... extension:optionPrefix 0..1 string E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for value[x] S 1..1 Answer value
Slice: Unordered, Closed by type:$this
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
...... valueReference Reference(Resource)
...... value[x]:valueCoding SC 0..1 Coding Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Constraints: sdc-base-1, sdc-base-2
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:optionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:optionDisplay-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
......... extension:optionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... value[x]:valueString S 0..1 string Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:optionString-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:optionString-markdown 0..1 markdown String equivalent with markdown
URL: http://hl7.org/fhir/StructureDefinition/rendering-markdown
........ extension:optionString-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1 string Primitive value for string
Max Length:1048576
...... value[x]:valueReference SC 0..1 Reference(Resource) Answer value
Constraints: sdc-base-4
..... 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.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.answerOption.value[x]:valueCodingexampleQuestionnaireAnswerCodes(a valid code from SNOMED CT)
http://hl7.org/fhir/ValueSet/questionnaire-answers
From the FHIR Standard
Questionnaire.item.answerOption.value[x]:valueStringexampleQuestionnaireAnswerCodes(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-base-1errorQuestionnaire.item.answerOption.value[x]:valueCodingAnswerOption.valueCoding must have at least one of code or display
: code.exists() or display.exists()
sdc-base-2errorQuestionnaire.item.answerOption.value[x]:valueCodingIf code exists, system must exist
: code.exists() implies system.exists()
sdc-base-4errorQuestionnaire.item.answerOption.value[x]:valueReferenceReference must have at least one of reference, display, and identifier
: reference.exists() or display.exists() or identifier.exists()
sdc-rend-1errorQuestionnaire.itemItems with a controlType of 'page' can only appear in root-level items.
: extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists() implies %resource.item.where(linkId=%context.linkId).exists()
sdc-rend-2errorQuestionnaireIf a questionnaire has child items with a controlType of page, then all items must have a type of page, header or footer.
: item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and code='page').exists()).exists() implies item.all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl').value.coding.where(system='http://hl7.org/fhir/questionnaire-item-control' and (code='page' or code='header' or code='footer')).exists())

This structure is derived from SDCBaseQuestionnaire

Summary

Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron