Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-behave | Version: 4.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCQuestionnaireBehave | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.16 |
Defines additional capabilities for controlling data entry and calculating values within the questionnaire.
This profile adds additional constraints and extensions to the base SDC Base Questionnaire Profile that support the design of questionnaires with more sophisticated behavior and flow-control, including calculated values, determining what portions of the questionnaire to show based on previous answers, etc. This profile identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the questionnaire response population use-case. Further information on how this use-case is implemented as well as guidance on the elements and extensions included in the profile can be found on the Form Behavior page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | C | 0..* | SDCQuestionnaireCommon | Advanced Behavior Questionnaire dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | Content/Rules for all slices | |||
versionAlgorithm | S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
copyrightLabel | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
constraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
item | C | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression sdc-behave-3: For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. |
Slices for extension | Content/Rules for all slices | |||
hidden | S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerConstraint | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
disabledDisplay | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMinOccurs | S | 0..1 | (Complex) | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
value[x] | 1..1 | integer | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemMaxOccurs | S | 0..1 | (Complex) | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
value[x] | 1..1 | integer | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minValue | S | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |
value[x] | 1..1 | Value of extension ele-1: All FHIR elements must have a @value or children | ||
value[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
minValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueQuantity | Quantity | |||
maxValue | S | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |
value[x] | 1..1 | Value of extension ele-1: All FHIR elements must have a @value or children | ||
value[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
maxValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueQuantity | Quantity | |||
minQuantity | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |
value[x] | 0..1 | Quantity | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
minQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
maxQuantity | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |
value[x] | 0..1 | Quantity | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
maxQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxSize | 0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemConstraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
linkId | SC | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
enableWhen | ?!C | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
question | S | 1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children |
operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children |
answer[x] | SC | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. ele-1: All FHIR elements must have a @value or children |
required | SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
repeats | SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
readOnly | SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerValueSet | C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
value | 0..1 | string | Primitive value for canonical | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerOption | SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemWeight | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
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 ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard | |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard | |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard | |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
This structure is derived from SDCQuestionnaireCommon
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | C | 0..* | SDCQuestionnaireCommon | Advanced Behavior Questionnaire que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
versionAlgorithm | S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] | ||||
copyrightLabel | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
constraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |||||
variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
version | Σ | 0..1 | string | Business version of the questionnaire | ||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subjectType | Σ | 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 | C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression sdc-behave-3: For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
hidden | S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
answerConstraint | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint | |||||
disabledDisplay | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay | |||||
answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression | ||||
usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | ||||
itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
itemMinOccurs | S | 0..1 | (Complex) | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |||||
value[x] | 1..1 | integer | Value of extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | integer | Primitive value for integer | |||||
itemMaxOccurs | S | 0..1 | (Complex) | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |||||
value[x] | 1..1 | integer | Value of extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | integer | Primitive value for integer | |||||
minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | ||||
regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
minValue | S | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |||||
value[x] | 1..1 | Value of extension | ||||||
value[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
minValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueQuantity | Quantity | |||||||
maxValue | S | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |||||
value[x] | 1..1 | Value of extension | ||||||
value[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maxValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueQuantity | Quantity | |||||||
minQuantity | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |||||
value[x] | 0..1 | Quantity | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
minQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxQuantity | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |||||
value[x] | 0..1 | Quantity | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maxQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
maxSize | 0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | ||||
unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |||||
unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |||||
allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |||||
candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |||||
lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |||||
itemConstraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |||||
calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |||||
enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
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 que-15: Link ids must be 255 characters or less | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
code | C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
text | 0..1 | string | Primary text for the item | |||||
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
enableWhen | ?!C | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
question | S | 1..1 | string | Question that determines whether item is enabled | ||||
operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | ||||
answer[x] | SC | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
answerBoolean | boolean | |||||||
answerDecimal | decimal | |||||||
answerInteger | integer | |||||||
answerDate | date | |||||||
answerDateTime | dateTime | |||||||
answerTime | time | |||||||
answerString | string | |||||||
answerCoding | Coding | |||||||
answerQuantity | Quantity | |||||||
answerReference | Reference(Resource) | |||||||
enableBehavior | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
maxLength | C | 0..1 | integer | No more than this many characters | ||||
answerValueSet | C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | string | Primitive value for canonical | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
answerValueSetExpression | 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 | |||||
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 | |||||
optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
itemWeight | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
valueReference | Reference(Resource) | |||||||
initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard | ||||
Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | ||||
Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | ||||
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | ||||
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | ||||
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
This structure is derived from SDCQuestionnaireCommon
Summary
Must-Support: 30 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | C | 0..* | SDCQuestionnaireCommon | Advanced Behavior Questionnaire dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | Content/Rules for all slices | |||
versionAlgorithm | S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
copyrightLabel | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
constraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
item | C | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression sdc-behave-3: For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. |
Slices for extension | Content/Rules for all slices | |||
hidden | S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerConstraint | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
disabledDisplay | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMinOccurs | S | 0..1 | (Complex) | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
value[x] | 1..1 | integer | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemMaxOccurs | S | 0..1 | (Complex) | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
value[x] | 1..1 | integer | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minValue | S | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |
value[x] | 1..1 | Value of extension ele-1: All FHIR elements must have a @value or children | ||
value[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
minValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueQuantity | Quantity | |||
maxValue | S | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |
value[x] | 1..1 | Value of extension ele-1: All FHIR elements must have a @value or children | ||
value[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
maxValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueQuantity | Quantity | |||
minQuantity | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |
value[x] | 0..1 | Quantity | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
minQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
maxQuantity | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |
value[x] | 0..1 | Quantity | Value of extension ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
maxQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxSize | 0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
itemConstraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
linkId | SC | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
enableWhen | ?!C | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
question | S | 1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children |
operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children |
answer[x] | SC | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. ele-1: All FHIR elements must have a @value or children |
required | SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
repeats | SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
readOnly | SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
value | 0..1 | boolean | Primitive value for boolean | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerValueSet | C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
value | 0..1 | string | Primitive value for canonical | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
answerOption | SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
itemWeight | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
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 ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard | |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard | |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard | |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
Differential View
This structure is derived from SDCQuestionnaireCommon
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | C | 0..* | SDCQuestionnaireCommon | Advanced Behavior Questionnaire que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
versionAlgorithm | S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] | ||||
copyrightLabel | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
constraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |||||
variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:rendering-criticalExtension | ?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
url | ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic | ||||
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
version | Σ | 0..1 | string | Business version of the questionnaire | ||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subjectType | Σ | 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 | C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression sdc-behave-3: For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
hidden | S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
answerConstraint | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint | |||||
disabledDisplay | 0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay | |||||
answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression | ||||
usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | ||||
itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
itemMinOccurs | S | 0..1 | (Complex) | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |||||
value[x] | 1..1 | integer | Value of extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | integer | Primitive value for integer | |||||
itemMaxOccurs | S | 0..1 | (Complex) | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |||||
value[x] | 1..1 | integer | Value of extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | integer | Primitive value for integer | |||||
minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | ||||
regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
minValue | S | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |||||
value[x] | 1..1 | Value of extension | ||||||
value[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
minValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueQuantity | Quantity | |||||||
maxValue | S | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |||||
value[x] | 1..1 | Value of extension | ||||||
value[x]All Types | Content/Rules for all Types | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maxValueCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueQuantity | Quantity | |||||||
minQuantity | 0..1 | (Complex) | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |||||
value[x] | 0..1 | Quantity | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
minQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxQuantity | 0..1 | (Complex) | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |||||
value[x] | 0..1 | Quantity | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
maxQuantityCalculated | 0..1 | Expression | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
maxSize | 0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | ||||
unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |||||
unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |||||
allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |||||
candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |||||
lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |||||
itemConstraint | 0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |||||
calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |||||
enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
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 que-15: Link ids must be 255 characters or less | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
code | C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
text | 0..1 | string | Primary text for the item | |||||
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
enableWhen | ?!C | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
question | S | 1..1 | string | Question that determines whether item is enabled | ||||
operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | ||||
answer[x] | SC | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
answerBoolean | boolean | |||||||
answerDecimal | decimal | |||||||
answerInteger | integer | |||||||
answerDate | date | |||||||
answerDateTime | dateTime | |||||||
answerTime | time | |||||||
answerString | string | |||||||
answerCoding | Coding | |||||||
answerQuantity | Quantity | |||||||
answerReference | Reference(Resource) | |||||||
enableBehavior | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | boolean | Primitive value for boolean | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
value | 0..1 | boolean | Primitive value for boolean | |||||
maxLength | C | 0..1 | integer | No more than this many characters | ||||
answerValueSet | C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | string | Primitive value for canonical | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
answerValueSetExpression | 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 | |||||
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 | |||||
optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
itemWeight | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
valueReference | Reference(Resource) | |||||||
initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
valueBoolean | boolean | |||||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueUri | uri | |||||||
valueAttachment | Attachment | |||||||
valueCoding | Coding | |||||||
valueQuantity | Quantity | |||||||
valueReference | Reference(Resource) | |||||||
item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard | ||||
Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | ||||
Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard | ||||
Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | ||||
Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard | ||||
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard | ||||
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() | |
sdc-behave-3 | best practice | Questionnaire.item | For items of type 'quantity', it is best practice to include either a 'unitOption' or 'unitValueSet' extension to provide a list of valid units. : (type = 'quantity' implies (extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists())) and (repeat(item).where(type = 'quantity')).all(extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption').exists() or extension('http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet').exists()) |
This structure is derived from SDCQuestionnaireCommon
Summary
Must-Support: 30 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron