Skip to main content

FHIR resources

FHIR R4 organizes clinical and administrative information into typed resources. Each resource has a defined structure, cardinalities, data types, and standard interactions. Ovok exposes FHIR resource APIs for application workflows; the exact interactions available to a project are determined by its API capabilities.

This reference is generated from the official HL7 FHIR R4 core definitions package, release 4.0.1. It covers 146 concrete resource definitions, including each resource's purpose, standard interaction paths, top-level elements, resource-specific search parameters, and maturity level.

Choose a resource​

Start with the records most commonly used in remote monitoring and care applications:

  • CarePlan — Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
  • Device — A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
  • Encounter — An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
  • Medication — This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
  • Observation — Measurements and simple assertions made about a patient, device or other subject.
  • Patient — Demographics and other administrative information about an individual or animal receiving care or other health-related services.
  • Procedure — An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

The sidebar contains the complete alphabetized resource list.

How to read a resource page​

Resource structure​

Each resource is defined by elements. A page lists the top-level elements, their types, cardinalities, and short descriptions. For example, a Patient can have multiple identifiers and names, while an Observation has a required status and code and may carry a value, subject, device, and reference range. Follow linked data types to the FHIR Elements reference.

Cardinality​

Cardinality states how many times an element can appear. 0..1 is optional and singular, 1..1 is required and singular, 0..* is optional and repeating, and 1..* is required and repeating. A choice element such as value[x] means one of the listed types is used in a resource instance.

Interactions​

FHIR defines a REST interaction pattern for reading, creating, updating, deleting, searching, and reading history. Resource pages show the corresponding R4 route shape using [id] and [vid] placeholders. The table documents the FHIR pattern; check your project's capability statement before relying on a particular interaction.

Search parameters​

FHIR search uses named parameters defined for each resource. The generated page lists the parameter name, FHIR search type, and definition from the R4 package. Server support can be narrower than the specification, and search modifiers or chained searches should be checked against the Ovok API capabilities.

Specification maturity​

Each resource page reports the maturity level supplied by HL7. Maturity ranges from Draft through Trial Use levels to Normative; it describes the specification's maturity, not Ovok certification or project readiness.

Source and version​

The pages are synchronized from HL7's FHIR R4 core package, version 4.0.1. Refer to the official FHIR R4 specification for normative definitions and implementation guidance.