2.7.0 - STU 3 (2nd ballot)
This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-populate
This profile expands adds additional constraints and extensions to the base SDC questionnaire profile that support generating and potentially partially populating a questionnaire response using existing FHIR resource data. This profile identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the questionnaire response population use-case. 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 Questionnaire Population page.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Questionnaire
Summary
Extensions
This structure refers to these extensions:
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | I | 0..* | Populatable Questionnaire | |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designNote | I | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote |
| sdc-questionnaire-preferredTerminologyServer | I | 0..* | uri | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| cqf-library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
  id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |
 valueCanonical | 0..1 | canonical(Library) | Value of extension | |
 sdc-questionnaire-launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension | 1..1 | Extension | Variable name | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "name" | ||
| valueId | 0..1 | id | Value of extension | |
| extension | 1..* | Extension | Resource type | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "type" | ||
| valueCode | 0..1 | code | Value of extension Binding: Questionnaire Launch Context (example) | |
| extension | 0..1 | Extension | Explanation of context element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "description" | ||
| valueString | 0..1 | string | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext" | |
| sdc-questionnaire-itemContext | 0..1 | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/variable" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-sourceQueries | 0..1 | Reference(Bundle) | Bundle of queries to populate from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceQueries | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceQueries" | |
 valueReference | 0..1 | Reference(Bundle) | Value of extension | |
| sdc-questionnaire-sourceStructureMap | 0..* | canonical(StructureMap) | Map that can populate this questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceStructureMap | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceStructureMap" | |
| valueCanonical | 0..1 | canonical(StructureMap) | Value of extension | |
 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 | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
| title | Σ | 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) |
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType | SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the questionnaire | |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | 0..1 | markdown | Why this questionnaire is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example) |
 item | I | 1..* | BackboneElement | Questions and sections within the Questionnaire |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designNote | I | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote |
| sdc-questionnaire-preferredTerminologyServer | I | 0..* | uri | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| sdc-questionnaire-observationLinkPeriod | 0..1 | Duration | Relevant time to pre-pop observation URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationLinkPeriod | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationLinkPeriod" | |
| valueDuration | 0..1 | Duration | Value of extension | |
| questionnaire-unit | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-unit" | |
| valueCoding | 0..1 | Coding | Value of extension | |
| sdc-questionnaire-itemContext | 0..1 | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/variable" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-contextExpression | 0..* | Expression | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| questionnaire-hidden | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-hidden" | |
| valueBoolean | 0..1 | boolean | Value of extension | |
| sdc-questionnaire-choiceColumn | 0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension | 1..1 | Extension | Column path | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "path" | ||
| valueString | 0..1 | string | Value of extension | |
| extension | 0..1 | Extension | Column label | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "label" | ||
| valueString | 0..1 | string | Value of extension | |
| extension | 0..1 | Extension | Width of column | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "width" | ||
| valueQuantity | 0..1 | Quantity | Value of extension | |
| extension | 0..1 | Extension | Use for display ? | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "forDisplay" | ||
| valueBoolean | 0..1 | boolean | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| code | I | 0..1 | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example) |
| 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) |
| enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required) | |
 answer[x] | I | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example) |
| enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required) |
| required | SI | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SI | 0..1 | boolean | Whether the item may repeat |
| readOnly | SI | 0..1 | boolean | Don't allow human editing |
| maxLength | SI | 0..1 | integer | No more than this many characters |
| answerValueSet | SI | 0..1 | canonical(SDCValueSet) | Valueset containing permitted answers |
| answerOption | SI | 0..* | BackboneElement | Permitted answer |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value Binding: QuestionnaireAnswerCodes (example) | |
| initialSelected | 0..1 | boolean | Whether option is selected by default | |
| initial | SI | 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 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example) |
| item | SI | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
| Documentation for this format | ||||
This structure is derived from Questionnaire
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Questionnaire
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | I | 0..* | Populatable Questionnaire | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designNote | I | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote |
| sdc-questionnaire-preferredTerminologyServer | I | 0..* | uri | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| cqf-library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |
| valueCanonical | 0..1 | canonical(Library) | Value of extension | |
| sdc-questionnaire-launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension | 1..1 | Extension | Variable name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "name" | ||
| valueId | 0..1 | id | Value of extension | |
| extension | 1..* | Extension | Resource type | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "type" | ||
| valueCode | 0..1 | code | Value of extension Binding: Questionnaire Launch Context (example) | |
| extension | 0..1 | Extension | Explanation of context element | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "description" | ||
| valueString | 0..1 | string | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext" | |
| sdc-questionnaire-itemContext | 0..1 | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/variable" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-sourceQueries | 0..1 | Reference(Bundle) | Bundle of queries to populate from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceQueries | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceQueries" | |
| valueReference | 0..1 | Reference(Bundle) | Value of extension | |
| sdc-questionnaire-sourceStructureMap | 0..* | canonical(StructureMap) | Map that can populate this questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceStructureMap | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-sourceStructureMap" | |
| valueCanonical | 0..1 | canonical(StructureMap) | Value of extension | |
| 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 | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
| title | Σ | 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) |
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType | SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the questionnaire | |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| purpose | 0..1 | markdown | Why this questionnaire is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example) |
| item | I | 1..* | BackboneElement | Questions and sections within the Questionnaire |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designNote | I | 0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote |
| sdc-questionnaire-preferredTerminologyServer | I | 0..* | uri | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer |
| sdc-questionnaire-observationLinkPeriod | 0..1 | Duration | Relevant time to pre-pop observation URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationLinkPeriod | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-observationLinkPeriod" | |
| valueDuration | 0..1 | Duration | Value of extension | |
| questionnaire-unit | 0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-unit" | |
| valueCoding | 0..1 | Coding | Value of extension | |
| sdc-questionnaire-itemContext | 0..1 | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/variable" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| sdc-questionnaire-contextExpression | 0..* | Expression | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression" | |
| valueExpression | 0..1 | Expression | Value of extension | |
| questionnaire-hidden | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-hidden" | |
| valueBoolean | 0..1 | boolean | Value of extension | |
| sdc-questionnaire-choiceColumn | 0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension | 1..1 | Extension | Column path | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "path" | ||
| valueString | 0..1 | string | Value of extension | |
| extension | 0..1 | Extension | Column label | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "label" | ||
| valueString | 0..1 | string | Value of extension | |
| extension | 0..1 | Extension | Width of column | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "width" | ||
| valueQuantity | 0..1 | Quantity | Value of extension | |
| extension | 0..1 | Extension | Use for display ? | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "forDisplay" | ||
| valueBoolean | 0..1 | boolean | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn" | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| code | I | 0..1 | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example) |
| 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) |
| enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required) | |
| answer[x] | I | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example) |
| enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required) |
| required | SI | 0..1 | boolean | Whether the item must be included in data results |
| repeats | SI | 0..1 | boolean | Whether the item may repeat |
| readOnly | SI | 0..1 | boolean | Don't allow human editing |
| maxLength | SI | 0..1 | integer | No more than this many characters |
| answerValueSet | SI | 0..1 | canonical(SDCValueSet) | Valueset containing permitted answers |
| answerOption | SI | 0..* | BackboneElement | Permitted answer |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value Binding: QuestionnaireAnswerCodes (example) | |
| initialSelected | 0..1 | boolean | Whether option is selected by default | |
| initial | SI | 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 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example) |
| item | SI | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes |
| Id | Path | Details | Requirements |
| dom-2 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | 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-3 | 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-6 | Questionnaire | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| que-2 | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
| que-0 | 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}') | |
| ele-1 | Questionnaire.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| que-9 | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
| que-8 | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
| que-6 | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
| que-5 | 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-4 | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
| que-3 | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
| que-10 | 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-1 | 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-13 | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
| que-11 | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
| que-12 | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
| ele-1 | Questionnaire.item.enableWhen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| que-7 | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
| ele-1 | Questionnaire.item.answerOption | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Questionnaire.item.initial | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2015+ HL7 International - FHIR Infrastructure Work Group. Package hl7.fhir.uv.sdc#2.7.0 based on FHIR 4.0.0. Generated 2019-03-27
Links: Table of Contents |
QA Report | Search |
Version History |
|
Propose a change