Measure - FHIR Resource (stu3)
This Measure Resource uses the FHIR API standard for access and structure.
Validate an Measure FHIR Resource (stu3)
Measure Attributes
AttributeField is listTypeDescription
Description: The measure set, e.g. Preventive Care and Screening
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"set": Learn more about the (Measure) set FHIR attribute
Description: Intended jurisdiction for measure (if applicable)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (Measure) jurisdiction FHIR attribute
Description: Logic used by the measure
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"library": Learn more about the (Measure) library FHIR attribute
Description: E.g. Education, Treatment, Assessment, etc
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": Learn more about the (Measure) topic FHIR attribute
Description: A content contributor
FHIR Version: stu3
Attribute Type : Contributor
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contributor": Learn more about the (Measure) contributor FHIR attribute
Description: Summary of clinical guidelines
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"clinicalRecommendationStatement": Learn more about the (Measure) clinicalRecommendationStatement FHIR attribute
Description: proportion | ratio | continuous-variable | cohort
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"scoring": Learn more about the (Measure) scoring FHIR attribute
Description: Population criteria group
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"group": Learn more about the (Measure) group FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (Measure) copyright FHIR attribute
Description: Name for this measure (human friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (Measure) title FHIR attribute
Description: Additional guidance for implementers
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"guidance": Learn more about the (Measure) guidance FHIR attribute
Description: When the measure was last reviewed
FHIR Version: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastReviewDate": Learn more about the (Measure) lastReviewDate FHIR attribute
Description: How is rate aggregation performed for this measure
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"rateAggregation": Learn more about the (Measure) rateAggregation FHIR attribute
Description: Business version of the measure
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (Measure) version FHIR attribute
Description: Describes the clinical usage of the measure
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"usage": Learn more about the (Measure) usage FHIR attribute
Description: process | outcome | structure | patient-reported-outcome | composite
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Measure) type FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Measure) status FHIR attribute
Description: When the measure was approved by publisher
FHIR Version: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"approvalDate": Learn more about the (Measure) approvalDate FHIR attribute
Description: What other data should be reported with the measure
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supplementalData": Learn more about the (Measure) supplementalData FHIR attribute
Description: Natural language description of the measure
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (Measure) description FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (Measure) publisher FHIR attribute
Description: When the measure is expected to be used
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": Learn more about the (Measure) effectivePeriod FHIR attribute
Description: Additional documentation, citations, etc
FHIR Version: stu3
Attribute Type : RelatedArtifact
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedArtifact": Learn more about the (Measure) relatedArtifact FHIR attribute
Description: Context the content is intended to support
FHIR Version: stu3
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (Measure) useContext FHIR attribute
Description: Why this measure is defined
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": Learn more about the (Measure) purpose FHIR attribute
Description: Why does this measure exist
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"rationale": Learn more about the (Measure) rationale FHIR attribute
Description: Date this was last changed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (Measure) date FHIR attribute
Description: How is risk adjustment applied for this measure
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"riskAdjustment": Learn more about the (Measure) riskAdjustment FHIR attribute
Description: Defined terms used in the measure documentation
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": Learn more about the (Measure) definition FHIR attribute
Description: Name for this measure (computer friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (Measure) name FHIR attribute
Description: Logical URI to reference this measure (globally unique)
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (Measure) url FHIR attribute
Description: Improvement notation for the measure, e.g. higher score indicates better quality
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"improvementNotation": Learn more about the (Measure) improvementNotation FHIR attribute
Description: Contact details for the publisher
FHIR Version: stu3
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (Measure) contact FHIR attribute
Description: opportunity | all-or-nothing | linear | weighted
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"compositeScoring": Learn more about the (Measure) compositeScoring FHIR attribute
Description: Additional identifier for the measure
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Measure) identifier FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (Measure) experimental FHIR attribute
Description: Disclaimer for use of the measure or its referenced content
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"disclaimer": Learn more about the (Measure) disclaimer FHIR attribute
Measure Structure
{
"resourceType" : "Measure",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URI to reference this measure (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the measure
"version" : "<string>", // Business version of the measure
"name" : "<string>", // Name for this measure (computer friendly)
"title" : "<string>", // Name for this measure (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"description" : "<markdown>", // Natural language description of the measure
"purpose" : "<markdown>", // Why this measure is defined
"usage" : "<string>", // Describes the clinical usage of the measure
"approvalDate" : "<date>", // When the measure was approved by publisher
"lastReviewDate" : "<date>", // When the measure was last reviewed
"effectivePeriod" : { Period }, // When the measure is expected to be used
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for measure (if applicable)
"topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
"contributor" : [{ Contributor }], // A content contributor
"contact" : [{ ContactDetail }], // Contact details for the publisher
"copyright" : "<markdown>", // Use and/or publishing restrictions
"relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
"library" : [{ Reference(Library) }], // Logic used by the measure
"disclaimer" : "<markdown>", // Disclaimer for use of the measure or its referenced content
"scoring" : { CodeableConcept }, // proportion | ratio | continuous-variable | cohort
"compositeScoring" : { CodeableConcept }, // opportunity | all-or-nothing | linear | weighted
"type" : [{ CodeableConcept }], // process | outcome | structure | patient-reported-outcome | composite
"riskAdjustment" : "<string>", // How is risk adjustment applied for this measure
"rateAggregation" : "<string>", // How is rate aggregation performed for this measure
"rationale" : "<markdown>", // Why does this measure exist
"clinicalRecommendationStatement" : "<markdown>", // Summary of clinical guidelines
"improvementNotation" : "<string>", // Improvement notation for the measure, e.g. higher score indicates better quality
"definition" : ["<markdown>"], // Defined terms used in the measure documentation
"guidance" : "<markdown>", // Additional guidance for implementers
"set" : "<string>", // The measure set, e.g. Preventive Care and Screening
"group" : [{ // Population criteria group
"identifier" : { Identifier }, // R! Unique identifier
"name" : "<string>", // Short name
"description" : "<string>", // Summary description
"population" : [{ // Population criteria
"identifier" : { Identifier }, // Unique identifier
"code" : { CodeableConcept }, // initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
"name" : "<string>", // Short name
"description" : "<string>", // The human readable description of this population criteria
"criteria" : "<string>" // R! The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria
}],
"stratifier" : [{ // Stratifier criteria for the measure
"identifier" : { Identifier }, // The identifier for the stratifier used to coordinate the reported data back to this stratifier
"criteria" : "<string>", // How the measure should be stratified
"path" : "<string>" // Path to the stratifier
}]
}],
"supplementalData" : [{ // What other data should be reported with the measure
"identifier" : { Identifier }, // Identifier, unique within the measure
"usage" : [{ CodeableConcept }], // supplemental-data | risk-adjustment-factor
"criteria" : "<string>", // Expression describing additional data to be reported
"path" : "<string>" // Path to the supplemental data element
}]
}
Measure Search Parameters
The following search parameters can be used to query Measure resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Measure?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
composed-of | reference | relatedArtifact.where |
date | date | date |
depends-on | reference | relatedArtifact.where |
derived-from | reference | relatedArtifact.where |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
predecessor | reference | relatedArtifact.where |
publisher | text | publisher |
status | text | status |
successor | reference | relatedArtifact.where |
title | text | title |
topic | text | topic |
url | uri | url |
version | text | version |
