Measure
The Measure resource provides the definition of a quality measure.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 20 of 22 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlΣ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the measure |
versionΣ | 0..1 | string | Business version of the measure |
nameΣ | 0..1 | string | Name for this measure (computer friendly) |
titleΣ | 0..1 | string | Name for this measure (human friendly) |
subtitle | 0..1 | string | Subordinate title of the measure |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | CodeableConcept | Reference(Group) | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, DeviceBinding (extensible): subject-type |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
descriptionΣ | 0..1 | markdown | Natural language description of the measure |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this measure is defined |
usage | 0..1 | string | Describes the clinical usage of the measure |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When the measure was approved by publisher |
lastReviewDate | 0..1 | date | When the measure was last reviewed |
effectivePeriodΣ | 0..1 | Period | When the measure is expected to be used |
topic | 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc.Binding (example): definition-topic |
author | 0..* | ContactDetail | Who authored the content |
editor | 0..* | ContactDetail | Who edited the content |
reviewer | 0..* | ContactDetail | Who reviewed the content |
endorser | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
library | 0..* | canonical(Library) | Logic used by the measure |
disclaimerΣ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
scoringΣ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohortBinding (extensible): measure-scoring |
compositeScoringΣ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weightedBinding (extensible): composite-measure-scoring |
typeΣ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | compositeBinding (extensible): measure-type |
riskAdjustmentΣ | 0..1 | string | How risk adjustment is applied for this measure |
rateAggregationΣ | 0..1 | string | How is rate aggregation performed for this measure |
rationaleΣ | 0..1 | markdown | Detailed description of why the measure exists |
clinicalRecommendationStatementΣ | 0..1 | markdown | Summary of clinical guidelines |
improvementNotationΣ | 0..1 | CodeableConcept | increase | decreaseBinding (required): measure-improvement-notation |
definitionΣ | 0..* | markdown | Defined terms used in the measure documentation |
guidanceΣ | 0..1 | markdown | Additional guidance for implementers |
group | 0..* | BackboneElement | Population criteria group |
code | 0..1 | CodeableConcept | Meaning of the group |
description | 0..1 | string | Summary description |
population | 0..* | BackboneElement | Population criteria |
code | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observationBinding (extensible): measure-population |
description | 0..1 | string | The human readable description of this population criteria |
criteriaRequired | 1..1 | Expression | The criteria that defines this population |
stratifier | 0..* | BackboneElement | Stratifier criteria for the measure |
code | 0..1 | CodeableConcept | Meaning of the stratifier |
description | 0..1 | string | The human readable description of this stratifier |
criteria | 0..1 | Expression | How the measure should be stratified |
component | 0..* | BackboneElement | Stratifier criteria component for the measure |
code | 0..1 | CodeableConcept | Meaning of the stratifier component |
description | 0..1 | string | The human readable description of this stratifier component |
criteriaRequired | 1..1 | Expression | Component of how the measure should be stratified |
supplementalData | 0..* | BackboneElement | What other data should be reported with the measure |
code | 0..1 | CodeableConcept | Meaning of the supplemental data |
usage | 0..* | CodeableConcept | supplemental-data | risk-adjustment-factorBinding (extensible): measure-data-usage |
description | 0..1 | string | The human readable description of this supplemental data |
criteriaRequired | 1..1 | Expression | Expression 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.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
composed-of | reference | What resource is being referenced Measure.relatedArtifact.where(type='composed-of').resource | ||
context | token | A use context assigned to the measure (Measure.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the measure (Measure.useContext.value.ofType(Quantity)) | (Measure.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the measure Measure.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the measure Measure.useContext | ||
context-type-value | composite | A use context type and value assigned to the measure Measure.useContext | ||
date | date | The measure publication date Measure.date | ||
depends-on | reference | What resource is being referenced Measure.relatedArtifact.where(type='depends-on').resource | Measure.library | ||
derived-from | reference | What resource is being referenced Measure.relatedArtifact.where(type='derived-from').resource | ||
description | string | The description of the measure Measure.description | ||
effective | date | The time during which the measure is intended to be in use Measure.effectivePeriod | ||
identifier | token | External identifier for the measure Measure.identifier | ||
jurisdiction | token | Intended jurisdiction for the measure Measure.jurisdiction | ||
name | string | Computationally friendly name of the measure Measure.name | ||
predecessor | reference | What resource is being referenced Measure.relatedArtifact.where(type='predecessor').resource | ||
publisher | string | Name of the publisher of the measure Measure.publisher | ||
status | token | The current status of the measure Measure.status | ||
successor | reference | What resource is being referenced Measure.relatedArtifact.where(type='successor').resource | ||
title | string | The human-friendly name of the measure Measure.title | ||
topic | token | Topics associated with the measure Measure.topic | ||
url | uri | The uri that identifies the measure Measure.url | ||
version | token | The business version of the measure Measure.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken