Structured Data Capture
3.0.0 - STU 3
Structured Data Capture
3.0.0 - STU 3
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extr-obsn | Version: 3.0.0 | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: SDCQuestionnaireExtractObservation | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDCBaseQuestionnaire
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | C | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| 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. |
| 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) |
| version | SΣ | 0..1 | string | Business version of the questionnaire |
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
  item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-obsn-1: Display items cannot be extracted to Observations. |
 designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
| 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 |
| observationExtractCategory | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |
| 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 |
 code | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
  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 |
| 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 | ?!C | 0..* | BackboneElement | Only allow data when |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
 answer[x] | C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean | boolean | |||
| answerDecimal | decimal | |||
| answerInteger | integer | |||
| answerDate | date | |||
| answerDateTime | dateTime | |||
| answerTime | time | |||
| answerString | string | |||
| answerCoding | Coding | |||
| answerQuantity | Quantity | |||
 answerReference | Reference(Resource) | |||
| required | SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| answerOption | SC | 0..* | BackboneElement | Permitted answer |
| 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) | |||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| 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. | ||||
| 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 | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire 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 | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | ||||
| 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 | ||||
| observationExtractCategory | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |||||
| 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 | SC | 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 | |||||
| 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 | ?!C | 0..* | BackboneElement | Only allow data when | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question | 1..1 | string | Question that determines whether item is enabled | |||||
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] | C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean | boolean | |||||||
| answerDecimal | decimal | |||||||
| answerInteger | integer | |||||||
| answerDate | date | |||||||
| answerDateTime | dateTime | |||||||
| answerTime | time | |||||||
| answerString | string | |||||||
| answerCoding | Coding | |||||||
| answerQuantity | Quantity | |||||||
| answerReference | Reference(Resource) | |||||||
| enableBehavior | C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
| answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Questionnaire.language | preferred | CommonLanguages
| ||||
| Questionnaire.status | required | PublicationStatus | ||||
| Questionnaire.subjectType | required | ResourceType | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.type | required | QuestionnaireItemType | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
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
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| 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. |
| 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) |
| version | SΣ | 0..1 | string | Business version of the questionnaire |
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-obsn-1: Display items cannot be extracted to Observations. |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit |
| 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 |
| observationExtractCategory | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |
| 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 |
| code | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| 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 |
| 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 | ?!C | 0..* | BackboneElement | Only allow data when |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
| answer[x] | C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean | boolean | |||
| answerDecimal | decimal | |||
| answerInteger | integer | |||
| answerDate | date | |||
| answerDateTime | dateTime | |||
| answerTime | time | |||
| answerString | string | |||
| answerCoding | Coding | |||
| answerQuantity | Quantity | |||
| answerReference | Reference(Resource) | |||
| required | SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| answerOption | SC | 0..* | BackboneElement | Permitted answer |
| 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) | |||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Extractable Questionnaire - Observation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| 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. | ||||
| 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 | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType | SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire 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 | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| unit | S | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | ||||
| 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 | ||||
| observationExtractCategory | 0..* | CodeableConcept | Extract the Observation.category value(s) from Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observation-extract-category | |||||
| 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 | SC | 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 | |||||
| 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 | ?!C | 0..* | BackboneElement | Only allow data when | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question | 1..1 | string | Question that determines whether item is enabled | |||||
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] | C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean | boolean | |||||||
| answerDecimal | decimal | |||||||
| answerInteger | integer | |||||||
| answerDate | date | |||||||
| answerDateTime | dateTime | |||||||
| answerTime | time | |||||||
| answerString | string | |||||||
| answerCoding | Coding | |||||||
| answerQuantity | Quantity | |||||||
| answerReference | Reference(Resource) | |||||||
| enableBehavior | C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
| answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Questionnaire.language | preferred | CommonLanguages
| ||||
| Questionnaire.status | required | PublicationStatus | ||||
| Questionnaire.subjectType | required | ResourceType | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.type | required | QuestionnaireItemType | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#3.0.0 based on FHIR 4.0.1. Generated 2023-12-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
