Skip to main content

Measure

ResourceSpecialized · Quality Reporting & TestingTrial useMaturity 2

The Measure resource provides the definition of a quality measure.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
20 of 22 parameters tested

Structure​

ElementCard.TypeDescription
urlΣ
0..1uriCanonical identifier for this measure, represented as a URI (globally unique)
identifierΣ
0..*IdentifierAdditional identifier for the measure
versionΣ
0..1stringBusiness version of the measure
nameΣ
0..1stringName for this measure (computer friendly)
titleΣ
0..1stringName for this measure (human friendly)
subtitle
0..1stringSubordinate title of the measure
statusRequired?!Σ
1..1codedraft | active | retired | unknownBinding (required): publication-status
experimentalΣ
0..1booleanFor testing purposes, not real usage
subject[x]
0..1CodeableConcept | Reference(Group)E.g. Patient, Practitioner, RelatedPerson, Organization, Location, DeviceBinding (extensible): subject-type
dateΣ
0..1dateTimeDate last changed
publisherΣ
0..1stringName of the publisher (organization or individual)
contactΣ
0..*ContactDetailContact details for the publisher
descriptionΣ
0..1markdownNatural language description of the measure
useContextΣ
0..*UsageContextThe context that the content is intended to support
jurisdictionΣ
0..*CodeableConceptIntended jurisdiction for measure (if applicable)Binding (extensible): jurisdiction
purpose
0..1markdownWhy this measure is defined
usage
0..1stringDescribes the clinical usage of the measure
copyright
0..1markdownUse and/or publishing restrictions
approvalDate
0..1dateWhen the measure was approved by publisher
lastReviewDate
0..1dateWhen the measure was last reviewed
effectivePeriodΣ
0..1PeriodWhen the measure is expected to be used
topic
0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.Binding (example): definition-topic
author
0..*ContactDetailWho authored the content
editor
0..*ContactDetailWho edited the content
reviewer
0..*ContactDetailWho reviewed the content
endorser
0..*ContactDetailWho endorsed the content
relatedArtifact
0..*RelatedArtifactAdditional documentation, citations, etc.
library
0..*canonical(Library)Logic used by the measure
disclaimerΣ
0..1markdownDisclaimer for use of the measure or its referenced content
scoringΣ
0..1CodeableConceptproportion | ratio | continuous-variable | cohortBinding (extensible): measure-scoring
compositeScoringΣ
0..1CodeableConceptopportunity | all-or-nothing | linear | weightedBinding (extensible): composite-measure-scoring
typeΣ
0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | compositeBinding (extensible): measure-type
riskAdjustmentΣ
0..1stringHow risk adjustment is applied for this measure
rateAggregationΣ
0..1stringHow is rate aggregation performed for this measure
rationaleΣ
0..1markdownDetailed description of why the measure exists
clinicalRecommendationStatementΣ
0..1markdownSummary of clinical guidelines
improvementNotationΣ
0..1CodeableConceptincrease | decreaseBinding (required): measure-improvement-notation
definitionΣ
0..*markdownDefined terms used in the measure documentation
guidanceΣ
0..1markdownAdditional guidance for implementers
group
0..*BackboneElementPopulation criteria group
code
0..1CodeableConceptMeaning of the group
description
0..1stringSummary description
population
0..*BackboneElementPopulation criteria
code
0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observationBinding (extensible): measure-population
description
0..1stringThe human readable description of this population criteria
criteriaRequired
1..1ExpressionThe criteria that defines this population
stratifier
0..*BackboneElementStratifier criteria for the measure
code
0..1CodeableConceptMeaning of the stratifier
description
0..1stringThe human readable description of this stratifier
criteria
0..1ExpressionHow the measure should be stratified
component
0..*BackboneElementStratifier criteria component for the measure
code
0..1CodeableConceptMeaning of the stratifier component
description
0..1stringThe human readable description of this stratifier component
criteriaRequired
1..1ExpressionComponent of how the measure should be stratified
supplementalData
0..*BackboneElementWhat other data should be reported with the measure
code
0..1CodeableConceptMeaning of the supplemental data
usage
0..*CodeableConceptsupplemental-data | risk-adjustment-factorBinding (extensible): measure-data-usage
description
0..1stringThe human readable description of this supplemental data
criteriaRequired
1..1ExpressionExpression describing additional data to be reported

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/Measure?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
composed-ofreference

What resource is being referenced

Measure.relatedArtifact.where(type='composed-of').resource
contexttoken

A use context assigned to the measure

(Measure.useContext.value.ofType(CodeableConcept))
context-quantityquantity

A quantity- or range-valued use context assigned to the measure

(Measure.useContext.value.ofType(Quantity)) | (Measure.useContext.value.ofType(Range))
context-typetoken

A type of use context assigned to the measure

Measure.useContext.code
context-type-quantitycomposite

A use context type and quantity- or range-based value assigned to the measure

Measure.useContext
context-type-valuecomposite

A use context type and value assigned to the measure

Measure.useContext
datedate

The measure publication date

Measure.date
depends-onreference

What resource is being referenced

Measure.relatedArtifact.where(type='depends-on').resource | Measure.library
derived-fromreference

What resource is being referenced

Measure.relatedArtifact.where(type='derived-from').resource
descriptionstring

The description of the measure

Measure.description
effectivedate

The time during which the measure is intended to be in use

Measure.effectivePeriod
identifiertoken

External identifier for the measure

Measure.identifier
jurisdictiontoken

Intended jurisdiction for the measure

Measure.jurisdiction
namestring

Computationally friendly name of the measure

Measure.name
predecessorreference

What resource is being referenced

Measure.relatedArtifact.where(type='predecessor').resource
publisherstring

Name of the publisher of the measure

Measure.publisher
statustoken

The current status of the measure

Measure.status
successorreference

What resource is being referenced

Measure.relatedArtifact.where(type='successor').resource
titlestring

The human-friendly name of the measure

Measure.title
topictoken

Topics associated with the measure

Measure.topic
urluri

The uri that identifies the measure

Measure.url
versiontoken

The business version of the measure

Measure.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition