Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Questionnaire | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Questionnaire_R4 | ||
This cross-version profile allows R5 Questionnaire content to be represented via FHIR R4 Questionnaire resources.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Questionnaire(4.0.1) | 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Questionnaire.implicitRules, Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire |
descendants().linkId.isDistinct()
|
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Questionnaire(4.0.1) | 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the questionnaire | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
![]() ![]() |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | code | R5: subjectType additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType Binding: R5ResourceTypesForR4 (0.1.0) (required): One of the resource types defined as part of this version of FHIR. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: hidden | protected (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay Binding: R5QuestionnaireDisabledDisplayForR4 (0.1.0) (required): Defines how disabled elements should be rendered Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: optionsOnly | optionsOrType | optionsOrString (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint Binding: R5QuestionnaireAnswerConstraintForR4 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.subjectType | Base | required |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Questionnaire.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| Questionnaire.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableBehavior | Base | required | EnableWhenBehavior | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Questionnaire.meta, Questionnaire.implicitRules, Questionnaire.language, Questionnaire.text, Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.url, Questionnaire.identifier, Questionnaire.version, Questionnaire.name, Questionnaire.title, Questionnaire.derivedFrom, Questionnaire.status, Questionnaire.experimental, Questionnaire.subjectType, Questionnaire.subjectType.extension, Questionnaire.subjectType.extension:subjectType, Questionnaire.date, Questionnaire.publisher, Questionnaire.contact, Questionnaire.description, Questionnaire.useContext, Questionnaire.jurisdiction, Questionnaire.purpose, Questionnaire.copyright, Questionnaire.approvalDate, Questionnaire.lastReviewDate, Questionnaire.effectivePeriod, Questionnaire.code, Questionnaire.item, Questionnaire.item.extension, Questionnaire.item.extension:disabledDisplay, Questionnaire.item.extension:answerConstraint, Questionnaire.item.modifierExtension, Questionnaire.item.linkId, Questionnaire.item.definition, Questionnaire.item.code, Questionnaire.item.prefix, Questionnaire.item.text, Questionnaire.item.type, Questionnaire.item.enableWhen, Questionnaire.item.enableWhen.extension, Questionnaire.item.enableWhen.modifierExtension, Questionnaire.item.enableWhen.question, Questionnaire.item.enableWhen.operator, Questionnaire.item.enableWhen.answer[x], Questionnaire.item.enableBehavior, Questionnaire.item.required, Questionnaire.item.repeats, Questionnaire.item.readOnly, Questionnaire.item.maxLength, Questionnaire.item.answerValueSet, Questionnaire.item.answerOption, Questionnaire.item.answerOption.extension, Questionnaire.item.answerOption.modifierExtension, Questionnaire.item.answerOption.value[x], Questionnaire.item.answerOption.initialSelected, Questionnaire.item.initial, Questionnaire.item.initial.extension, Questionnaire.item.initial.modifierExtension, Questionnaire.item.initial.value[x], Questionnaire.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.subjectType.extension, Questionnaire.subjectType.extension:subjectType, Questionnaire.item.extension, Questionnaire.item.extension:disabledDisplay, Questionnaire.item.extension:answerConstraint, Questionnaire.item.modifierExtension, Questionnaire.item.enableWhen.extension, Questionnaire.item.enableWhen.modifierExtension, Questionnaire.item.answerOption.extension, Questionnaire.item.answerOption.modifierExtension, Questionnaire.item.initial.extension, Questionnaire.item.initial.modifierExtension | 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
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Questionnaire(4.0.1) | 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
![]() ![]() ![]() |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Questionnaire.implicitRules, Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire |
descendants().linkId.isDistinct()
|
Differential View
This structure is derived from Questionnaire
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Questionnaire(4.0.1) | 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 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the questionnaire | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
![]() ![]() |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | code | R5: subjectType additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType Binding: R5ResourceTypesForR4 (0.1.0) (required): One of the resource types defined as part of this version of FHIR. Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for code | |||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: hidden | protected (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay Binding: R5QuestionnaireDisabledDisplayForR4 (0.1.0) (required): Defines how disabled elements should be rendered Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: optionsOnly | optionsOrType | optionsOrString (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint Binding: R5QuestionnaireAnswerConstraintForR4 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.subjectType | Base | required |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Questionnaire.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| Questionnaire.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableBehavior | Base | required | EnableWhenBehavior | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Questionnaire.meta, Questionnaire.implicitRules, Questionnaire.language, Questionnaire.text, Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.url, Questionnaire.identifier, Questionnaire.version, Questionnaire.name, Questionnaire.title, Questionnaire.derivedFrom, Questionnaire.status, Questionnaire.experimental, Questionnaire.subjectType, Questionnaire.subjectType.extension, Questionnaire.subjectType.extension:subjectType, Questionnaire.date, Questionnaire.publisher, Questionnaire.contact, Questionnaire.description, Questionnaire.useContext, Questionnaire.jurisdiction, Questionnaire.purpose, Questionnaire.copyright, Questionnaire.approvalDate, Questionnaire.lastReviewDate, Questionnaire.effectivePeriod, Questionnaire.code, Questionnaire.item, Questionnaire.item.extension, Questionnaire.item.extension:disabledDisplay, Questionnaire.item.extension:answerConstraint, Questionnaire.item.modifierExtension, Questionnaire.item.linkId, Questionnaire.item.definition, Questionnaire.item.code, Questionnaire.item.prefix, Questionnaire.item.text, Questionnaire.item.type, Questionnaire.item.enableWhen, Questionnaire.item.enableWhen.extension, Questionnaire.item.enableWhen.modifierExtension, Questionnaire.item.enableWhen.question, Questionnaire.item.enableWhen.operator, Questionnaire.item.enableWhen.answer[x], Questionnaire.item.enableBehavior, Questionnaire.item.required, Questionnaire.item.repeats, Questionnaire.item.readOnly, Questionnaire.item.maxLength, Questionnaire.item.answerValueSet, Questionnaire.item.answerOption, Questionnaire.item.answerOption.extension, Questionnaire.item.answerOption.modifierExtension, Questionnaire.item.answerOption.value[x], Questionnaire.item.answerOption.initialSelected, Questionnaire.item.initial, Questionnaire.item.initial.extension, Questionnaire.item.initial.modifierExtension, Questionnaire.item.initial.value[x], Questionnaire.item.item | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Questionnaire.extension, Questionnaire.extension:versionAlgorithm, Questionnaire.extension:copyrightLabel, Questionnaire.modifierExtension, Questionnaire.subjectType.extension, Questionnaire.subjectType.extension:subjectType, Questionnaire.item.extension, Questionnaire.item.extension:disabledDisplay, Questionnaire.item.extension:answerConstraint, Questionnaire.item.modifierExtension, Questionnaire.item.enableWhen.extension, Questionnaire.item.enableWhen.modifierExtension, Questionnaire.item.answerOption.extension, Questionnaire.item.answerOption.modifierExtension, Questionnaire.item.initial.extension, Questionnaire.item.initial.modifierExtension | 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
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron