This page is part of the Structured Data Capture FHIR IG (v3.0.0-preview: STU 3 Draft) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extr-obsn | Version: 3.0.0-preview | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: QuestionnaireExtractObservation |
Defines elements that allow conversion of a QuestionnaireResponse to an Observation resource or Bundle of Observation resources using the Observation-based extraction mechanism
This profile adds additional constraints and extensions to the base SDC Base Questionnaire Profile that support extracting information from questionnaire responses and producing other FHIR resources. This profile identifies which core elements and extensions must be supported when using the Observation-based extraction mechanism and highlights other elements that, while not required, may be relevant to the questionnaire response data extraction use-case. Further information on how this use-case is implemented as well as guidance on the elements and extensions included in the profile can be found on the Data Extraction page.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Maturity: 0
This structure is derived from SDCBaseQuestionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
sdc-questionnaire-preferredTerminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
sdc-questionnaire-performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. |
sdc-questionnaire-assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | SΣ | 0..1 | string | Business version of the questionnaire |
name | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the questionnaire | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
item | SI | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-obsn-1: Display items cannot be extracted to Observations. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
sdc-questionnaire-preferredTerminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
questionnaire-unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
sdc-questionnaire-observationExtract | S | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract |
sdc-questionnaire-observation-extract-category | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |
sdc-questionnaire-isSubject | 0..1 | boolean | Marks that this item identifies a different subject URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-isSubject | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | S | 1..1 | string | Unique id for item in questionnaire |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | SI | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
sdc-questionnaire-observationExtract | S | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
text | S | 0..1 | string | Primary text for the item |
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
required | SI | 0..1 | boolean | Whether the item must be included in data results |
repeats | SI | 0..1 | boolean | Whether the item may repeat |
readOnly | SI | 0..1 | boolean | Don't allow human editing |
maxLength | SI | 0..1 | integer | No more than this many characters |
answerValueSet | SI | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers |
answerOption | SI | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | SI | 0..* | BackboneElement | Initial value(s) when item is first rendered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Resource) | |||
item | SI | 0..* | See item (Questionnaire) | Nested questionnaire items |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation |
sdc-questionnaire-performerType | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. | |
sdc-questionnaire-assemble-expectation | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) | |
url | Σ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
version | Σ | 0..1 | string | Business version of the questionnaire |
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-obsn-1: Display items cannot be extracted to Observations. |
questionnaire-unit | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |
sdc-questionnaire-observationExtract | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract | |
linkId | 1..1 | string | Unique id for item in questionnaire | |
code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
sdc-questionnaire-observationExtract | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract | |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | 0..1 | string | Primary text for the item | |
type | 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. | |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
answerValueSet | I | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers |
answerOption | I | 0..* | BackboneElement | Permitted answer |
initial | I | 0..* | BackboneElement | Initial value(s) when item is first rendered |
value[x] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Resource) | |||
item | I | 0..* | See item (Questionnaire) | Nested questionnaire items |
Documentation for this format |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Differential View
This structure is derived from SDCBaseQuestionnaire
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
sdc-questionnaire-preferredTerminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
sdc-questionnaire-performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. |
sdc-questionnaire-assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | SΣ | 0..1 | string | Business version of the questionnaire |
name | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the questionnaire | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
item | SI | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-obsn-1: Display items cannot be extracted to Observations. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
sdc-questionnaire-preferredTerminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
questionnaire-unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
sdc-questionnaire-observationExtract | S | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract |
sdc-questionnaire-observation-extract-category | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |
sdc-questionnaire-isSubject | 0..1 | boolean | Marks that this item identifies a different subject URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-isSubject | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | S | 1..1 | string | Unique id for item in questionnaire |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | SI | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
sdc-questionnaire-observationExtract | S | 0..1 | boolean | Marks an item (or all items in a questionnaire) to be extracted using the observation-based approach URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
text | S | 0..1 | string | Primary text for the item |
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Resource) | |||
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
required | SI | 0..1 | boolean | Whether the item must be included in data results |
repeats | SI | 0..1 | boolean | Whether the item may repeat |
readOnly | SI | 0..1 | boolean | Don't allow human editing |
maxLength | SI | 0..1 | integer | No more than this many characters |
answerValueSet | SI | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers |
answerOption | SI | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Resource) | |||
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | SI | 0..* | BackboneElement | Initial value(s) when item is first rendered |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Resource) | |||
item | SI | 0..* | See item (Questionnaire) | Nested questionnaire items |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Questionnaire.language | preferred | CommonLanguages Max Binding: AllLanguages |
Questionnaire.status | required | PublicationStatus |
Questionnaire.subjectType | required | ResourceType |
Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet |
Questionnaire.code | example | QuestionnaireQuestionCodes |
Questionnaire.item.code | example | QuestionnaireQuestionCodes |
Questionnaire.item.type | required | QuestionnaireItemType |
Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes |
Questionnaire.item.enableBehavior | required | EnableWhenBehavior |
Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes |
Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes |
Id | Grade | Path | 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() | |
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() | |
ele-1 | error | Questionnaire.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.extension:designNote | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.extension:designNote | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.extension:terminologyServer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.extension:terminologyServer | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.extension:performerType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.extension:performerType | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.extension:assemble-expectation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.extension:assemble-expectation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.experimental | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.subjectType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.publisher | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.useContext | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.jurisdiction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.copyright | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.approvalDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.lastReviewDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.effectivePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
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-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-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 | |
sdc-1 | error | Questionnaire.item | An item cannot have an answerExpression if answerOption or answerValueSet is already present. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()) | |
sdc-obsn-1 | error | Questionnaire.item | Display items cannot be extracted to Observations. : type!='display' or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationExtract').empty() | |
ele-1 | error | Questionnaire.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:designNote | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:designNote | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:terminologyServer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:terminologyServer | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:unit | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:observationExtract | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:observationExtract | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:observationExtractCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:observationExtractCategory | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.extension:isSubject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.extension:isSubject | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.linkId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.code.extension:observationExtract | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.code.extension:observationExtract | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.code.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.code.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.enableWhen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
ele-1 | error | Questionnaire.item.enableWhen.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.enableWhen.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.enableWhen.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.enableWhen.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.enableWhen.question | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.enableWhen.operator | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.enableWhen.answer[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.enableBehavior | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.required | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.repeats | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.readOnly | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.maxLength | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.answerValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.answerOption | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.answerOption.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.answerOption.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.answerOption.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.answerOption.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.answerOption.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.answerOption.initialSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.initial | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.initial.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.initial.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.initial.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Questionnaire.item.initial.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Questionnaire.item.initial.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Questionnaire.item.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |