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-adapt-srch | Version: 4.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCQuestionnaireAdaptSearch | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.9 | ||||
Describes the elements that should be exposed in a response to a search for adaptive questionnaires.
This profile adds additional constraints and extensions to the base Search Questionnaire Profile. It identifies core elements and extensions that must be supported and highlights other elements that, while not required, should be exposed in a response to a search for adaptive questionnaires.
Instances complying with this profile will not list any questions. To determine what questions to display, it is necessary to use the next-question operation. Further information on how adaptive questionnaire is implemented can be found on the Adaptive Forms page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search 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 sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. |
  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 |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   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 | |
| assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint 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 |
 identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..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 |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire ele-1: All FHIR elements must have a @value or children |
| useContext |
SC | 0..* | SDCUsageContext | Describes the context of use for a conformance or knowledge resource ele-1: All FHIR elements must have a @value or children sdc-uc-1: If code is gender, focus, user, venue or species, value must be CodeableConcept. If code is age, value must be Range. If code is workflow, task or program, value must be CodeableConcept or Reference |
| jurisdiction |
Σ | 0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
| purpose |
S | 0..1 | markdown | Why this questionnaire is defined ele-1: All FHIR elements must have a @value or children |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
 code |
SΣ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. 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.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.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 |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
This structure is derived from SDCQuestionnaireSearch
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. |
| extension |
1..* | Extension | Extension | |
 Slices for extension |
Content/Rules for all slices | |||
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | |
| submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint |
 item |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search 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 sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. | ||||
| 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 |
1..* | 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 | |||||
| assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |||||
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | |||||
| submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
| 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 |
SΣ | 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Σ | 1..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 |
SΣ | 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 |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 0..1 | markdown | Natural language description of the questionnaire | ||||
| useContext |
SC | 0..* | SDCUsageContext | Describes the context of use for a conformance or knowledge resource sdc-uc-1: If code is gender, focus, user, venue or species, value must be CodeableConcept. If code is age, value must be Range. If code is workflow, task or program, value must be CodeableConcept or Reference | ||||
| jurisdiction |
Σ | 0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
S | 0..1 | markdown | Why this questionnaire is defined | ||||
| copyright |
S | 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 |
SΣ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| 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 |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
This structure is derived from SDCQuestionnaireSearch
Summary
Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search 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 sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. |
| 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 |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 | |
| assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint 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 |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..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 |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire ele-1: All FHIR elements must have a @value or children |
| useContext |
SC | 0..* | SDCUsageContext | Describes the context of use for a conformance or knowledge resource ele-1: All FHIR elements must have a @value or children sdc-uc-1: If code is gender, focus, user, venue or species, value must be CodeableConcept. If code is age, value must be Range. If code is workflow, task or program, value must be CodeableConcept or Reference |
| jurisdiction |
Σ | 0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
| purpose |
S | 0..1 | markdown | Why this questionnaire is defined ele-1: All FHIR elements must have a @value or children |
| copyright |
S | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. 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.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.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 |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
Differential View
This structure is derived from SDCQuestionnaireSearch
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | |
| submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint |
| item |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireSearch | Adaptive Questionnaire - search 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 sdc-adaptive-1: If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. | ||||
| 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 |
1..* | 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 | |||||
| assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |||||
| questionnaireAdaptive |
1..* | boolean, url | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | |||||
| submissionEndpoint |
S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
| 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 |
SΣ | 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Σ | 1..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 |
SΣ | 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 |
SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 0..1 | markdown | Natural language description of the questionnaire | ||||
| useContext |
SC | 0..* | SDCUsageContext | Describes the context of use for a conformance or knowledge resource sdc-uc-1: If code is gender, focus, user, venue or species, value must be CodeableConcept. If code is age, value must be Range. If code is workflow, task or program, value must be CodeableConcept or Reference | ||||
| jurisdiction |
Σ | 0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
S | 0..1 | markdown | Why this questionnaire is defined | ||||
| copyright |
S | 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 |
SΣ | 0..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| 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 |
| sdc-adaptive-1 | error | Questionnaire | If multiple types are present, all must have a value of type 'url'. If no URL is specified, the location to hit the $next-question operation is undefined but typically assumed to be the server hosting the Questionnaire. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').count()>1 implies extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive').all(value = 'url') |
This structure is derived from SDCQuestionnaireSearch
Summary
Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Maturity: 4
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-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change