NHSN Healthcare Associated Infection (HAI) Reports
2.1.0 - STU 2.1 United States of America flag

This page is part of the Healthcare Associated Infection Implementation Guide (v2.1.0: STU2) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Healthcare Associated Infection Population Summary Questionnaire

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire S0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... language S1..1codeLanguage of the resource content
Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... url S1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... title S1..1stringTitle of the HAI report.
... subjectType S1..1codeA Group resource is the subject of the related QuestionnaireResponse
Fixed Value: Group
... date S1..1dateTimeDate last changed
... publisher S1..1stringName of the publisher (organization or individual)
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction S1..1CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
... Slices for code S2..2CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:$this
.... code:HAI S1..1CodingConcept that represents the overall questionnaire
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
.... code:populationSummaryReportType S1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.

... item S1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... linkId S1..1stringUnique id for item in questionnaire
.... code S0..*CodingCorresponding concept for this item in a terminology
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
.... enableWhen S0..*BackboneElementOnly allow data when
.... required S0..1booleanWhether the item must be included in data results
.... repeats S0..1booleanWhether the item may repeat
.... answerOption S0..*BackboneElementPermitted answer
.... item S0..*Nested questionnaire items

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SC0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ1..1IdentifierGlobally unique identifier for the instance
... title SΣ1..1stringTitle of the HAI report.
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ1..1codeA 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..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction SΣ1..1CodeableConceptIntended 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
... Slices for code SΣ2..2CodingConcept 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..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.



Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
.... code:populationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.


... item SC1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... code SC0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!SC0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagepreferredPattern: en-US
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Group
Questionnaire.jurisdictionextensiblePattern: US
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.code:HAIexamplePattern: LOINC code 51897-7("Healthcare Associated Infection report Document")
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SC0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ1..1IdentifierGlobally unique identifier for the instance
... version Σ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringTitle of the HAI report.
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeA 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..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownDescription of the population summary questionnaire.
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ1..1CodeableConceptIntended 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... Slices for code SΣ2..2CodingConcept 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..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... code:populationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.


... item SC1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code SC0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text 0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!SC0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagepreferredPattern: en-US
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Group
Questionnaire.jurisdictionextensiblePattern: US
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.code:HAIexamplePattern: LOINC code 51897-7("Healthcare Associated Infection report Document")
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan 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:

  • The element Questionnaire.code is sliced based on the value of value:$this

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire S0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... language S1..1codeLanguage of the resource content
Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... url S1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... title S1..1stringTitle of the HAI report.
... subjectType S1..1codeA Group resource is the subject of the related QuestionnaireResponse
Fixed Value: Group
... date S1..1dateTimeDate last changed
... publisher S1..1stringName of the publisher (organization or individual)
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction S1..1CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
... Slices for code S2..2CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:$this
.... code:HAI S1..1CodingConcept that represents the overall questionnaire
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
.... code:populationSummaryReportType S1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.

... item S1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... linkId S1..1stringUnique id for item in questionnaire
.... code S0..*CodingCorresponding concept for this item in a terminology
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
.... enableWhen S0..*BackboneElementOnly allow data when
.... required S0..1booleanWhether the item must be included in data results
.... repeats S0..1booleanWhether the item may repeat
.... answerOption S0..*BackboneElementPermitted answer
.... item S0..*Nested questionnaire items

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SC0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ1..1IdentifierGlobally unique identifier for the instance
... title SΣ1..1stringTitle of the HAI report.
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType SΣ1..1codeA 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..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction SΣ1..1CodeableConceptIntended 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
... Slices for code SΣ2..2CodingConcept 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..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.



Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
.... code:populationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.


... item SC1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... code SC0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!SC0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagepreferredPattern: en-US
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Group
Questionnaire.jurisdictionextensiblePattern: US
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.code:HAIexamplePattern: LOINC code 51897-7("Healthcare Associated Infection report Document")
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SC0..*QuestionnaireHealthcare Associated Infection Population Summary Questionnaire
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S1..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Required Pattern: en-US
... text S0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ1..1IdentifierGlobally unique identifier for the instance
... version Σ0..1stringBusiness version of the questionnaire
... name ΣC0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringTitle of the HAI report.
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeA 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..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownDescription of the population summary questionnaire.
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ1..1CodeableConceptIntended 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso:std:iso:3166
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: US
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... Slices for code SΣ2..2CodingConcept 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..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... code:populationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode(CDCNHSN) (required): Codes describing the type of population summary report.


... item SC1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code SC0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text 0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!SC0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required SC0..1booleanWhether the item must be included in data results
.... repeats SC0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SC0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SC0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagepreferredPattern: en-US
Additional Bindings Purpose
AllLanguages Max Binding
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Group
Questionnaire.jurisdictionextensiblePattern: US
Questionnaire.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.code:HAIexamplePattern: LOINC code 51897-7("Healthcare Associated Infection report Document")
Questionnaire.code:populationSummaryReportTyperequiredNHSNPopulationSummaryReportTypeCode(CDCNHSN)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf 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-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName 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-1errorQuestionnaire.itemGroup 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-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan 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:

  • The element Questionnaire.code is sliced based on the value of value:$this

 

Other representations of profile: CSV, Excel, Schematron