Situational Awareness for Novel Epidemic Response
0.1.0 - STU Ballot

This page is part of the Situational Awareness for Novel Epidemic Response (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: PublicHealthMeasureReport

Defining URL:http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureReport
Version:0.1.0
Name:PublicHealthMeasureReport
Title:Public Health Measure Report
Status:Draft as of 2020-10-19T21:09:16+00:00
Definition:

Profile Public Health Measure Report

The Public Health Measure Report Profile ensures that MeasureReports conforms to the minimal content required to properly interpret a report of a Public Health Measure.

Publisher:HL7 International Public Health Workgroup
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/uv/saner/StructureDefinition/PublicHealthMeasureReport

Formal Views of Profile Content

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

This structure is derived from MeasureReport

Summary

Mandatory: 3 elements (8 nested mandatory elements)
Must-Support: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from MeasureReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport I0..*MeasureReportResults of a measure evaluation
mrp-1: Measure Reports used for data collection SHALL NOT communicate group and score information
mrp-2: Stratifiers SHALL be either a single criteria or a set of criteria components
ReporterPresentInCompleteReport: A reporter must be present in a complete report.
... status 1..1codecomplete | pending | error
Binding: MeasureReportStatus (required)
... type 1..1codeMeasureReports generated conforming to this profile are always summary reports
Required Pattern: summary
... measure 1..1canonical(Measure)Each MeasureReport resource must document the measure it is reporting for.
.... identifier 1..1IdentifierThe subject shall have an identifier which uniquely identifies the subject to the recepient.
... date 1..1PreciseDateTimeThe date the report was generated must be specified, and must be precise to the second
... period 1..1PeriodA period must be present
.... start 1..1PreciseDateTimeThe end time of the period must be present, be precise to the second, and have a time zone
.... end 1..1PreciseDateTimePrimitive Type dateTime
... group
.... code 1..1CodeableConceptThe code for each group must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
.... population I0..*BackboneElementThe populations in the group
HasValueOrDataAbsentReason: A population.count must have a value, or .extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
..... code 1..1CodeableConceptThe code for each population must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
..... count 0..1integerA count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension.
.... stratifier
..... code 1..*CodeableConceptA stratifier must have a code when present
..... stratum 1..*BackboneElementThere must be at least one stratum reported
...... value 0..0
...... population 1..*BackboneElementAt least one stratum population must be present
....... code 1..1CodeableConceptThe population code must be present
....... count 1..1integerThe population code count be present
... evaluatedResource S0..*Reference(Resource)Include references to MeasureReport or QuestionnaireResponse resources used to compute an aggregated report

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport I0..*MeasureReportResults of a measure evaluation
ReporterPresentInCompleteReport: A reporter must be present in a complete report.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... identifier Σ0..*IdentifierAdditional identifier for the MeasureReport
... status ?!Σ1..1codecomplete | pending | error
Binding: MeasureReportStatus (required)
... type ΣI1..1codeMeasureReports generated conforming to this profile are always summary reports
Binding: MeasureReportType (required)
Required Pattern: summary
... measure Σ1..1canonical(Measure)Each MeasureReport resource must document the measure it is reporting for.
... subject Σ0..1Reference(Location)The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ1..1IdentifierThe subject shall have an identifier which uniquely identifies the subject to the recepient.
.... display Σ0..1stringText alternative for the resource
... date 1..1PreciseDateTimeThe date the report was generated must be specified, and must be precise to the second
... reporter Σ0..1Reference(Practitioner | PractitionerRole | Location | Organization)Who is reporting the data
... period Σ1..1PeriodA period must be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start 1..1PreciseDateTimeThe end time of the period must be present, be precise to the second, and have a time zone
.... end 1..1PreciseDateTimePrimitive Type dateTime
... improvementNotation ?!Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
... group I0..*BackboneElementMeasure results for each group
.... 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
.... code Σ1..1CodeableConceptThe code for each group must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
.... population I0..*BackboneElementThe populations in the group
HasValueOrDataAbsentReason: A population.count must have a value, or .extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
..... 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
..... code Σ1..1CodeableConceptThe code for each population must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
Binding: MeasurePopulationType (extensible)
..... count 0..1integerA count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension.
..... subjectResults 0..1Reference(List)For subject-list reports, the subject results in this population
.... measureScore Σ0..1QuantityWhat score this group achieved
.... stratifier 0..*BackboneElementStratification results
..... 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
..... code 1..*CodeableConceptA stratifier must have a code when present
..... stratum 1..*BackboneElementThere must be at least one stratum reported
...... 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
...... component 0..*BackboneElementStratifier component values
....... 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
....... code 1..1CodeableConceptWhat stratifier component of the group
....... value 1..1CodeableConceptThe stratum component value, e.g. male
...... population 1..*BackboneElementAt least one stratum population must be present
....... 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
....... code 1..1CodeableConceptThe population code must be present
Binding: MeasurePopulationType (extensible)
....... count 1..1integerThe population code count be present
....... subjectResults 0..1Reference(List)For subject-list reports, the subject results in this population
...... measureScore 0..1QuantityWhat score this stratum achieved
... evaluatedResource S0..*Reference(Resource)Include references to MeasureReport or QuestionnaireResponse resources used to compute an aggregated report

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport I0..*MeasureReportResults of a measure evaluation
ReporterPresentInCompleteReport: A reporter must be present in a complete report.
... evaluatedResource 0..*Reference(Resource)Include references to MeasureReport or QuestionnaireResponse resources used to compute an aggregated report

doco Documentation for this format

This structure is derived from MeasureReport

Summary

Mandatory: 3 elements (8 nested mandatory elements)
Must-Support: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from MeasureReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport I0..*MeasureReportResults of a measure evaluation
mrp-1: Measure Reports used for data collection SHALL NOT communicate group and score information
mrp-2: Stratifiers SHALL be either a single criteria or a set of criteria components
ReporterPresentInCompleteReport: A reporter must be present in a complete report.
... status 1..1codecomplete | pending | error
Binding: MeasureReportStatus (required)
... type 1..1codeMeasureReports generated conforming to this profile are always summary reports
Required Pattern: summary
... measure 1..1canonical(Measure)Each MeasureReport resource must document the measure it is reporting for.
.... identifier 1..1IdentifierThe subject shall have an identifier which uniquely identifies the subject to the recepient.
... date 1..1PreciseDateTimeThe date the report was generated must be specified, and must be precise to the second
... period 1..1PeriodA period must be present
.... start 1..1PreciseDateTimeThe end time of the period must be present, be precise to the second, and have a time zone
.... end 1..1PreciseDateTimePrimitive Type dateTime
... group
.... code 1..1CodeableConceptThe code for each group must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
.... population I0..*BackboneElementThe populations in the group
HasValueOrDataAbsentReason: A population.count must have a value, or .extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
..... code 1..1CodeableConceptThe code for each population must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
..... count 0..1integerA count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension.
.... stratifier
..... code 1..*CodeableConceptA stratifier must have a code when present
..... stratum 1..*BackboneElementThere must be at least one stratum reported
...... value 0..0
...... population 1..*BackboneElementAt least one stratum population must be present
....... code 1..1CodeableConceptThe population code must be present
....... count 1..1integerThe population code count be present
... evaluatedResource S0..*Reference(Resource)Include references to MeasureReport or QuestionnaireResponse resources used to compute an aggregated report

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MeasureReport I0..*MeasureReportResults of a measure evaluation
ReporterPresentInCompleteReport: A reporter must be present in a complete report.
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... identifier Σ0..*IdentifierAdditional identifier for the MeasureReport
... status ?!Σ1..1codecomplete | pending | error
Binding: MeasureReportStatus (required)
... type ΣI1..1codeMeasureReports generated conforming to this profile are always summary reports
Binding: MeasureReportType (required)
Required Pattern: summary
... measure Σ1..1canonical(Measure)Each MeasureReport resource must document the measure it is reporting for.
... subject Σ0..1Reference(Location)The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ1..1IdentifierThe subject shall have an identifier which uniquely identifies the subject to the recepient.
.... display Σ0..1stringText alternative for the resource
... date 1..1PreciseDateTimeThe date the report was generated must be specified, and must be precise to the second
... reporter Σ0..1Reference(Practitioner | PractitionerRole | Location | Organization)Who is reporting the data
... period Σ1..1PeriodA period must be present
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start 1..1PreciseDateTimeThe end time of the period must be present, be precise to the second, and have a time zone
.... end 1..1PreciseDateTimePrimitive Type dateTime
... improvementNotation ?!Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
... group I0..*BackboneElementMeasure results for each group
.... 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
.... code Σ1..1CodeableConceptThe code for each group must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
.... population I0..*BackboneElementThe populations in the group
HasValueOrDataAbsentReason: A population.count must have a value, or .extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
..... 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
..... code Σ1..1CodeableConceptThe code for each population must be present to enable matching to the measure, and a value must be present that matches the required binding codes in the Measure
Binding: MeasurePopulationType (extensible)
..... count 0..1integerA count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension.
..... subjectResults 0..1Reference(List)For subject-list reports, the subject results in this population
.... measureScore Σ0..1QuantityWhat score this group achieved
.... stratifier 0..*BackboneElementStratification results
..... 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
..... code 1..*CodeableConceptA stratifier must have a code when present
..... stratum 1..*BackboneElementThere must be at least one stratum reported
...... 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
...... component 0..*BackboneElementStratifier component values
....... 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
....... code 1..1CodeableConceptWhat stratifier component of the group
....... value 1..1CodeableConceptThe stratum component value, e.g. male
...... population 1..*BackboneElementAt least one stratum population must be present
....... 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
....... code 1..1CodeableConceptThe population code must be present
Binding: MeasurePopulationType (extensible)
....... count 1..1integerThe population code count be present
....... subjectResults 0..1Reference(List)For subject-list reports, the subject results in this population
...... measureScore 0..1QuantityWhat score this stratum achieved
... evaluatedResource S0..*Reference(Resource)Include references to MeasureReport or QuestionnaireResponse resources used to compute an aggregated report

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
MeasureReport.languagepreferredCommonLanguages
Max Binding: AllLanguages
MeasureReport.statusrequiredMeasureReportStatus
MeasureReport.typerequiredPattern: summary
MeasureReport.subject.typeextensibleResourceType
MeasureReport.improvementNotationrequiredMeasureImprovementNotation
MeasureReport.group.population.codeextensibleMeasurePopulationType
MeasureReport.group.stratifier.stratum.population.codeextensibleMeasurePopulationType

Constraints

IdPathDetailsRequirements
ReporterPresentInCompleteReportMeasureReportA reporter must be present in a complete report.
: MeasureReport.status != 'completed' or MeasureReport.reporter.exists()
HasValueOrDataAbsentReasonMeasureReport.group.populationA population.count must have a value, or .extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
: count.exists() or extension.url = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'