ART-DECOR® Questionnaires
0.1.0 - ci-build
ART-DECOR® Questionnaires
0.1.0 - ci-build
ART-DECOR® Questionnaires - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://art-decor.org/fhir/questionnaire/StructureDefinition/ArtDecorQuestionnaire | Version: 0.1.0 | |||
| Active as of 2024-02-13 | Computable Name: ArtDecorBaseQuestionnaire | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDCBaseQuestionnaire
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | 0..* | SDCBaseQuestionnaire | A structured set of questions | |
  itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
 name | S | 0..1 | string | Name for this questionnaire (computer friendly) |
| experimental | S | 0..1 | boolean | For testing purposes, not real usage |
| date | S | 0..1 | dateTime | Date last changed |
| publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
| contact | S | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 0..1 | markdown | Natural language description of the questionnaire |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| code | S | 0..* | Coding | Concept that represents the overall questionnaire |
 item | ||||
 itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| definition | S | 0..1 | uri | ElementDefinition - details for the item |
| code | S | 0..1 | Coding | Corresponding concept for this item in a terminology |
 enableWhen | S | 0..* | BackboneElement | Only allow data when |
 question | S | 1..1 | string | Question that determines whether item is enabled |
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= |
 answer[x] | S | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator |
| enableBehavior | S | 0..1 | code | all | any |
| answerOption | ||||
| value[x] | S | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value |
| initialSelected | S | 0..1 | boolean | Whether option is selected by default |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | A structured set of questions |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. |
| assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| version | SΣ | 0..1 | string | Business version of the questionnaire |
| name | SΣC | 0..1 | string | Name for this questionnaire (computer friendly) |
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| 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Σ | 0..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
 contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 0..1 | markdown | Natural language description of the questionnaire |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| code | SΣ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| definition | S | 0..1 | uri | ElementDefinition - details for the item |
| code | SC | 0..1 | 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 | S | 0..1 | string | Primary text for the item |
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. |
| enableWhen | ?!SC | 0..* | BackboneElement | Only allow data when |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | S | 1..1 | string | Question that determines whether item is enabled |
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. |
 answer[x] | SC | 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 | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| required | SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC ValueSet) | 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) | |||
| initialSelected | S | 0..1 | boolean | Whether option is selected by default |
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 | |
| 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()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | A structured set of questions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. | ||||
| assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) | ||||
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version | SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name | SΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | 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Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 0..1 | markdown | Natural language description of the questionnaire | ||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 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..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. | ||||
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId | S | 1..1 | string | Unique id for item in questionnaire | ||||
| definition | S | 0..1 | uri | ElementDefinition - details for the item | ||||
| code | SC | 0..1 | 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 | S | 0..1 | string | Primary text for the item | ||||
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| enableWhen | ?!SC | 0..* | BackboneElement | Only allow data when | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question | S | 1..1 | string | Question that determines whether item is enabled | ||||
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | ||||
| answer[x] | SC | 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 | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC ValueSet) | 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 | S | 0..1 | boolean | Whether option is selected by default | ||||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Questionnaire.language | preferred | CommonLanguages
| ||||
| Questionnaire.status | required | PublicationStatus | ||||
| Questionnaire.subjectType | required | ResourceType | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.type | required | QuestionnaireItemType | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 | |
| 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()) |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 23 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from SDCBaseQuestionnaire
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | 0..* | SDCBaseQuestionnaire | A structured set of questions | |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| name | S | 0..1 | string | Name for this questionnaire (computer friendly) |
| experimental | S | 0..1 | boolean | For testing purposes, not real usage |
| date | S | 0..1 | dateTime | Date last changed |
| publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
| contact | S | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 0..1 | markdown | Natural language description of the questionnaire |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| code | S | 0..* | Coding | Concept that represents the overall questionnaire |
| item | ||||
| itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| definition | S | 0..1 | uri | ElementDefinition - details for the item |
| code | S | 0..1 | Coding | Corresponding concept for this item in a terminology |
| enableWhen | S | 0..* | BackboneElement | Only allow data when |
| question | S | 1..1 | string | Question that determines whether item is enabled |
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= |
| answer[x] | S | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator |
| enableBehavior | S | 0..1 | code | all | any |
| answerOption | ||||
| value[x] | S | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value |
| initialSelected | S | 0..1 | boolean | Whether option is selected by default |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | A structured set of questions |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. |
| assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| version | SΣ | 0..1 | string | Business version of the questionnaire |
| name | SΣC | 0..1 | string | Name for this questionnaire (computer friendly) |
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| 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Σ | 0..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 0..1 | markdown | Natural language description of the questionnaire |
| copyright | S | 0..1 | markdown | Use and/or publishing restrictions |
| code | SΣ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire |
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |
| itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| definition | S | 0..1 | uri | ElementDefinition - details for the item |
| code | SC | 0..1 | 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 | S | 0..1 | string | Primary text for the item |
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. |
| enableWhen | ?!SC | 0..* | BackboneElement | Only allow data when |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | S | 1..1 | string | Question that determines whether item is enabled |
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. |
| answer[x] | SC | 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 | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| required | SC | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC ValueSet) | 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) | |||
| initialSelected | S | 0..1 | boolean | Whether option is selected by default |
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 | |
| 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()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | A structured set of questions | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| performerType | S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. | ||||
| assemble-expectation | S | 0..1 | code | Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) | ||||
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version | SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name | SΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | 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Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 0..1 | markdown | Natural language description of the questionnaire | ||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 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..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| itemControl | S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
| itemExtractionContext | S | 0..1 | Expression, code | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemExtractionContext Binding: ResourceType (required): If value is of type 'code', then the extraction is always the creation of a new resource of the specified type. | ||||
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId | S | 1..1 | string | Unique id for item in questionnaire | ||||
| definition | S | 0..1 | uri | ElementDefinition - details for the item | ||||
| code | SC | 0..1 | 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 | S | 0..1 | string | Primary text for the item | ||||
| type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| enableWhen | ?!SC | 0..* | BackboneElement | Only allow data when | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| question | S | 1..1 | string | Question that determines whether item is enabled | ||||
| operator | S | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | ||||
| answer[x] | SC | 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 | SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC ValueSet) | 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 | S | 0..1 | boolean | Whether option is selected by default | ||||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Questionnaire.language | preferred | CommonLanguages
| ||||
| Questionnaire.status | required | PublicationStatus | ||||
| Questionnaire.subjectType | required | ResourceType | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
| Questionnaire.item.type | required | QuestionnaireItemType | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 | |
| 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()) |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 23 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron