Structured Data Capture
4.0.0 - STU 4
Structured Data Capture
4.0.0 - STU 4
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 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-search | Version: 4.0.0 | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCQuestionnaireSearch | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.51 | ||||
Describes the elements that should be exposed in a response to a search for questionnaires.
This profile adds additional constraints and extensions to the base SDC Base Questionnaire Profile that define basic expectations for searching repositories for questionnaires of interest. I.e. It identifies which elements of Questionnaire searchable metadata should be supported as well as identifying others of potential relevance. Further information on how this use-case is implemented as well as guidance on on the elements and extensions included in the profile can be found on the Finding a Questionnaire page.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCQuestionnaireCommon | A structured set of questions Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
| extension:copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |
 extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire |
| version |
SΣ | 0..1 | string | Business version of the questionnaire |
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire |
| useContext |
SΣ | 0..* | SDCUsageContext | The context that the content is intended to support |
| 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. |
 item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14 |
 Slices for extension |
Content/Rules for all slices | |||
| extension:hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire Constraints: que-15 |
| 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" |
| 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 Constraints: que-7 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question |
1..1 | string | Question that determines whether item is enabled | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
 answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
  answerReference |
Reference(Resource) | |||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing |
| answerValueSet |
C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] |
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) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
 item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| 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/jurisdiction|4.0.1From the FHIR Standard | |
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|4.0.1From the FHIR Standard | |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|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-answers|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-answers|4.0.1From the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
| que-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
| que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
| que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
| que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
| que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
| que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
| que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
| que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
| que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
| que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
| que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
| que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
| que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) : extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists() | |
| que-15 | error | Questionnaire.item.linkId | Link ids must be 255 characters or less : $this.length() <= 255 | |
| sdc-1 | error | Questionnaire.item | An item cannot have an answerExpression if answerOption or answerValueSet is already present. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()) | |
| sdc-2 | error | Questionnaire | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | best practice | Questionnaire | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from SDCQuestionnaireCommon
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
0..* | SDCQuestionnaireCommon | A structured set of questions | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |
| identifier |
S | 0..* | Identifier | Additional identifier for the questionnaire |
| title |
1..1 | string | Name for this questionnaire (human friendly) | |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| date |
S | 1..1 | dateTime | Date last changed |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire |
| useContext |
S | 0..* | SDCUsageContext | The context that the content is intended to support |
| jurisdiction |
0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) | |
| 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 |
| item |
||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |
| code |
0..* | Coding | Corresponding concept for this item in a terminology | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | A structured set of questions Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |||||
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D | ||||
| extension:copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
| extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) Constraints: cnl-1 | ||||
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 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 |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
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 |
SΣ | 0..* | SDCUsageContext | The context that the content is intended to support | ||||
| 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. | ||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire Constraints: que-15 | ||||
| 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 Constraints: que-7 | ||||
| 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/languages|4.0.1From 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/jurisdiction|4.0.1From the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|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-answers|4.0.1From 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-answers|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Questionnaire.url | Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
| que-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
| que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
| que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
| que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
| que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
| que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
| que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
| que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
| que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
| que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
| que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
| que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
| que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) : extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists() | |
| que-15 | error | Questionnaire.item.linkId | Link ids must be 255 characters or less : $this.length() <= 255 | |
| sdc-1 | error | Questionnaire.item | An item cannot have an answerExpression if answerOption or answerValueSet is already present. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()) | |
| sdc-2 | error | Questionnaire | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | best practice | Questionnaire | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from SDCQuestionnaireCommon
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | A structured set of questions Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D |
| extension:copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |
| extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire |
| version |
SΣ | 0..1 | string | Business version of the questionnaire |
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| date |
SΣ | 1..1 | dateTime | Date last changed |
| publisher |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire |
| useContext |
SΣ | 0..* | SDCUsageContext | The context that the content is intended to support |
| 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. |
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden |
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire Constraints: que-15 |
| 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" |
| 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 Constraints: que-7 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question |
1..1 | string | Question that determines whether item is enabled | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
| answerReference |
Reference(Resource) | |||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing |
| answerValueSet |
C | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] |
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) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| 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/jurisdiction|4.0.1From the FHIR Standard | |
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|4.0.1From the FHIR Standard | |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|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-answers|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-answers|4.0.1From the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
| que-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
| que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
| que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
| que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
| que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
| que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
| que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
| que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
| que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
| que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
| que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
| que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
| que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) : extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists() | |
| que-15 | error | Questionnaire.item.linkId | Link ids must be 255 characters or less : $this.length() <= 255 | |
| sdc-1 | error | Questionnaire.item | An item cannot have an answerExpression if answerOption or answerValueSet is already present. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()) | |
| sdc-2 | error | Questionnaire | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | best practice | Questionnaire | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
Differential View
This structure is derived from SDCQuestionnaireCommon
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
0..* | SDCQuestionnaireCommon | A structured set of questions | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |
| identifier |
S | 0..* | Identifier | Additional identifier for the questionnaire |
| title |
1..1 | string | Name for this questionnaire (human friendly) | |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| date |
S | 1..1 | dateTime | Date last changed |
| publisher |
S | 0..1 | string | Name of the publisher (organization or individual) |
| description |
S | 0..1 | markdown | Natural language description of the questionnaire |
| useContext |
S | 0..* | SDCUsageContext | The context that the content is intended to support |
| jurisdiction |
0..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) | |
| 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 |
| item |
||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |
| code |
0..* | Coding | Corresponding concept for this item in a terminology | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireCommon | A structured set of questions Constraints: que-0, que-2, cnl-0, sdc-2, sdc-3 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |||||
| extension:versionAlgorithm |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D]] | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm%5Bx%5D | ||||
| extension:copyrightLabel |
0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel | |||||
| extension:assembledFrom |
0..* | canonical() | Identifies subQuestionnaires used in the assembly process URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembledFrom | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) Constraints: cnl-1 | ||||
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 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 |
SΣ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
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 |
SΣ | 0..* | SDCUsageContext | The context that the content is intended to support | ||||
| 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. | ||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13, sdc-1, que-1a, que-1b, que-1c, que-14 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| extension:terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/StructureDefinition/preferredTerminologyServer | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
SC | 1..1 | string | Unique id for item in questionnaire Constraints: que-15 | ||||
| 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 Constraints: que-7 | ||||
| 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/languages|4.0.1From 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/jurisdiction|4.0.1From the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questions|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-answers|4.0.1From 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-answers|4.0.1From the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes(a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answers|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Questionnaire.url | Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| que-0 | warning | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| que-1 | error | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
| que-1a | error | Questionnaire.item | Group items must have nested items when Questionanire is complete : (type='group' and %resource.status='complete') implies item.empty().not() | |
| que-1b | warning | Questionnaire.item | Groups should have items : type='group' implies item.empty().not() | |
| que-1c | error | Questionnaire.item | Display items cannot have child items : type='display' implies item.empty() | |
| que-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
| que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
| que-5 | error | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
| que-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
| que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
| que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
| que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
| que-10 | error | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
| que-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
| que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
| que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
| que-14 | warning | Questionnaire.item | Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose) : extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint').exists() implies answerOption.exists() or answerValueSet.exists() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').exists() | |
| que-15 | error | Questionnaire.item.linkId | Link ids must be 255 characters or less : $this.length() <= 255 | |
| sdc-1 | error | Questionnaire.item | An item cannot have an answerExpression if answerOption or answerValueSet is already present. : extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression').empty().not() implies (answerOption.empty() and answerValueSet.empty()) | |
| sdc-2 | error | Questionnaire | If version is present, versionAlgorithm must be present. : version.exists() implies extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').exists() | |
| sdc-3 | best practice | Questionnaire | Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes : extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]').all(value.ofType(Coding).where(system='http://hl7.org/fhir/version-algorithm' and code='semver').exists()) |
This structure is derived from SDCQuestionnaireCommon
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
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 based on FHIR 4.0.1. Generated 2025-09-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change