NHSN Healthcare Associated Infection (HAI) Reports, published by HL7 International - Structured Documents Work Group. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/HAI/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/hai/StructureDefinition/hai-population-summary-questionnaire | Version: 2.1.0 | |||
Active as of 2023-09-06 | Computable Name: HAIPopulationSummaryQuestionnaire |
This profile represents a Healthcare Associated Infection Population Summary form as a FHIR Questionnaire. A Population Summary Report records summary data for a group, such as the patients in a particular ward, during a specified period.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | S | 0..* | Questionnaire | Healthcare Associated Infection Population Summary Questionnaire |
language | S | 1..1 | code | Language of the resource content Required Pattern: en-US |
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
url | S | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | S | 1..1 | Identifier | Globally unique identifier for the instance |
title | S | 1..1 | string | Title of the HAI report. |
subjectType | S | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Fixed Value: Group |
date | S | 1..1 | dateTime | Date last changed |
publisher | S | 1..1 | string | Name of the publisher (organization or individual) |
description | S | 1..1 | markdown | Description of the population summary questionnaire. |
jurisdiction | S | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |
Slices for code | S | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this |
code:HAI | S | 1..1 | Coding | Concept that represents the overall questionnaire Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |
code:populationSummaryReportType | S | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. |
item | S | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
linkId | S | 1..1 | string | Unique id for item in questionnaire |
code | S | 0..* | Coding | Corresponding concept for this item in a terminology |
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + |
enableWhen | S | 0..* | BackboneElement | Only allow data when |
required | S | 0..1 | boolean | Whether the item must be included in data results |
repeats | S | 0..1 | boolean | Whether the item may repeat |
answerOption | S | 0..* | BackboneElement | Permitted answer |
item | S | 0..* | Nested questionnaire items | |
Documentation for this format |
Path | Conformance | ValueSet |
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | SC | 0..* | Questionnaire | Healthcare Associated Infection Population Summary Questionnaire | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | S | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Required Pattern: en-US | ||||
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
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 | SΣ | 1..1 | Identifier | Globally unique identifier for the instance | ||||
title | SΣ | 1..1 | string | Title of the HAI report. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
subjectType | SΣ | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Fixed Value: Group | ||||
date | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) | ||||
description | S | 1..1 | markdown | Description of the population summary questionnaire. | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |||||
Slices for code | SΣ | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
code:HAI | SΣ | 1..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. Required Pattern: At least the following | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |||||
code:populationSummaryReportType | SΣ | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. | ||||
item | SC | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | S | 1..1 | string | Unique id for item in questionnaire | ||||
code | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
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 | ?!SC | 0..* | BackboneElement | Only allow data when | ||||
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] | C | 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) | |||||||
required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 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 | C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 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 / Code | ||||
Questionnaire.language | preferred | Pattern: en-US
| ||||
Questionnaire.status | required | PublicationStatus | ||||
Questionnaire.subjectType | required | Fixed Value: Group | ||||
Questionnaire.jurisdiction | extensible | Pattern: US | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
Questionnaire.code:HAI | example | Pattern: LOINC code 51897-7("Healthcare Associated Infection report Document") | ||||
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) | ||||
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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | 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}') | |
que-1 | error | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | 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-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | 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-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | SC | 0..* | Questionnaire | Healthcare Associated Infection Population Summary 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 | S | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Required Pattern: en-US | ||||
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | SΣ | 1..1 | Identifier | Globally unique identifier for the instance | ||||
version | Σ | 0..1 | string | Business version of the questionnaire | ||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | SΣ | 1..1 | string | Title of the HAI report. | ||||
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 | SΣ | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Fixed Value: Group | ||||
date | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 1..1 | markdown | Description of the population summary questionnaire. | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | ||||
Slices for code | SΣ | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
code:HAI | SΣ | 1..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
code:populationSummaryReportType | SΣ | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. | ||||
item | SC | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (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 | 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 | ?!SC | 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] | C | 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 | C | 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 | ||||
repeats | SC | 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 this many characters | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
answerOption | SC | 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: 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 | C | 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: 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 / Code | ||||
Questionnaire.language | preferred | Pattern: en-US
| ||||
Questionnaire.status | required | PublicationStatus | ||||
Questionnaire.subjectType | required | Fixed Value: Group | ||||
Questionnaire.jurisdiction | extensible | Pattern: US | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
Questionnaire.code:HAI | example | Pattern: LOINC code 51897-7("Healthcare Associated Infection report Document") | ||||
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) | ||||
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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | 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}') | |
que-1 | error | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | 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-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | 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-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
This structure is derived from Questionnaire
Summary
Mandatory: 12 elements
Must-Support: 22 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | S | 0..* | Questionnaire | Healthcare Associated Infection Population Summary Questionnaire |
language | S | 1..1 | code | Language of the resource content Required Pattern: en-US |
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
url | S | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
identifier | S | 1..1 | Identifier | Globally unique identifier for the instance |
title | S | 1..1 | string | Title of the HAI report. |
subjectType | S | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Fixed Value: Group |
date | S | 1..1 | dateTime | Date last changed |
publisher | S | 1..1 | string | Name of the publisher (organization or individual) |
description | S | 1..1 | markdown | Description of the population summary questionnaire. |
jurisdiction | S | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |
Slices for code | S | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this |
code:HAI | S | 1..1 | Coding | Concept that represents the overall questionnaire Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |
code:populationSummaryReportType | S | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. |
item | S | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
linkId | S | 1..1 | string | Unique id for item in questionnaire |
code | S | 0..* | Coding | Corresponding concept for this item in a terminology |
type | S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + |
enableWhen | S | 0..* | BackboneElement | Only allow data when |
required | S | 0..1 | boolean | Whether the item must be included in data results |
repeats | S | 0..1 | boolean | Whether the item may repeat |
answerOption | S | 0..* | BackboneElement | Permitted answer |
item | S | 0..* | Nested questionnaire items | |
Documentation for this format |
Path | Conformance | ValueSet |
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | SC | 0..* | Questionnaire | Healthcare Associated Infection Population Summary Questionnaire | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | S | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Required Pattern: en-US | ||||
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
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 | SΣ | 1..1 | Identifier | Globally unique identifier for the instance | ||||
title | SΣ | 1..1 | string | Title of the HAI report. | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
subjectType | SΣ | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Fixed Value: Group | ||||
date | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) | ||||
description | S | 1..1 | markdown | Description of the population summary questionnaire. | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |||||
Slices for code | SΣ | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
code:HAI | SΣ | 1..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. Required Pattern: At least the following | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |||||
code:populationSummaryReportType | SΣ | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. | ||||
item | SC | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | S | 1..1 | string | Unique id for item in questionnaire | ||||
code | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
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 | ?!SC | 0..* | BackboneElement | Only allow data when | ||||
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] | C | 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) | |||||||
required | SC | 0..1 | boolean | Whether the item must be included in data results | ||||
repeats | SC | 0..1 | boolean | Whether the item may repeat | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
answerOption | SC | 0..* | BackboneElement | Permitted answer | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 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 | C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | 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 / Code | ||||
Questionnaire.language | preferred | Pattern: en-US
| ||||
Questionnaire.status | required | PublicationStatus | ||||
Questionnaire.subjectType | required | Fixed Value: Group | ||||
Questionnaire.jurisdiction | extensible | Pattern: US | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
Questionnaire.code:HAI | example | Pattern: LOINC code 51897-7("Healthcare Associated Infection report Document") | ||||
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) | ||||
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.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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | 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}') | |
que-1 | error | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | 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-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | 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-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Questionnaire | SC | 0..* | Questionnaire | Healthcare Associated Infection Population Summary 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 | S | 1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Required Pattern: en-US | ||||
text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | SΣ | 1..1 | Identifier | Globally unique identifier for the instance | ||||
version | Σ | 0..1 | string | Business version of the questionnaire | ||||
name | ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
title | SΣ | 1..1 | string | Title of the HAI report. | ||||
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 | SΣ | 1..1 | code | A Group resource is the subject of the related QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Fixed Value: Group | ||||
date | SΣ | 1..1 | dateTime | Date last changed | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | S | 1..1 | markdown | Description of the population summary questionnaire. | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: US | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | ||||
Slices for code | SΣ | 2..2 | Coding | Concept that represents the overall questionnaire Slice: Unordered, Open by value:$this Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
code:HAI | SΣ | 1..1 | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 51897-7 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Healthcare Associated Infection report Document | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
code:populationSummaryReportType | SΣ | 1..1 | Coding | Type of population summary report Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report. | ||||
item | SC | 1..* | BackboneElement | Items specific to the population summary questionnaire being modeled. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | SC | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (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 | 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 | ?!SC | 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] | C | 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 | C | 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 | ||||
repeats | SC | 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 this many characters | ||||
answerValueSet | C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
answerOption | SC | 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: 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 | C | 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: 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 / Code | ||||
Questionnaire.language | preferred | Pattern: en-US
| ||||
Questionnaire.status | required | PublicationStatus | ||||
Questionnaire.subjectType | required | Fixed Value: Group | ||||
Questionnaire.jurisdiction | extensible | Pattern: US | ||||
Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC) | ||||
Questionnaire.code:HAI | example | Pattern: LOINC code 51897-7("Healthcare Associated Infection report Document") | ||||
Questionnaire.code:populationSummaryReportType | required | NHSNPopulationSummaryReportTypeCode(CDCNHSN) | ||||
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 |
dom-2 | error | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Questionnaire | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
que-0 | warning | 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}') | |
que-1 | error | 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-2 | error | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
que-3 | error | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-4 | error | Questionnaire.item | A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty() | |
que-5 | error | 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-6 | error | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-7 | error | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) | |
que-8 | error | Questionnaire.item | Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-9 | error | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-10 | error | 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-11 | error | Questionnaire.item | If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty() | |
que-12 | error | Questionnaire.item | If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists() | |
que-13 | error | Questionnaire.item | Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1 |
This structure is derived from Questionnaire
Summary
Mandatory: 12 elements
Must-Support: 22 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron