Situational Awareness for Novel Epidemic Response - Local Development build (v0.1.0). See the Directory of published versions
Profile Saner Public Health Measure
The Public Health Measure Profile ensures that Measures are very well defined as an aid to automation of measures. These are developed by The Saner Project team to ensure that the measure is well understood and computation of it can be automated from systems that have the measure data.
The official URL for this profile is:
http://hl7.org/fhir/us/saner/StructureDefinition/PublicHealthMeasure
## This Implementation Guide defines a profile for Measure.
Stratifiers partition a measure so that it counts subsets of the measure population within the numerator or other measure population by some attribute that classifies the population. Common stratifications often used in healthcare settings include age, sex at birth1 and race and ethnicity. Constraints on the Measure.group.stratifier component of a Measure and further describes the elements of that component to support strata.
Each stratifier has the following features:
Also commonly referred to as gender, but is then confused with self-reported gender identity, so this guide uses the term sex at birth. ↩
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Measure
This structure is derived from Measure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 0..* | Measure | A quality measure definition | |
url | 1..1 | uri | Each measure must have a url. | |
version | 1..1 | string | Measure resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ... | |
name | 1..1 | string | Each measure must have a name. | |
status | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) | |
experimental | 1..1 | boolean | A measure must indicate its experimental status | |
publisher | 1..1 | string | The name of the organization publishing this Measure resource | |
contact | 1..* | ContactDetail | The contact information for whom to contact about this Measure resource | |
useContext | 1..* | UsageContext | The ISO 3166 code for use context | |
author | 1..1 | ContactDetail | The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication | |
name | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. | |
telecom | 1..* | ContactPoint | There must be contact information for the author. | |
relatedArtifact | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. This does not include software generated pages from the IG-Builder. | |
group | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
MeasureGroupAttributes | 0..1 | (Complex) | Describes the attributes of one or more sections of the measure (form) being reported URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes | |
extension:scoring | 0..1 | Extension | Extension | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Measure must have a scoring Binding: MeasureScoring (required) | |
extension:type | 0..1 | Extension | Extension | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
extension:rateAggregation | 0..1 | Extension | Extension | |
valueString | 0..1 | string | aggregable-by-period | point-in-time | cumulative Binding: Rate Aggregation Value Set (required) | |
extension:improvementNotation | 0..1 | Extension | Extension | |
valueCodeableConcept | S | 0..1 | CodeableConcept | Value of extension Binding: MeasureImprovementNotation (required) |
extension:subject | 1..1 | Extension | Extension | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
population | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
MeasurePopulationAlternateCriteria | 0..1 | Expression | Other expressions for computing the criterion URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasurePopulationAlternateCriteria | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Populations (required) | |
coding | 1..* | Coding | The coding gives a 'name' for this population and must be supplied | |
text | 0..1 | string | A human readable description of what this population is | |
description | 1..1 | string | Human readable instructions for counting or measuring this population | |
criteria | 1..1 | MeasureCriteria | name should align with code. | |
description | 1..1 | string | Describe what the criterion does to a human (non-engineer) | |
name | 1..1 | id | name should align with code. | |
language | 1..1 | code | Give the expression for execution | |
expression | 1..1 | string | A measure must describe how to automate the computation in an expression that can be evaluated in the specified language | |
stratifier | 0..* | BackboneElement | A group may have none, some or many strata | |
code | 1..1 | CodeableConcept | Describes the purpose of this stratifier | |
coding | 1..* | Coding | Uniquely identifies the strata | |
display | 1..1 | string | Provides a human readable name for the strata | |
text | 0..1 | string | Describes the function of the stratifier. | |
description | 1..1 | string | Describes the overall function of the strata. | |
component | 1..* | BackboneElement | A stratifier must have at least one stratum | |
description | 1..1 | string | Describes the purpose of this stratum | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | I | 0..* | Measure | A quality measure definition |
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 |
url | ΣI | 1..1 | uri | Each measure must have a url. |
identifier | ΣI | 0..* | Identifier | Additional identifier for the measure |
version | ΣI | 1..1 | string | Measure resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ... |
name | ΣI | 1..1 | string | Each measure must have a name. |
title | ΣI | 0..1 | string | Name for this measure (human friendly) |
subtitle | I | 0..1 | string | Subordinate title of the measure |
status | ?!ΣI | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) |
experimental | ΣI | 1..1 | boolean | A measure must indicate its experimental status |
subject[x] | I | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | The name of the organization publishing this Measure resource |
contact | ΣI | 1..* | ContactDetail | The contact information for whom to contact about this Measure resource |
description | ΣI | 0..1 | markdown | Natural language description of the measure |
useContext | ΣI | 1..* | UsageContext | The ISO 3166 code for use context |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | I | 0..1 | markdown | Why this measure is defined |
usage | I | 0..1 | string | Describes the clinical usage of the measure |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the measure was approved by publisher |
lastReviewDate | I | 0..1 | date | When the measure was last reviewed |
effectivePeriod | ΣI | 0..1 | Period | When the measure is expected to be used |
topic | I | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
author | I | 1..1 | ContactDetail | The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication |
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 |
name | ΣI | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. |
telecom | ΣI | 1..* | ContactPoint | There must be contact information for the author. |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. This does not include software generated pages from the IG-Builder. |
library | I | 0..* | canonical(Library) | Logic used by the measure |
disclaimer | ΣI | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | ΣI | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
compositeScoring | ΣI | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible) |
type | ΣI | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
riskAdjustment | ΣI | 0..1 | string | How risk adjustment is applied for this measure |
rateAggregation | ΣI | 0..1 | string | How is rate aggregation performed for this measure |
rationale | ΣI | 0..1 | markdown | Detailed description of why the measure exists |
clinicalRecommendationStatement | ΣI | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | ΣI | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) |
definition | ΣI | 0..* | markdown | Defined terms used in the measure documentation |
guidance | ΣI | 0..1 | markdown | Additional guidance for implementers |
group | I | 0..* | BackboneElement | Population criteria group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
MeasureGroupAttributes | I | 0..1 | (Complex) | Describes the attributes of one or more sections of the measure (form) being reported URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
extension:scoring | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "scoring" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 1..1 | CodeableConcept | Measure must have a scoring Binding: MeasureScoring (required) |
extension:compositeScoring | I | 0..1 | Extension | Like Measure.compositeScoring, but applies to group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "compositeScoring" | |
value[x] | I | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension Binding: CompositeMeasureScoring (extensible) |
extension:type | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "type" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 1..1 | CodeableConcept | Value of extension Binding: MeasureType (required) |
extension:riskAdjustment | I | 0..1 | Extension | Like Measure.riskAdjustment, but applies to group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "riskAdjustment" | |
value[x] | I | 0..1 | string | Value of extension |
extension:rateAggregation | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "rateAggregation" | |
value[x] | I | 0..1 | string | aggregable-by-period | point-in-time | cumulative Binding: Rate Aggregation Value Set (required) |
extension:improvementNotation | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "improvementNotation" | |
value[x] | I | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SI | 0..1 | CodeableConcept | Value of extension Binding: MeasureImprovementNotation (required) |
extension:subject | I | 1..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "subject" | |
value[x] | I | 0..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension Binding: ResourceType (extensible) |
url | 1..1 | uri | "http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes" | |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 0..1 | CodeableConcept | Meaning of the group |
description | I | 0..1 | string | Summary description |
population | I | 0..* | BackboneElement | Population criteria |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
MeasurePopulationAlternateCriteria | I | 0..1 | Expression | Other expressions for computing the criterion URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasurePopulationAlternateCriteria |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Populations (required) |
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 |
coding | ΣI | 1..* | Coding | The coding gives a 'name' for this population and must be supplied |
text | ΣI | 0..1 | string | A human readable description of what this population is |
description | I | 1..1 | string | Human readable instructions for counting or measuring this population |
criteria | I | 1..1 | MeasureCriteria | name should align with code. |
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 |
description | ΣI | 1..1 | string | Describe what the criterion does to a human (non-engineer) |
name | ΣI | 1..1 | id | name should align with code. |
language | ΣI | 1..1 | code | Give the expression for execution Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt |
expression | ΣI | 1..1 | string | A measure must describe how to automate the computation in an expression that can be evaluated in the specified language |
reference | ΣI | 0..1 | uri | Where the expression is found |
stratifier | I | 0..* | BackboneElement | A group may have none, some or many strata |
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 | Describes the purpose of this stratifier |
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 |
coding | ΣI | 1..* | Coding | Uniquely identifies the strata |
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 |
system | ΣI | 0..1 | uri | Identity of the terminology system |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
display | ΣI | 1..1 | string | Provides a human readable name for the strata |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Describes the function of the stratifier. |
description | I | 1..1 | string | Describes the overall function of the strata. |
criteria | I | 0..1 | Expression | How the measure should be stratified |
component | I | 1..* | BackboneElement | A stratifier must have at least one stratum |
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 | 0..1 | CodeableConcept | Meaning of the stratifier component |
description | I | 1..1 | string | Describes the purpose of this stratum |
criteria | I | 1..1 | Expression | Component of how the measure should be stratified |
supplementalData | I | 0..* | BackboneElement | What other data should be reported with the measure |
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 | 0..1 | CodeableConcept | Meaning of the supplemental data |
usage | I | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible) |
description | I | 0..1 | string | The human readable description of this supplemental data |
criteria | I | 1..1 | Expression | Expression describing additional data to be reported |
Documentation for this format |
This structure is derived from Measure
Differential View
This structure is derived from Measure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | 0..* | Measure | A quality measure definition | |
url | 1..1 | uri | Each measure must have a url. | |
version | 1..1 | string | Measure resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ... | |
name | 1..1 | string | Each measure must have a name. | |
status | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) | |
experimental | 1..1 | boolean | A measure must indicate its experimental status | |
publisher | 1..1 | string | The name of the organization publishing this Measure resource | |
contact | 1..* | ContactDetail | The contact information for whom to contact about this Measure resource | |
useContext | 1..* | UsageContext | The ISO 3166 code for use context | |
author | 1..1 | ContactDetail | The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication | |
name | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. | |
telecom | 1..* | ContactPoint | There must be contact information for the author. | |
relatedArtifact | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. This does not include software generated pages from the IG-Builder. | |
group | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
MeasureGroupAttributes | 0..1 | (Complex) | Describes the attributes of one or more sections of the measure (form) being reported URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes | |
extension:scoring | 0..1 | Extension | Extension | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Measure must have a scoring Binding: MeasureScoring (required) | |
extension:type | 0..1 | Extension | Extension | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
extension:rateAggregation | 0..1 | Extension | Extension | |
valueString | 0..1 | string | aggregable-by-period | point-in-time | cumulative Binding: Rate Aggregation Value Set (required) | |
extension:improvementNotation | 0..1 | Extension | Extension | |
valueCodeableConcept | S | 0..1 | CodeableConcept | Value of extension Binding: MeasureImprovementNotation (required) |
extension:subject | 1..1 | Extension | Extension | |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
population | ||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
MeasurePopulationAlternateCriteria | 0..1 | Expression | Other expressions for computing the criterion URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasurePopulationAlternateCriteria | |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Populations (required) | |
coding | 1..* | Coding | The coding gives a 'name' for this population and must be supplied | |
text | 0..1 | string | A human readable description of what this population is | |
description | 1..1 | string | Human readable instructions for counting or measuring this population | |
criteria | 1..1 | MeasureCriteria | name should align with code. | |
description | 1..1 | string | Describe what the criterion does to a human (non-engineer) | |
name | 1..1 | id | name should align with code. | |
language | 1..1 | code | Give the expression for execution | |
expression | 1..1 | string | A measure must describe how to automate the computation in an expression that can be evaluated in the specified language | |
stratifier | 0..* | BackboneElement | A group may have none, some or many strata | |
code | 1..1 | CodeableConcept | Describes the purpose of this stratifier | |
coding | 1..* | Coding | Uniquely identifies the strata | |
display | 1..1 | string | Provides a human readable name for the strata | |
text | 0..1 | string | Describes the function of the stratifier. | |
description | 1..1 | string | Describes the overall function of the strata. | |
component | 1..* | BackboneElement | A stratifier must have at least one stratum | |
description | 1..1 | string | Describes the purpose of this stratum | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Measure | I | 0..* | Measure | A quality measure definition |
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 |
url | ΣI | 1..1 | uri | Each measure must have a url. |
identifier | ΣI | 0..* | Identifier | Additional identifier for the measure |
version | ΣI | 1..1 | string | Measure resources are versioned like IG's 0.1.0 = first development version, 0.2.0 - first published for review version, 1.0.0 first official version ... |
name | ΣI | 1..1 | string | Each measure must have a name. |
title | ΣI | 0..1 | string | Name for this measure (human friendly) |
subtitle | I | 0..1 | string | Subordinate title of the measure |
status | ?!ΣI | 1..1 | code | draft | active | retired Binding: Measure Status Values (required) |
experimental | ΣI | 1..1 | boolean | A measure must indicate its experimental status |
subject[x] | I | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | ΣI | 0..1 | dateTime | Date last changed |
publisher | ΣI | 1..1 | string | The name of the organization publishing this Measure resource |
contact | ΣI | 1..* | ContactDetail | The contact information for whom to contact about this Measure resource |
description | ΣI | 0..1 | markdown | Natural language description of the measure |
useContext | ΣI | 1..* | UsageContext | The ISO 3166 code for use context |
jurisdiction | ΣI | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible) |
purpose | I | 0..1 | markdown | Why this measure is defined |
usage | I | 0..1 | string | Describes the clinical usage of the measure |
copyright | I | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | I | 0..1 | date | When the measure was approved by publisher |
lastReviewDate | I | 0..1 | date | When the measure was last reviewed |
effectivePeriod | ΣI | 0..1 | Period | When the measure is expected to be used |
topic | I | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example) |
author | I | 1..1 | ContactDetail | The original author of the measure content, may be same as publisher, when otherwise, must include a relatedArtifact for the original author's publication |
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 |
name | ΣI | 1..1 | string | The author must be identified by name. Can be the name of an individual or an organization. |
telecom | ΣI | 1..* | ContactPoint | There must be contact information for the author. |
editor | I | 0..* | ContactDetail | Who edited the content |
reviewer | I | 0..* | ContactDetail | Who reviewed the content |
endorser | I | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | I | 1..* | RelatedArtifact | There must be at least one artifact describing the measure in human readable form. This does not include software generated pages from the IG-Builder. |
library | I | 0..* | canonical(Library) | Logic used by the measure |
disclaimer | ΣI | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoring | ΣI | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) |
compositeScoring | ΣI | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible) |
type | ΣI | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) |
riskAdjustment | ΣI | 0..1 | string | How risk adjustment is applied for this measure |
rateAggregation | ΣI | 0..1 | string | How is rate aggregation performed for this measure |
rationale | ΣI | 0..1 | markdown | Detailed description of why the measure exists |
clinicalRecommendationStatement | ΣI | 0..1 | markdown | Summary of clinical guidelines |
improvementNotation | ΣI | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) |
definition | ΣI | 0..* | markdown | Defined terms used in the measure documentation |
guidance | ΣI | 0..1 | markdown | Additional guidance for implementers |
group | I | 0..* | BackboneElement | Population criteria group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
MeasureGroupAttributes | I | 0..1 | (Complex) | Describes the attributes of one or more sections of the measure (form) being reported URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
extension:scoring | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "scoring" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 1..1 | CodeableConcept | Measure must have a scoring Binding: MeasureScoring (required) |
extension:compositeScoring | I | 0..1 | Extension | Like Measure.compositeScoring, but applies to group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "compositeScoring" | |
value[x] | I | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension Binding: CompositeMeasureScoring (extensible) |
extension:type | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "type" | |
value[x] | I | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 1..1 | CodeableConcept | Value of extension Binding: MeasureType (required) |
extension:riskAdjustment | I | 0..1 | Extension | Like Measure.riskAdjustment, but applies to group |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "riskAdjustment" | |
value[x] | I | 0..1 | string | Value of extension |
extension:rateAggregation | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "rateAggregation" | |
value[x] | I | 0..1 | string | aggregable-by-period | point-in-time | cumulative Binding: Rate Aggregation Value Set (required) |
extension:improvementNotation | I | 0..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "improvementNotation" | |
value[x] | I | 0..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SI | 0..1 | CodeableConcept | Value of extension Binding: MeasureImprovementNotation (required) |
extension:subject | I | 1..1 | Extension | Extension |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "subject" | |
value[x] | I | 0..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | I | 0..1 | CodeableConcept | Value of extension Binding: ResourceType (extensible) |
url | 1..1 | uri | "http://hl7.org/fhir/us/saner/StructureDefinition/MeasureGroupAttributes" | |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 0..1 | CodeableConcept | Meaning of the group |
description | I | 0..1 | string | Summary description |
population | I | 0..* | BackboneElement | Population criteria |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
MeasurePopulationAlternateCriteria | I | 0..1 | Expression | Other expressions for computing the criterion URL: http://hl7.org/fhir/us/saner/StructureDefinition/MeasurePopulationAlternateCriteria |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | I | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: Measure Populations (required) |
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 |
coding | ΣI | 1..* | Coding | The coding gives a 'name' for this population and must be supplied |
text | ΣI | 0..1 | string | A human readable description of what this population is |
description | I | 1..1 | string | Human readable instructions for counting or measuring this population |
criteria | I | 1..1 | MeasureCriteria | name should align with code. |
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 |
description | ΣI | 1..1 | string | Describe what the criterion does to a human (non-engineer) |
name | ΣI | 1..1 | id | name should align with code. |
language | ΣI | 1..1 | code | Give the expression for execution Binding: ExpressionLanguage (extensible) Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt |
expression | ΣI | 1..1 | string | A measure must describe how to automate the computation in an expression that can be evaluated in the specified language |
reference | ΣI | 0..1 | uri | Where the expression is found |
stratifier | I | 0..* | BackboneElement | A group may have none, some or many strata |
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 | Describes the purpose of this stratifier |
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 |
coding | ΣI | 1..* | Coding | Uniquely identifies the strata |
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 |
system | ΣI | 0..1 | uri | Identity of the terminology system |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
display | ΣI | 1..1 | string | Provides a human readable name for the strata |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Describes the function of the stratifier. |
description | I | 1..1 | string | Describes the overall function of the strata. |
criteria | I | 0..1 | Expression | How the measure should be stratified |
component | I | 1..* | BackboneElement | A stratifier must have at least one stratum |
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 | 0..1 | CodeableConcept | Meaning of the stratifier component |
description | I | 1..1 | string | Describes the purpose of this stratum |
criteria | I | 1..1 | Expression | Component of how the measure should be stratified |
supplementalData | I | 0..* | BackboneElement | What other data should be reported with the measure |
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 | 0..1 | CodeableConcept | Meaning of the supplemental data |
usage | I | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible) |
description | I | 0..1 | string | The human readable description of this supplemental data |
criteria | I | 1..1 | Expression | Expression describing additional data to be reported |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Measure.language | preferred | CommonLanguages Max Binding: AllLanguages |
Measure.status | required | MeasureStatus |
Measure.subject[x] | extensible | SubjectType |
Measure.jurisdiction | extensible | Jurisdiction ValueSet |
Measure.topic | example | DefinitionTopic |
Measure.scoring | extensible | MeasureScoring |
Measure.compositeScoring | extensible | CompositeMeasureScoring |
Measure.type | extensible | MeasureType |
Measure.improvementNotation | required | MeasureImprovementNotation |
Measure.group.extension:groupAtts.extension:scoring.value[x]:valueCodeableConcept | required | MeasureScoring |
Measure.group.extension:groupAtts.extension:compositeScoring.value[x]:valueCodeableConcept | extensible | CompositeMeasureScoring |
Measure.group.extension:groupAtts.extension:type.value[x]:valueCodeableConcept | required | MeasureType |
Measure.group.extension:groupAtts.extension:rateAggregation.value[x] | required | MeasureRateAggregationValues |
Measure.group.extension:groupAtts.extension:improvementNotation.value[x]:valueCodeableConcept | required | MeasureImprovementNotation |
Measure.group.extension:groupAtts.extension:subject.value[x]:valueCodeableConcept | extensible | ResourceType |
Measure.group.population.code | required | Populations |
Measure.group.population.criteria.language | extensible | ExpressionLanguage Max Binding: http://www.rfc-editor.org/bcp/bcp13.txt |
Measure.supplementalData.usage | extensible | MeasureDataUsage |
Id | Path | Details | Requirements |