This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4
FHIR Infrastructure Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/cqf-questionnaire
A questionnaire with the ability to specify behavior associated with questions or groups of questions
This profile was published on Sat, May 30, 2015 00:00+1000 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Questionnaire.
This structure is derived from Questionnaire.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | Questionnaire | A questionnaire with the ability to specify behavior associated with questions or groups of questions | |
cqf-library | 0..* | canonical(Library) | A library containing logic referenced by the questionnaire URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | I | 0..* | Questionnaire | 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: Common Languages (preferred): IETF language tag
| |||||
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 | |||||
cqf-library | 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 | Σ | 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): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subjectType | Σ | 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 (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: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions. | ||||
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire | ||||
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 | ||||
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: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions. | ||||
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): Distinguishes groups from questions and display text and indicates data type for questions. | |||||
enableWhen | ?!I | 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 | 1..1 | string | Question that determines whether item is enabled | |||||
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: Questionnaire Answer Codes (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 | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
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 | Answer value Binding: Questionnaire Answer Codes (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 | 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 | Actual value for initializing the question Binding: Questionnaire Answer Codes (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 | I | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
Documentation for this format |
<!-- CQF-Questionnaire --> <Questionnaire xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 0..1 Canonical identifier for this questionnaire, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the questionnaire --></identifier> <version value="[string]"/><!-- 0..1 Business version of the questionnaire --> <name value="[string]"/><!-- 0..1 Name for this questionnaire (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this questionnaire (human friendly) --> <derivedFrom value="[canonical]"/><!-- 0..* Instantiates protocol or definition --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the questionnaire --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this questionnaire is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the questionnaire was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the questionnaire was last reviewed --> <effectivePeriod><!-- 0..1 Period When the questionnaire is expected to be used --></effectivePeriod> <code><!-- 0..* Coding Concept that represents the overall questionnaire --></code> <item> 0..* BackboneElement <!-- 0..* Questions and sections within the Questionnaire --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- 1..1 Unique id for item in questionnaire --> <definition value="[uri]"/><!-- 0..1 ElementDefinition - details for the item --> <code><!-- 0..* Coding Corresponding concept for this item in a terminology --></code> <prefix value="[string]"/><!-- 0..1 E.g. "1(a)", "2.5.3" --> <text value="[string]"/><!-- 0..1 Primary text for the item --> <type value="[code]"/><!-- 1..1 group | display | boolean | decimal | integer | date | dateTime + --> <enableWhen> 0..* BackboneElement <!-- 0..* Only allow data when --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <question value="[string]"/><!-- 1..1 Question that determines whether item is enabled --> <operator value="[code]"/><!-- 1..1 exists | = | != | > | < | >= | <= --> <answer[x]><!-- 1..1 boolean|decimal|integer| date|dateTime|time|string|Coding|Quantity|Reference(Resource) Value for question comparison based on operator --></answer[x]> </enableWhen> <enableBehavior value="[code]"/><!-- 0..1 all | any --> <required value="[boolean]"/><!-- 0..1 Whether the item must be included in data results --> <repeats value="[boolean]"/><!-- 0..1 Whether the item may repeat --> <readOnly value="[boolean]"/><!-- 0..1 Don't allow human editing --> <maxLength value="[integer]"/><!-- 0..1 No more than this many characters --> <answerValueSet value="[canonical]"/><!-- 0..1 Valueset containing permitted answers --> <answerOption> 0..* BackboneElement <!-- 0..* Permitted answer --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <value[x]><!-- 1..1 integer|date|time|string| Coding|Reference(Resource) Answer value --></value[x]> <initialSelected value="[boolean]"/><!-- 0..1 Whether option is selected by default --> </answerOption> <initial> 0..* BackboneElement <!-- 0..* Initial value(s) when item is first rendered --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <value[x]><!-- 1..1 boolean|decimal|integer|date| dateTime|time|string|uri|Attachment|Coding|Quantity|Reference(Resource) Actual value for initializing the question --></value[x]> </initial> <item><!-- See http://hl7.org/fhir/StructureDefinition/Questionnaire#Questionnaire.item Nested questionnaire items --></item> </item> </Questionnaire>
{ // CQF-Questionnaire // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], // C?Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // A library containing logic referenced by the questionnaire // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C?Canonical identifier for this questionnaire, represented as a URI (globally unique) "identifier" : [{ Identifier }], // C?Additional identifier for the questionnaire "version" : "<string>", // C?Business version of the questionnaire "name" : "<string>", // C?Name for this questionnaire (computer friendly) "title" : "<string>", // C?Name for this questionnaire (human friendly) "derivedFrom" : ["<canonical>"], // C?Instantiates protocol or definition "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C?For testing purposes, not real usage "subjectType" : ["<code>"], // C?Resource that can be subject of QuestionnaireResponse "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C?Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C?Natural language description of the questionnaire "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for questionnaire (if applicable) "purpose" : "<markdown>", // C?Why this questionnaire is defined "copyright" : "<markdown>", // C?Use and/or publishing restrictions "approvalDate" : "<date>", // C?When the questionnaire was approved by publisher "lastReviewDate" : "<date>", // C?When the questionnaire was last reviewed "effectivePeriod" : { Period }, // C?When the questionnaire is expected to be used "code" : [{ Coding }], // C?Concept that represents the overall questionnaire "item" : [{ BackboneElement }], // C?Questions and sections within the Questionnaire }
This structure is derived from Questionnaire.
Differential View
This structure is derived from Questionnaire.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | 0..* | Questionnaire | A questionnaire with the ability to specify behavior associated with questions or groups of questions | |
cqf-library | 0..* | canonical(Library) | A library containing logic referenced by the questionnaire URL: http://hl7.org/fhir/StructureDefinition/cqf-library | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | I | 0..* | Questionnaire | 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: Common Languages (preferred): IETF language tag
| |||||
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 | |||||
cqf-library | 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 | Σ | 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): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
subjectType | Σ | 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 (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: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions. | ||||
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire | ||||
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 | ||||
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: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions. | ||||
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): Distinguishes groups from questions and display text and indicates data type for questions. | |||||
enableWhen | ?!I | 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 | 1..1 | string | Question that determines whether item is enabled | |||||
operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
answer[x] | I | 1..1 | Value for question comparison based on operator Binding: Questionnaire Answer Codes (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 | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
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 | Answer value Binding: Questionnaire Answer Codes (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 | 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 | Actual value for initializing the question Binding: Questionnaire Answer Codes (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 | I | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
Documentation for this format |
XML Template
<!-- CQF-Questionnaire --> <Questionnaire xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- 0..1 Canonical identifier for this questionnaire, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the questionnaire --></identifier> <version value="[string]"/><!-- 0..1 Business version of the questionnaire --> <name value="[string]"/><!-- 0..1 Name for this questionnaire (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this questionnaire (human friendly) --> <derivedFrom value="[canonical]"/><!-- 0..* Instantiates protocol or definition --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the questionnaire --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this questionnaire is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the questionnaire was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the questionnaire was last reviewed --> <effectivePeriod><!-- 0..1 Period When the questionnaire is expected to be used --></effectivePeriod> <code><!-- 0..* Coding Concept that represents the overall questionnaire --></code> <item> 0..* BackboneElement <!-- 0..* Questions and sections within the Questionnaire --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- 1..1 Unique id for item in questionnaire --> <definition value="[uri]"/><!-- 0..1 ElementDefinition - details for the item --> <code><!-- 0..* Coding Corresponding concept for this item in a terminology --></code> <prefix value="[string]"/><!-- 0..1 E.g. "1(a)", "2.5.3" --> <text value="[string]"/><!-- 0..1 Primary text for the item --> <type value="[code]"/><!-- 1..1 group | display | boolean | decimal | integer | date | dateTime + --> <enableWhen> 0..* BackboneElement <!-- 0..* Only allow data when --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <question value="[string]"/><!-- 1..1 Question that determines whether item is enabled --> <operator value="[code]"/><!-- 1..1 exists | = | != | > | < | >= | <= --> <answer[x]><!-- 1..1 boolean|decimal|integer| date|dateTime|time|string|Coding|Quantity|Reference(Resource) Value for question comparison based on operator --></answer[x]> </enableWhen> <enableBehavior value="[code]"/><!-- 0..1 all | any --> <required value="[boolean]"/><!-- 0..1 Whether the item must be included in data results --> <repeats value="[boolean]"/><!-- 0..1 Whether the item may repeat --> <readOnly value="[boolean]"/><!-- 0..1 Don't allow human editing --> <maxLength value="[integer]"/><!-- 0..1 No more than this many characters --> <answerValueSet value="[canonical]"/><!-- 0..1 Valueset containing permitted answers --> <answerOption> 0..* BackboneElement <!-- 0..* Permitted answer --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <value[x]><!-- 1..1 integer|date|time|string| Coding|Reference(Resource) Answer value --></value[x]> <initialSelected value="[boolean]"/><!-- 0..1 Whether option is selected by default --> </answerOption> <initial> 0..* BackboneElement <!-- 0..* Initial value(s) when item is first rendered --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <value[x]><!-- 1..1 boolean|decimal|integer|date| dateTime|time|string|uri|Attachment|Coding|Quantity|Reference(Resource) Actual value for initializing the question --></value[x]> </initial> <item><!-- See http://hl7.org/fhir/StructureDefinition/Questionnaire#Questionnaire.item Nested questionnaire items --></item> </item> </Questionnaire>
JSON Template
{ // CQF-Questionnaire // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], // C?Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // A library containing logic referenced by the questionnaire // C? // from Element: extension } ], "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "url" : "<uri>", // C?Canonical identifier for this questionnaire, represented as a URI (globally unique) "identifier" : [{ Identifier }], // C?Additional identifier for the questionnaire "version" : "<string>", // C?Business version of the questionnaire "name" : "<string>", // C?Name for this questionnaire (computer friendly) "title" : "<string>", // C?Name for this questionnaire (human friendly) "derivedFrom" : ["<canonical>"], // C?Instantiates protocol or definition "status" : "<code>", // C? R! draft | active | retired | unknown "experimental" : <boolean>, // C?For testing purposes, not real usage "subjectType" : ["<code>"], // C?Resource that can be subject of QuestionnaireResponse "date" : "<dateTime>", // C?Date last changed "publisher" : "<string>", // C?Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // C?Contact details for the publisher "description" : "<markdown>", // C?Natural language description of the questionnaire "useContext" : [{ UsageContext }], // C?The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for questionnaire (if applicable) "purpose" : "<markdown>", // C?Why this questionnaire is defined "copyright" : "<markdown>", // C?Use and/or publishing restrictions "approvalDate" : "<date>", // C?When the questionnaire was approved by publisher "lastReviewDate" : "<date>", // C?When the questionnaire was last reviewed "effectivePeriod" : { Period }, // C?When the questionnaire is expected to be used "code" : [{ Coding }], // C?Concept that represents the overall questionnaire "item" : [{ BackboneElement }], // C?Questions and sections within the Questionnaire }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
Questionnaire.language | Common Languages | preferred | Common Languages |
Questionnaire.status | PublicationStatus | required | PublicationStatus |
Questionnaire.subjectType | ResourceType | required | ResourceType |
Questionnaire.jurisdiction | Jurisdiction | extensible | Jurisdiction |
Questionnaire.code | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.item.code | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.item.type | QuestionnaireItemType | required | QuestionnaireItemType |
Questionnaire.item.enableWhen.operator | QuestionnaireItemOperator | required | QuestionnaireItemOperator |
Questionnaire.item.enableWhen.answer[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Questionnaire.item.enableBehavior | EnableWhenBehavior | required | EnableWhenBehavior |
Questionnaire.item.answerOption.value[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Questionnaire.item.initial.value[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |