Situational Awareness for Novel Epidemic Response - Local Development build (v0.1.0). See the Directory of published versions
Profile Saner 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.
The official URL for this profile is:
http://hl7.org/fhir/us/saner/StructureDefinition/PublicHealthMeasureReport
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MeasureReport
This structure is derived from MeasureReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | I | 0..* | MeasureReport | Results 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..1 | code | complete | pending | error Binding: MeasureReportStatus (required) | |
type | 1..1 | code | MeasureReports generated conforming to this profile are always summary reports Required Pattern: summary | |
measure | 1..1 | canonical(Measure) | Each MeasureReport resource must document the measure it is reporting for. | |
subject | 0..1 | Reference(US Core Location Profile) | The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region | |
identifier | 1..1 | Identifier | The subject shall have an identifier which uniquely identifies the subject to the recepient. | |
date | 1..1 | PreciseDateTime | The date the report was generated must be specified, and must be precise to the second | |
period | 1..1 | Period | A period must be present | |
start | 1..1 | PreciseDateTime | The end time of the period must be present, be precise to the second, and have a time zone | |
end | 1..1 | PreciseDateTime | Primitive Type dateTime | |
group | ||||
code | 1..1 | CodeableConcept | The 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 Binding: Measure Groups (required) | |
population | I | 0..* | BackboneElement | The 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..1 | CodeableConcept | The 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: Measure Populations (required) | |
count | 0..1 | integer | A 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..* | CodeableConcept | A stratifier must have a code when present | |
stratum | 1..* | BackboneElement | There must be at least one stratum reported | |
value | 0..0 | |||
population | 1..* | BackboneElement | At least one stratum population must be present | |
code | 1..1 | CodeableConcept | The population code must be present | |
count | 1..1 | integer | The population code count be present | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | I | 0..* | MeasureReport | Results of a measure evaluation ReporterPresentInCompleteReport: A reporter must be present in a complete report. |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Additional identifier for the MeasureReport |
status | ?!ΣI | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required) |
type | ΣI | 1..1 | code | MeasureReports generated conforming to this profile are always summary reports Binding: MeasureReportType (required) Required Pattern: summary |
measure | ΣI | 1..1 | canonical(Measure) | Each MeasureReport resource must document the measure it is reporting for. |
subject | ΣI | 0..1 | Reference(US Core Location Profile) | The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
identifier | ΣI | 1..1 | Identifier | The subject shall have an identifier which uniquely identifies the subject to the recepient. |
display | ΣI | 0..1 | string | Text alternative for the resource |
date | I | 1..1 | PreciseDateTime | The date the report was generated must be specified, and must be precise to the second |
reporter | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Who is reporting the data |
period | ΣI | 1..1 | Period | A period must be present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
start | I | 1..1 | PreciseDateTime | The end time of the period must be present, be precise to the second, and have a time zone |
end | I | 1..1 | PreciseDateTime | Primitive Type dateTime |
improvementNotation | ?!ΣI | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) |
group | I | 0..* | BackboneElement | Measure results for each group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | The 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 Binding: Measure Groups (required) |
population | I | 0..* | BackboneElement | The 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..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | The 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: Measure Populations (required) |
count | I | 0..1 | integer | A count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension. |
subjectResults | I | 0..1 | Reference(List) | For subject-list reports, the subject results in this population |
measureScore | ΣI | 0..1 | Quantity | What score this group achieved |
stratifier | I | 0..* | BackboneElement | Stratification results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..* | CodeableConcept | A stratifier must have a code when present |
stratum | I | 1..* | BackboneElement | There must be at least one stratum reported |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
component | I | 0..* | BackboneElement | Stratifier component values |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | CodeableConcept | What stratifier component of the group |
value | I | 1..1 | CodeableConcept | The stratum component value, e.g. male |
population | I | 1..* | BackboneElement | At least one stratum population must be present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | CodeableConcept | The population code must be present Binding: MeasurePopulationType (extensible) |
count | I | 1..1 | integer | The population code count be present |
subjectResults | I | 0..1 | Reference(List) | For subject-list reports, the subject results in this population |
measureScore | I | 0..1 | Quantity | What score this stratum achieved |
evaluatedResource | I | 0..* | Reference(Resource) | What data was used to calculate the measure score |
Documentation for this format |
This structure is derived from MeasureReport
Differential View
This structure is derived from MeasureReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | I | 0..* | MeasureReport | Results 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..1 | code | complete | pending | error Binding: MeasureReportStatus (required) | |
type | 1..1 | code | MeasureReports generated conforming to this profile are always summary reports Required Pattern: summary | |
measure | 1..1 | canonical(Measure) | Each MeasureReport resource must document the measure it is reporting for. | |
subject | 0..1 | Reference(US Core Location Profile) | The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region | |
identifier | 1..1 | Identifier | The subject shall have an identifier which uniquely identifies the subject to the recepient. | |
date | 1..1 | PreciseDateTime | The date the report was generated must be specified, and must be precise to the second | |
period | 1..1 | Period | A period must be present | |
start | 1..1 | PreciseDateTime | The end time of the period must be present, be precise to the second, and have a time zone | |
end | 1..1 | PreciseDateTime | Primitive Type dateTime | |
group | ||||
code | 1..1 | CodeableConcept | The 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 Binding: Measure Groups (required) | |
population | I | 0..* | BackboneElement | The 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..1 | CodeableConcept | The 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: Measure Populations (required) | |
count | 0..1 | integer | A 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..* | CodeableConcept | A stratifier must have a code when present | |
stratum | 1..* | BackboneElement | There must be at least one stratum reported | |
value | 0..0 | |||
population | 1..* | BackboneElement | At least one stratum population must be present | |
code | 1..1 | CodeableConcept | The population code must be present | |
count | 1..1 | integer | The population code count be present | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MeasureReport | I | 0..* | MeasureReport | Results of a measure evaluation ReporterPresentInCompleteReport: A reporter must be present in a complete report. |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 0..* | Identifier | Additional identifier for the MeasureReport |
status | ?!ΣI | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required) |
type | ΣI | 1..1 | code | MeasureReports generated conforming to this profile are always summary reports Binding: MeasureReportType (required) Required Pattern: summary |
measure | ΣI | 1..1 | canonical(Measure) | Each MeasureReport resource must document the measure it is reporting for. |
subject | ΣI | 0..1 | Reference(US Core Location Profile) | The subject of a report is a location, e.g., a facility, region, service area, state or other geographic region |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
identifier | ΣI | 1..1 | Identifier | The subject shall have an identifier which uniquely identifies the subject to the recepient. |
display | ΣI | 0..1 | string | Text alternative for the resource |
date | I | 1..1 | PreciseDateTime | The date the report was generated must be specified, and must be precise to the second |
reporter | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Who is reporting the data |
period | ΣI | 1..1 | Period | A period must be present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
start | I | 1..1 | PreciseDateTime | The end time of the period must be present, be precise to the second, and have a time zone |
end | I | 1..1 | PreciseDateTime | Primitive Type dateTime |
improvementNotation | ?!ΣI | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) |
group | I | 0..* | BackboneElement | Measure results for each group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | The 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 Binding: Measure Groups (required) |
population | I | 0..* | BackboneElement | The 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..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | ΣI | 1..1 | CodeableConcept | The 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: Measure Populations (required) |
count | I | 0..1 | integer | A count must be present for each population. Unknown values may be reported using the http://hl7.org/fhir/StructureDefinition/data-absent-reason extension. |
subjectResults | I | 0..1 | Reference(List) | For subject-list reports, the subject results in this population |
measureScore | ΣI | 0..1 | Quantity | What score this group achieved |
stratifier | I | 0..* | BackboneElement | Stratification results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..* | CodeableConcept | A stratifier must have a code when present |
stratum | I | 1..* | BackboneElement | There must be at least one stratum reported |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
component | I | 0..* | BackboneElement | Stratifier component values |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | CodeableConcept | What stratifier component of the group |
value | I | 1..1 | CodeableConcept | The stratum component value, e.g. male |
population | I | 1..* | BackboneElement | At least one stratum population must be present |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 1..1 | CodeableConcept | The population code must be present Binding: MeasurePopulationType (extensible) |
count | I | 1..1 | integer | The population code count be present |
subjectResults | I | 0..1 | Reference(List) | For subject-list reports, the subject results in this population |
measureScore | I | 0..1 | Quantity | What score this stratum achieved |
evaluatedResource | I | 0..* | Reference(Resource) | What data was used to calculate the measure score |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
MeasureReport.language | preferred | CommonLanguages Max Binding: AllLanguages |
MeasureReport.status | required | MeasureReportStatus |
MeasureReport.type | required | Pattern: summary |
MeasureReport.subject.type | extensible | ResourceType |
MeasureReport.improvementNotation | required | MeasureImprovementNotation |
MeasureReport.group.code | required | Groups |
MeasureReport.group.population.code | required | Populations |
MeasureReport.group.stratifier.stratum.population.code | extensible | MeasurePopulationType |
Id | Path | Details | Requirements |
ReporterPresentInCompleteReport | MeasureReport | A reporter must be present in a complete report. : MeasureReport.status != 'completed' or MeasureReport.reporter.exists() | |
HasValueOrDataAbsentReason | MeasureReport.group.population | A 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' |