Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extr-template | Version: 4.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: SDCQuestionnaireExtractTemplate | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.83 | ||||
Defines elements that allow conversion of a QuestionnaireResponse to a FHIR resource or Bundle of FHIR resources using the Template-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 Template-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.
The resource(s) in the contained property that are referenced by the templateExtract extension will use the templateExtractContext and templateExtractValue extensions to indicate what properties need to be replaced with data in the questionnaire response answers.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDCQuestionnaireCommon
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCQuestionnaireCommon | Extractable Questionnaire - Template dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes tev-1: Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
S | 1..* | Resource | Contained, inline Resources |
  Slices for extension |
Content/Rules for all slices | |||
   versionAlgorithm |
S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| templateExtractBundle |
S | 0..* | Reference(Bundle) {c} | Establishes extract context for a Questionnaire to a Transaction Bundle using an extraction template URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| title |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
  item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) |
 Slices for extension |
Content/Rules for all slices | |||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| answerConstraint |
0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less |
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. ele-1: All FHIR elements must have a @value or children |
| enableWhen |
?!C | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| question |
1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children | |
 answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
  answerReference |
Reference(Resource) | |||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueReference |
Reference(Resource) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
 item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | Extractable Questionnaire - Template que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes tev-1: Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). | ||||
| 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 |
S | 1..* | Resource | Contained, inline Resources | ||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| versionAlgorithm |
S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] | ||||
| copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract | ||||
| templateExtractBundle |
S | 0..* | Reference(Bundle) {c} | Establishes extract context for a Questionnaire to a Transaction Bundle using an extraction template URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle | ||||
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext | ||||
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
Σ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType |
Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| answerConstraint |
0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint | |||||
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract | ||||
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext | ||||
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire que-15: Link ids must be 255 characters or less | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| text |
0..1 | string | Primary text for the item | |||||
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| enableWhen |
?!C | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question |
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 |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 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] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
This structure is derived from SDCQuestionnaireCommon
Summary
Mandatory: 1 element
Must-Support: 8 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Differential View
This structure is derived from SDCQuestionnaireCommon
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | Extractable Questionnaire - Template dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes tev-1: Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
S | 1..* | Resource | Contained, inline Resources |
| Slices for extension |
Content/Rules for all slices | |||
| versionAlgorithm |
S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| templateExtractBundle |
S | 0..* | Reference(Bundle) {c} | Establishes extract context for a Questionnaire to a Transaction Bundle using an extraction template URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| title |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) |
| Slices for extension |
Content/Rules for all slices | |||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| answerConstraint |
0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less |
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. ele-1: All FHIR elements must have a @value or children |
| enableWhen |
?!C | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| question |
1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children | |
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
| answerReference |
Reference(Resource) | |||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueReference |
Reference(Resource) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | Extractable Questionnaire - Template que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes tev-1: Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). | ||||
| 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 |
S | 1..* | Resource | Contained, inline Resources | ||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| versionAlgorithm |
S | 0..1 | string, Coding | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] | ||||
| copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract | ||||
| templateExtractBundle |
S | 0..* | Reference(Bundle) {c} | Establishes extract context for a Questionnaire to a Transaction Bundle using an extraction template URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle | ||||
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext | ||||
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
Σ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType |
Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| answerConstraint |
0..1 | code | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint | |||||
| templateExtract |
S | 0..* | (Complex) | Establishes extract context for a Questionnaire/item using an extraction template resource URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract | ||||
| extractContext |
S | 0..* | string, Expression | FhirPath expression URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractContext | ||||
| extractAllocateId |
S | 0..* | string | Variable name for the new uuid. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire que-15: Link ids must be 255 characters or less | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| text |
0..1 | string | Primary text for the item | |||||
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| enableWhen |
?!C | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question |
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 |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 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] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| tev-1 | error | Questionnaire | Either the `templateExtract` or a `templateExtractBundle` extension must be provided (or both). : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtractBundle').exists() or repeat(item).extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract').exists() |
This structure is derived from SDCQuestionnaireCommon
Summary
Mandatory: 1 element
Must-Support: 8 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#4.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change