Stanford Spezi FHIR Implementation Guide
0.1.0 - ci-build
Publish Box goes here
Official URL: http://spezi.health/fhir/StructureDefinition/spezi-questionnaire | Version: 0.1.0 | |||
Draft as of 2022-08-26 | Computable Name: SpeziQuestionnaireProfile |
Questionnaire Profile used to represent surveys rendered on mobile devices
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
SC | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the questionnaire |
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this questionnaire (computer friendly) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed |
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | UI control type for ResearchKit rendering URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Controls item visibility in surveys URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer | Step increment for slider controls URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Minimum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/minValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Maximum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/maxValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer, Quantity | Decimal precision limit URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Display unit for numerical values URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input format hints or placeholders URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Style-sensitive rendering hints URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input validation pattern URL: http://hl7.org/fhir/StructureDefinition/regex |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Custom validation error message URL: http://bdh.stanford.edu/fhir/StructureDefinition/validationtext |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS keyboard type for optimal text input URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-keyboardtype Binding: iOS Keyboard Type Value Set (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS autocapitalization behavior URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-autocapitalizationType Binding: iOS Autocapitalization Type Value Set (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS text content type for enhanced user experience URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-textcontenttype Binding: iOS Text Content Type Value Set (required) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | string | Unique id for item in questionnaire | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
?!C | 0..* | BackboneElement | Only allow data when Constraints: que-7 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Question that determines whether item is enabled | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Permitted answer |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Numeric score for answer choice (GAD-7, PHQ-9, etc.) URL: http://hl7.org/fhir/StructureDefinition/ordinalValue |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() |
Path | Conformance | ValueSet | URI |
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.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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Questionnaire | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
SC | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the questionnaire | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the questionnaire | ||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
![]() ![]() ![]() |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | markdown | Natural language description of the questionnaire | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this questionnaire is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the questionnaire was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the questionnaire was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | UI control type for ResearchKit rendering URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Controls item visibility in surveys URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer | Step increment for slider controls URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Minimum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Maximum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer, Quantity | Decimal precision limit URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Display unit for numerical values URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input format hints or placeholders URL: http://hl7.org/fhir/StructureDefinition/entryFormat | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Style-sensitive rendering hints URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input validation pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Custom validation error message URL: http://bdh.stanford.edu/fhir/StructureDefinition/validationtext | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS keyboard type for optimal text input URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-keyboardtype Binding: iOS Keyboard Type Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS autocapitalization behavior URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-autocapitalizationType Binding: iOS Autocapitalization Type Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS text content type for enhanced user experience URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-textcontenttype Binding: iOS Text Content Type Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Unique id for item in questionnaire | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | E.g. "1(a)", "2.5.3" | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primary text for the item | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
?!C | 0..* | BackboneElement | Only allow data when Constraints: que-7 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Question that determines whether item is enabled | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Whether the item must be included in data results | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Whether the item may repeat | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Don't allow human editing | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | integer | No more than this many characters | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Permitted answer | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Numeric score for answer choice (GAD-7, PHQ-9, etc.) URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether option is selected by default | |||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
![]() |
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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Questionnaire | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
This structure is derived from Questionnaire
Summary
Mandatory: 2 elements
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
SC | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the questionnaire |
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this questionnaire (computer friendly) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed |
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | UI control type for ResearchKit rendering URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Controls item visibility in surveys URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer | Step increment for slider controls URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Minimum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/minValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Maximum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/maxValue |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer, Quantity | Decimal precision limit URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Display unit for numerical values URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input format hints or placeholders URL: http://hl7.org/fhir/StructureDefinition/entryFormat |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Style-sensitive rendering hints URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input validation pattern URL: http://hl7.org/fhir/StructureDefinition/regex |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Custom validation error message URL: http://bdh.stanford.edu/fhir/StructureDefinition/validationtext |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS keyboard type for optimal text input URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-keyboardtype Binding: iOS Keyboard Type Value Set (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS autocapitalization behavior URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-autocapitalizationType Binding: iOS Autocapitalization Type Value Set (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS text content type for enhanced user experience URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-textcontenttype Binding: iOS Text Content Type Value Set (required) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | string | Unique id for item in questionnaire | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
?!C | 0..* | BackboneElement | Only allow data when Constraints: que-7 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Question that determines whether item is enabled | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Permitted answer |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Numeric score for answer choice (GAD-7, PHQ-9, etc.) URL: http://hl7.org/fhir/StructureDefinition/ordinalValue |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() |
Path | Conformance | ValueSet | URI |
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.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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Questionnaire | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
Differential View
This structure is derived from Questionnaire
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
SC | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the questionnaire | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the questionnaire | ||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
![]() ![]() ![]() |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | markdown | Natural language description of the questionnaire | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this questionnaire is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the questionnaire was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the questionnaire was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | UI control type for ResearchKit rendering URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Controls item visibility in surveys URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer | Step increment for slider controls URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Minimum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date, dateTime, time, decimal, integer, Quantity | Maximum value for numeric/date inputs (use valueDate for dates) URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | integer, Quantity | Decimal precision limit URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Display unit for numerical values URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input format hints or placeholders URL: http://hl7.org/fhir/StructureDefinition/entryFormat | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Style-sensitive rendering hints URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Input validation pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Custom validation error message URL: http://bdh.stanford.edu/fhir/StructureDefinition/validationtext | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS keyboard type for optimal text input URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-keyboardtype Binding: iOS Keyboard Type Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS autocapitalization behavior URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-autocapitalizationType Binding: iOS Autocapitalization Type Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | iOS text content type for enhanced user experience URL: http://bdh.stanford.edu/fhir/StructureDefinition/ios-textcontenttype Binding: iOS Text Content Type Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | string | Unique id for item in questionnaire | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | ElementDefinition - details for the item | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | E.g. "1(a)", "2.5.3" | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primary text for the item | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
?!C | 0..* | BackboneElement | Only allow data when Constraints: que-7 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Question that determines whether item is enabled | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Whether the item must be included in data results | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Whether the item may repeat | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | boolean | Don't allow human editing | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | integer | No more than this many characters | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Permitted answer | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Numeric score for answer choice (GAD-7, PHQ-9, etc.) URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Whether option is selected by default | |||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() |
C | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
![]() |
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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Questionnaire | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
This structure is derived from Questionnaire
Summary
Mandatory: 2 elements
Must-Support: 22 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron