# ObservationDefinition

Canonical page: https://docs.ovok.com/api/fhir/r4/observation-definition

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

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/ObservationDefinition/[id]` |
| Vread | `GET` | `/fhir/R4/ObservationDefinition/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ObservationDefinition/[id]` |
| Patch | `PATCH` | `/fhir/R4/ObservationDefinition/[id]` |
| Delete | `DELETE` | `/fhir/R4/ObservationDefinition/[id]` |
| Create | `POST` | `/fhir/R4/ObservationDefinition` |
| Search | `GET` | `/fhir/R4/ObservationDefinition` |
| History | `GET` | `/fhir/R4/ObservationDefinition/[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-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Category of observation |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Type of observation (code / type) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifier for this ObservationDefinition instance |
| <span id="element-permitted-data-type"></span>`permittedDataType` | [code](/fhir-elements/primitive/code) | `0..*` | Quantity \| CodeableConcept \| string \| boolean \| integer \| Range \| Ratio \| SampledData \| time \| dateTime \| Period |
| <span id="element-multiple-results-allowed"></span>`multipleResultsAllowed` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Multiple results allowed |
| <span id="element-method"></span>`method` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Method used to produce the observation |
| <span id="element-preferred-report-name"></span>`preferredReportName` | [string](/fhir-elements/primitive/string) | `0..1` | Preferred report name |
| <span id="element-quantitative-details"></span>`quantitativeDetails` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Characteristics of quantitative results |
| <span id="element-qualified-interval"></span>`qualifiedInterval` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Qualified range for continuous and ordinal observation results |
| <span id="element-valid-coded-value-set"></span>`validCodedValueSet` | [Reference](/fhir-elements/complex/reference) | `0..1` | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| <span id="element-normal-coded-value-set"></span>`normalCodedValueSet` | [Reference](/fhir-elements/complex/reference) | `0..1` | Value set of normal coded values for the observations conforming to this ObservationDefinition |
| <span id="element-abnormal-coded-value-set"></span>`abnormalCodedValueSet` | [Reference](/fhir-elements/complex/reference) | `0..1` | Value set of abnormal coded values for the observations conforming to this ObservationDefinition |
| <span id="element-critical-coded-value-set"></span>`criticalCodedValueSet` | [Reference](/fhir-elements/complex/reference) | `0..1` | Value set of critical coded values for the observations conforming to this ObservationDefinition |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| — | — | No resource-specific search parameters are listed in the package. |

## Reference [#reference]

Official FHIR R4 spec: [ObservationDefinition](https://hl7.org/fhir/R4/observationdefinition.html).  
Maturity: Draft (FMM 0).
