This page is part of the Documentation Templates and Rules (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-r4
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CQF-Questionnaire
This structure is derived from CQF-Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | |||
cqf-library | 1..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
status | 1..1 | code | ||
experimental | 0..0 | |||
date | 1..1 | dateTime | ||
contact | 1..* | ContactDetail | ||
item | 1..* | BackboneElement | ||
cqf-expression | 1..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A questionnaire with the ability to specify behavior associated with questions or groups of questions | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
cqf-library | 1..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library Slice: Unordered, Open by value:url | |
cqf-library | I | 0..* | canonical(Library) | A library containing logic referenced by the questionnaire URL: http://hl7.org/fhir/StructureDefinition/cqf-library |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 0..1 | string | Business version of the questionnaire |
name | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
date | Σ | 1..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 1..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the questionnaire | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example) |
item | I | 1..* | BackboneElement | Questions and sections within the Questionnaire |
id | 0..1 | string | Unique id for inter-element referencing | |
cqf-expression | I | 1..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example) |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | 0..1 | string | Primary text for the item | |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) | |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required) | |
answer[x] | I | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example) |
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required) |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
answerOption | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value Binding: QuestionnaireAnswerCodes (example) | |
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | I | 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] | 1..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example) | |
item | I | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
Documentation for this format |
This structure is derived from CQF-Questionnaire
Differential View
This structure is derived from CQF-Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | |||
cqf-library | 1..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
status | 1..1 | code | ||
experimental | 0..0 | |||
date | 1..1 | dateTime | ||
contact | 1..* | ContactDetail | ||
item | 1..* | BackboneElement | ||
cqf-expression | 1..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A questionnaire with the ability to specify behavior associated with questions or groups of questions | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
cqf-library | 1..* | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library Slice: Unordered, Open by value:url | |
cqf-library | I | 0..* | canonical(Library) | A library containing logic referenced by the questionnaire URL: http://hl7.org/fhir/StructureDefinition/cqf-library |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 0..1 | string | Business version of the questionnaire |
name | ΣI | 0..1 | string | Name for this questionnaire (computer friendly) |
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) |
derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
date | Σ | 1..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 1..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the questionnaire | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example) |
item | I | 1..* | BackboneElement | Questions and sections within the Questionnaire |
id | 0..1 | string | Unique id for inter-element referencing | |
cqf-expression | I | 1..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example) |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | 0..1 | string | Primary text for the item | |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) | |
enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
question | 1..1 | string | Question that determines whether item is enabled | |
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required) | |
answer[x] | I | 1..1 | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource) | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example) |
enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required) |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
answerOption | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | 1..1 | integer, date, time, string, Coding, Reference(Resource) | Answer value Binding: QuestionnaireAnswerCodes (example) | |
initialSelected | 0..1 | boolean | Whether option is selected by default | |
initial | I | 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] | 1..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example) | |
item | I | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
Documentation for this format |
Other representations of profile: Schematron
Id | Path | Details | Requirements |
dom-2 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-6 | Questionnaire | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
que-2 | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-0 | Questionnaire | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
ele-1 | Questionnaire.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Questionnaire.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Questionnaire.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Questionnaire.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Questionnaire.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
que-9 | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-8 | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-6 | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-5 | Questionnaire.item | Only 'choice' and 'open-choice' items can have answerValueSet : (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty()) | |
que-4 | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-3 | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-10 | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() | |
que-1 | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
que-13 | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 | |
que-11 | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Questionnaire.item.enableWhen | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
que-7 | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
ele-1 | Questionnaire.item.answerOption | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Questionnaire.item.initial | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |