Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | TU | DomainResource | A structured set of questions + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: The link ids for groups and questions must be unique within the questionnaire Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | ΣC | 0..1 | uri | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Business identifier for questionnaire |
version | Σ | 0..1 | string | Business version of the questionnaire |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) |
title | ΣT | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | Σ | 0..* | canonical(Questionnaire) | Based on Questionnaire |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: Resource Types (Required) |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | ΣT | 0..1 | markdown | Natural language description of the questionnaire |
useContext | ΣTU | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this questionnaire is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed by the publisher | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (Example) |
item | C | 0..* | BackboneElement | Questions and sections within the Questionnaire + Rule: Group items must have nested items when Questionanire is complete + Warning: Groups should have items + Rule: Display items cannot have child items + Rule: Display items cannot have a "code" asserted + Rule: A question cannot have both answerOption and answerValueSet + Rule: Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet + Rule: Required and repeat aren't permitted for display items + Rule: Initial values can't be specified for groups or display items + Rule: Read-only can't be specified for "display" items + Rule: Maximum length can only be declared for simple question types + Rule: If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead + Rule: If there are more than one enableWhen, enableBehavior must be specified + Rule: Can only have multiple initial values for repeating items + Warning: Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) |
linkId | C | 1..1 | string | Unique id for item in questionnaire + Warning: Link ids should be 255 characters or less |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: Questionnaire Question Codes (Example) |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | T | 0..1 | string | Primary text for the item |
type | C | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: Questionnaire Item Type (Required) |
enableWhen | ?!C | 0..* | BackboneElement | Only allow data when + Rule: If the operator is 'exists', the value must be a boolean |
question | 1..1 | string | The linkId of question that determines whether item is enabled/disabled | |
operator | C | 1..1 | code | exists | = | != | > | < | >= | <= Binding: Questionnaire Item Operator (Required) |
answer[x] | TC | 1..1 | Value for question comparison based on operator Binding: Questionnaire Answer Codes (Example) | |
answerBoolean | boolean | |||
answerDecimal | decimal | |||
answerInteger | integer | |||
answerDate | date | |||
answerDateTime | dateTime | |||
answerTime | time | |||
answerString | string | |||
answerCoding | Coding | |||
answerQuantity | Quantity | |||
answerReference | Reference(Any) | |||
enableBehavior | C | 0..1 | code | all | any Binding: Enable When Behavior (Required) |
disabledDisplay | 0..1 | code | hidden | protected Binding: Questionnaire Item Disabled Display (Required) | |
required | C | 0..1 | boolean | Whether the item must be included in data results |
repeats | C | 0..1 | boolean | Whether the item may repeat |
readOnly | C | 0..1 | boolean | Don't allow human editing |
maxLength | C | 0..1 | integer | No more than these many characters |
answerConstraint | C | 0..1 | code | optionsOnly | optionsOrType | optionsOrString Binding: Questionnaire answer constraints value set (Required) |
answerValueSet | C | 0..1 | canonical(ValueSet) | ValueSet containing permitted answers |
answerOption | C | 0..* | BackboneElement | Permitted answer |
value[x] | T | 1..1 | Answer value Binding: Questionnaire Answer Codes (Example) | |
valueInteger | integer | |||
valueDate | date | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
valueReference | Reference(Any) | |||
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | C | 0..* | BackboneElement | Initial value(s) when item is first rendered |
value[x] | T | 1..1 | Actual value for initializing the question Binding: Questionnaire Answer Codes (Example) | |
valueBoolean | boolean | |||
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueUri | uri | |||
valueAttachment | Attachment | |||
valueCoding | Coding | |||
valueQuantity | Quantity | |||
valueReference | Reference(Any) | |||
item | 0..* | see item | Nested questionnaire items | |
Documentation for this format |