# Measure

Canonical page: https://docs.ovok.com/api/fhir/r4/measure

The Measure resource provides the definition of a quality measure.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Measure/[id]` |
| Vread | `GET` | `/fhir/R4/Measure/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Measure/[id]` |
| Patch | `PATCH` | `/fhir/R4/Measure/[id]` |
| Delete | `DELETE` | `/fhir/R4/Measure/[id]` |
| Create | `POST` | `/fhir/R4/Measure` |
| Search | `GET` | `/fhir/R4/Measure` |
| History | `GET` | `/fhir/R4/Measure/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Canonical identifier for this measure, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the measure |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the measure |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this measure (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this measure (human friendly) |
| <span id="element-subtitle"></span>`subtitle` | [string](/fhir-elements/primitive/string) | `0..1` | Subordinate title of the measure |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-subject-x"></span>`subject[x]` | [CodeableConcept](/fhir-elements/complex/codeable-concept), [Reference](/fhir-elements/complex/reference) | `0..1` | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the measure |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for measure (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this measure is defined |
| <span id="element-usage"></span>`usage` | [string](/fhir-elements/primitive/string) | `0..1` | Describes the clinical usage of the measure |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the measure was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the measure was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the measure is expected to be used |
| <span id="element-topic"></span>`topic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The category of the measure, such as Education, Treatment, Assessment, etc. |
| <span id="element-author"></span>`author` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who authored the content |
| <span id="element-editor"></span>`editor` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who edited the content |
| <span id="element-reviewer"></span>`reviewer` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who reviewed the content |
| <span id="element-endorser"></span>`endorser` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Who endorsed the content |
| <span id="element-related-artifact"></span>`relatedArtifact` | [RelatedArtifact](/fhir-elements/complex/related-artifact) | `0..*` | Additional documentation, citations, etc. |
| <span id="element-library"></span>`library` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Logic used by the measure |
| <span id="element-disclaimer"></span>`disclaimer` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Disclaimer for use of the measure or its referenced content |
| <span id="element-scoring"></span>`scoring` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | proportion \| ratio \| continuous-variable \| cohort |
| <span id="element-composite-scoring"></span>`compositeScoring` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | opportunity \| all-or-nothing \| linear \| weighted |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | process \| outcome \| structure \| patient-reported-outcome \| composite |
| <span id="element-risk-adjustment"></span>`riskAdjustment` | [string](/fhir-elements/primitive/string) | `0..1` | How risk adjustment is applied for this measure |
| <span id="element-rate-aggregation"></span>`rateAggregation` | [string](/fhir-elements/primitive/string) | `0..1` | How is rate aggregation performed for this measure |
| <span id="element-rationale"></span>`rationale` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Detailed description of why the measure exists |
| <span id="element-clinical-recommendation-statement"></span>`clinicalRecommendationStatement` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Summary of clinical guidelines |
| <span id="element-improvement-notation"></span>`improvementNotation` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | increase \| decrease |
| <span id="element-definition"></span>`definition` | [markdown](/fhir-elements/primitive/markdown) | `0..*` | Defined terms used in the measure documentation |
| <span id="element-guidance"></span>`guidance` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Additional guidance for implementers |
| <span id="element-group"></span>`group` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Population criteria group |
| <span id="element-supplemental-data"></span>`supplementalData` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | What other data should be reported with the measure |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `composed-of` | reference | What resource is being referenced |
| `context` | token | A use context assigned to the measure |
| `context-quantity` | quantity | A quantity- or range-valued use context assigned to the measure |
| `context-type` | token | A type of use context assigned to the measure |
| `context-type-quantity` | composite | A use context type and quantity- or range-based value assigned to the measure |
| `context-type-value` | composite | A use context type and value assigned to the measure |
| `date` | date | The measure publication date |
| `depends-on` | reference | What resource is being referenced |
| `derived-from` | reference | What resource is being referenced |
| `description` | string | The description of the measure |
| `effective` | date | The time during which the measure is intended to be in use |
| `identifier` | token | External identifier for the measure |
| `jurisdiction` | token | Intended jurisdiction for the measure |
| `name` | string | Computationally friendly name of the measure |
| `predecessor` | reference | What resource is being referenced |
| `publisher` | string | Name of the publisher of the measure |
| `status` | token | The current status of the measure |
| `successor` | reference | What resource is being referenced |
| `title` | string | The human-friendly name of the measure |
| `topic` | token | Topics associated with the measure |
| `url` | uri | The uri that identifies the measure |
| `version` | token | The business version of the measure |

## Reference [#reference]

Official FHIR R4 spec: [Measure](https://hl7.org/fhir/R4/measure.html).  
Maturity: Trial Use 2 (FMM 2).
