Structured Data Capture
3.0.0 - STU 3
Structured Data Capture
3.0.0 - STU 3
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-behave | Version: 3.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: SDCQuestionnaireBehave | ||
Defines additional capabilities for controlling data entry and calculating values within the questionnaire.
This profile adds additional constraints and extensions to the base SDC Base Questionnaire Profile that support the design of questionnaires with more sophisticated behavior and flow-control, including calculated values, determining what portions of the questionnaire to show based on previous answers, etc. 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 the elements and extensions included in the profile can be found on the Form Behavior page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SDCBaseQuestionnaire
| Id | Grade | Path(s) | Details | Requirements |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | C | 0..* | SDCBaseQuestionnaire | Advanced Behavior Questionnaire |
  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) |
| entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire |
| submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint |
| signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |
| constraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |
| library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
| launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
 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 |
| 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. |
| 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. |
  item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression |
 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 | |
| answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression |
| usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. |
| itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |
 itemMinOccurs | S | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs |
   extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
 value[x] | 1..1 | integer | Value of extension | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| itemMinOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
 itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| itemMaxOccurs | S | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
| value[x] | 1..1 | integer | Value of extension | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| itemMaxOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |
 value[x] | 1..1 | Value of extension | ||
 value[x]:All Types | Content/Rules for all Types | |||
 minValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |
| value[x] | 1..1 | Value of extension | ||
| value[x]:All Types | Content/Rules for all Types | |||
| maxValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueInstant | instant | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| minQuantity | 0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |
| value[x] | 0..1 | Quantity | Value of extension | |
| minQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| maxQuantity | 0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |
| value[x] | 0..1 | Quantity | Value of extension | |
| maxQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| maxSize | 0..1 | decimal | Max size in MB URL: http://hl7.org/fhir/StructureDefinition/maxSize | |
| answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet |
| unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |
| unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |
| allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |
| candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |
| lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |
| itemConstraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |
| initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |
| calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |
| enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| 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 | ?!C | 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 |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| value | 0..1 | string | Primitive value for canonical | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| answerOption | SC | 0..* | BackboneElement | Permitted answer |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive |
| ordinalValue | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueInteger | integer | |||
| valueDate | date | |||
| valueTime | time | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueReference | Reference(Resource) | |||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparator |
| Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparator |
| 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 |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Advanced Behavior Questionnaire | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 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) | ||||
| entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
| submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
| signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| constraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |||||
| library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
| launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |||||
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |||||
| 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 | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType | 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 | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression | ||||
| 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 | |||||
| answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression | ||||
| usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | ||||
| itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| itemMinOccurs | S | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |||||
| value[x] | 1..1 | integer | Value of extension | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMinOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | integer | Primitive value for integer | |||||
| itemMaxOccurs | S | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |||||
| value[x] | 1..1 | integer | Value of extension | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMaxOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | integer | Primitive value for integer | |||||
| minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | ||||
| regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |||||
| value[x] | 1..1 | Value of extension | ||||||
| value[x]:All Types | Content/Rules for all Types | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| minValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |||||
| value[x] | 1..1 | Value of extension | ||||||
| value[x]:All Types | Content/Rules for all Types | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| maxValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueInstant | instant | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| minQuantity | 0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |||||
| value[x] | 0..1 | Quantity | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| minQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 0..1 | code | Coded form of the unit | ||||
| maxQuantity | 0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |||||
| value[x] | 0..1 | Quantity | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| maxQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 0..1 | code | Coded form of the unit | ||||
| maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
| mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| maxSize | 0..1 | decimal | Max size in MB URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
| answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | ||||
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
| unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |||||
| unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |||||
| allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |||||
| candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |||||
| lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |||||
| itemConstraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |||||
| initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |||||
| calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |||||
| enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
| 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 | C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| text | 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 | ?!C | 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 | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | string | Primitive value for canonical | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
| ordinalValue | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueCoding | Coding | |||||||
| valueReference | Reference(Resource) | |||||||
| initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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.extension:minQuantity.value[x].comparator | required | QuantityComparator | ||||
| Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparator | ||||
| 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 |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 30 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Differential View
This structure is derived from SDCBaseQuestionnaire
| Id | Grade | Path(s) | Details | Requirements |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Advanced Behavior Questionnaire |
| 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) |
| entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire |
| submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint |
| signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |
| constraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |
| library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
| launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |
| 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 |
| 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. |
| 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. |
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression |
| 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 | |
| answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression |
| usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. |
| itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |
| itemMinOccurs | S | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
| value[x] | 1..1 | integer | Value of extension | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| itemMinOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| itemMaxOccurs | S | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
| value[x] | 1..1 | integer | Value of extension | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| itemMaxOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength |
| regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex |
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |
| value[x] | 1..1 | Value of extension | ||
| value[x]:All Types | Content/Rules for all Types | |||
| minValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |
| value[x] | 1..1 | Value of extension | ||
| value[x]:All Types | Content/Rules for all Types | |||
| maxValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueInstant | instant | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| minQuantity | 0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |
| value[x] | 0..1 | Quantity | Value of extension | |
| minQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| maxQuantity | 0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |
| value[x] | 0..1 | Quantity | Value of extension | |
| maxQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces |
| mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| maxSize | 0..1 | decimal | Max size in MB URL: http://hl7.org/fhir/StructureDefinition/maxSize | |
| answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression |
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption |
| unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet |
| unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |
| unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |
| allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |
| candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |
| lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |
| itemConstraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |
| initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |
| calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |
| enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| linkId | S | 1..1 | string | Unique id for item in questionnaire |
| 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 | ?!C | 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 |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| repeats | SC | 0..1 | boolean | Whether the item may repeat |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| readOnly | SC | 0..1 | boolean | Don't allow human editing |
| value | 0..1 | boolean | Primitive value for boolean | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| maxLength | SC | 0..1 | integer | No more than this many characters |
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers |
| value | 0..1 | string | Primitive value for canonical | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
| answerOption | SC | 0..* | BackboneElement | Permitted answer |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive |
| ordinalValue | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueInteger | integer | |||
| valueDate | date | |||
| valueTime | time | |||
| valueString | string | |||
| valueCoding | Coding | |||
| valueReference | Reference(Resource) | |||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.item.extension:minQuantity.value[x].comparator | required | QuantityComparator |
| Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparator |
| 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 |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire | C | 0..* | SDCBaseQuestionnaire | Advanced Behavior Questionnaire | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 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) | ||||
| entryMode | S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
| submissionEndpoint | S | 0..* | uri | Where to send answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint | ||||
| signatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| constraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |||||
| library | 0..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |||||
| launchContext | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | |||||
| variable | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | |||||
| 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 | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title | SΣ | 0..1 | string | Name for this questionnaire (human friendly) | ||||
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType | 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 | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | 0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this questionnaire is defined | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used | ||||
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item | SC | 0..* | BackboneElement | Questions and sections within the Questionnaire sdc-behave-2: An item cannot have both enableWhen and enableWhenExpression sdc-behave-1: An item cannot have both initial.value and initialExpression | ||||
| 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 | |||||
| answerExpression | S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression | ||||
| usageMode | S | 0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | ||||
| itemSignatureRequired | 0..* | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| itemMinOccurs | S | 0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |||||
| value[x] | 1..1 | integer | Value of extension | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMinOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| itemMinOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | integer | Primitive value for integer | |||||
| itemMaxOccurs | S | 0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |||||
| value[x] | 1..1 | integer | Value of extension | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemMaxOccursCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| itemMaxOccursExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | integer | Primitive value for integer | |||||
| minLength | S | 0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | ||||
| regex | S | 0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | ||||
| minValue | S | 0..1 | date, dateTime, time, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/minValue" | |||||
| value[x] | 1..1 | Value of extension | ||||||
| value[x]:All Types | Content/Rules for all Types | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| minValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| maxValue | S | 0..1 | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/maxValue" | |||||
| value[x] | 1..1 | Value of extension | ||||||
| value[x]:All Types | Content/Rules for all Types | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| maxValueCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueInstant | instant | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| minQuantity | 0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity" | |||||
| value[x] | 0..1 | Quantity | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| minQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 0..1 | code | Coded form of the unit | ||||
| maxQuantity | 0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity" | |||||
| value[x] | 0..1 | Quantity | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| maxQuantityCalculated | 0..1 | string | A calculated value URL: http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 0..1 | code | Coded form of the unit | ||||
| maxDecimalPlaces | S | 0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | ||||
| mimeType | S | 0..* | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| maxSize | 0..1 | decimal | Max size in MB URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
| answerOptionsToggleExpression | S | 0..* | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | ||||
| unitOption | S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| unitValueSet | S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
| unitOpen | 0..1 | code | Used to denote if user can specify alternate codes URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitOpen Binding: Questionnaire answer constraints value set (required): The types of constraints possible on a question item that has a list of permitted answers | |||||
| unitSupplementalSystem | 0..1 | canonical() | This extension indicates the code system the additional units are drawn from URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-unitSupplementalSystem | |||||
| allowedResource | S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| allowedProfile | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | |||||
| candidateExpression | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | |||||
| lookupQuestionnaire | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | |||||
| itemConstraint | 0..* | (Complex) | Constraint URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint | |||||
| initialExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | |||||
| calculatedExpression | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | |||||
| enableWhenExpression | S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
| 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 | C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| text | 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 | ?!C | 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 | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| requiredExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| repeatsExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| readOnly | SC | 0..1 | boolean | Don't allow human editing | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| readOnlyExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | boolean | Primitive value for boolean | |||||
| maxLength | SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet | SC | 0..1 | canonical(SDC Value Set) | Valueset containing permitted answers | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | string | Primitive value for canonical | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| answerValueSetExpression | S | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| optionExclusive | S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
| ordinalValue | S | 0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueCoding | Coding | |||||||
| valueReference | Reference(Resource) | |||||||
| initialSelected | 0..1 | boolean | Whether option is selected by default | |||||
| initial | SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] | S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean | boolean | |||||||
| valueDecimal | decimal | |||||||
| valueInteger | integer | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueTime | time | |||||||
| valueString | string | |||||||
| valueUri | uri | |||||||
| valueAttachment | Attachment | |||||||
| valueCoding | Coding | |||||||
| valueQuantity | Quantity | |||||||
| valueReference | Reference(Resource) | |||||||
| item | SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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.extension:minQuantity.value[x].comparator | required | QuantityComparator | ||||
| Questionnaire.item.extension:maxQuantity.value[x].comparator | required | QuantityComparator | ||||
| 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 |
| sdc-behave-1 | error | Questionnaire.item | An item cannot have both initial.value and initialExpression : initial.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression').empty() | |
| sdc-behave-2 | error | Questionnaire.item | An item cannot have both enableWhen and enableWhenExpression : enableWhen.empty() or extension('http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression').empty() |
This structure is derived from SDCBaseQuestionnaire
Summary
Must-Support: 30 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#3.0.0 based on FHIR 4.0.1. Generated 2023-12-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change