HealthcareAssociatedInfectionReports Implementation Guide CI Build

This page is part of the Healthcare Associated Infection Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.3 StructureDefinition-hai-population-summary-questionnaire

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.

SD.3.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/hai/StructureDefinition/hai-population-summary-questionnaire

Published on Fri Oct 11 15:43:03 EDT 2019 as a active by HL7 Structured Documents Work Group.

This profile builds on Questionnaire

Summary

Mandatory: 15 elements
Must-Support: 24 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Questionnaire.code is sliced based on the values of value:code, pattern:$this (Closed)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire S0..*Healthcare Associated Infection Population Summary Questionnaire
... language S1..1codeRequired Pattern: en-US
... text S0..1Narrative
... identifier S1..1IdentifierGlobally unique identifier for the instance
... title S1..1stringTitle of the HAI report.
... subjectType S1..1codeA Group resource is the subject of the related QuestionnaireResponse
Fixed Value: Group
... date S1..1dateTime
... publisher S1..1string
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction S1..1CodeableConceptRequired 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
... code S1..2(Slice Definition)Slice: Unordered, Closed by value:code, pattern:$this
.... code:sliceHAI S1..1CodingCode for Healthcare Associated Infection Report (fixed)
..... system S1..1uriFixed Value: http://loinc.org
..... code S1..1codeFixed Value: 51897-7
..... display S1..1stringFixed Value: Healthcare Associated Infection report Document
.... code:slicePopulationSummaryReportType S1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode (required)
... item S1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... linkId S1..1string
.... code S0..*Coding
.... type S1..1code
.... enableWhen S0..*BackboneElement
.... required S0..1boolean
.... repeats S0..1boolean
.... answerOption S0..*BackboneElement
.... item S0..*

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SI0..*Healthcare 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)
Max Binding: AllLanguages
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 Σ0..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 ΣI0..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)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeA Group resource is the subject of the related QuestionnaireResponse
Binding: ResourceType (required)

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)

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
... code SΣ1..2(Slice Definition)Concept that represents the overall questionnaire
Slice: Unordered, Closed by value:code, pattern:$this
Binding: QuestionnaireQuestionCodes (example)
.... code:sliceHAI SΣ1..1CodingCode for Healthcare Associated Infection Report (fixed)
Binding: QuestionnaireQuestionCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display SΣ1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... code:slicePopulationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode (required)
... item SI1..*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 SI0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... 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)
.... enableWhen ?!SI0..*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)
..... answer[x] I1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior I0..1codeall | any
Binding: EnableWhenBehavior (required)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... answerValueSet I0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SI0..*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)
...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial I0..*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)
...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format
{% include StructureDefinition-hai-population-summary-questionnaire-pseudo-xml.xhtml %}
{% include StructureDefinition-hai-population-summary-questionnaire-pseudo-json.xhtml %}

Summary

Mandatory: 15 elements
Must-Support: 24 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Questionnaire.code is sliced based on the values of value:code, pattern:$this (Closed)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire S0..*Healthcare Associated Infection Population Summary Questionnaire
... language S1..1codeRequired Pattern: en-US
... text S0..1Narrative
... identifier S1..1IdentifierGlobally unique identifier for the instance
... title S1..1stringTitle of the HAI report.
... subjectType S1..1codeA Group resource is the subject of the related QuestionnaireResponse
Fixed Value: Group
... date S1..1dateTime
... publisher S1..1string
... description S1..1markdownDescription of the population summary questionnaire.
... jurisdiction S1..1CodeableConceptRequired 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
... code S1..2(Slice Definition)Slice: Unordered, Closed by value:code, pattern:$this
.... code:sliceHAI S1..1CodingCode for Healthcare Associated Infection Report (fixed)
..... system S1..1uriFixed Value: http://loinc.org
..... code S1..1codeFixed Value: 51897-7
..... display S1..1stringFixed Value: Healthcare Associated Infection report Document
.... code:slicePopulationSummaryReportType S1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode (required)
... item S1..*BackboneElementItems specific to the population summary questionnaire being modeled.
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... linkId S1..1string
.... code S0..*Coding
.... type S1..1code
.... enableWhen S0..*BackboneElement
.... required S0..1boolean
.... repeats S0..1boolean
.... answerOption S0..*BackboneElement
.... item S0..*

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire SI0..*Healthcare 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)
Max Binding: AllLanguages
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 Σ0..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 ΣI0..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)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeA Group resource is the subject of the related QuestionnaireResponse
Binding: ResourceType (required)

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)

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
... code SΣ1..2(Slice Definition)Concept that represents the overall questionnaire
Slice: Unordered, Closed by value:code, pattern:$this
Binding: QuestionnaireQuestionCodes (example)
.... code:sliceHAI SΣ1..1CodingCode for Healthcare Associated Infection Report (fixed)
Binding: QuestionnaireQuestionCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: 51897-7
..... display SΣ1..1stringRepresentation defined by the system
Fixed Value: Healthcare Associated Infection report Document
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... code:slicePopulationSummaryReportType SΣ1..1CodingType of population summary report
Binding: NHSNPopulationSummaryReportTypeCode (required)
... item SI1..*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 SI0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... 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)
.... enableWhen ?!SI0..*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)
..... answer[x] I1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior I0..1codeall | any
Binding: EnableWhenBehavior (required)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... answerValueSet I0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption SI0..*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)
...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial I0..*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)
...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron