Skip to main content

FHIR API

The FHIR R5 data plane on the dev tier. Every FHIR R5 resource type is mounted under /fhir/R5/ with the standard set of REST interactions.

devhttps://api.sandbox.ovok.com/fhir/R5

What's documented here​

158 FHIR R5 resource types, sourced from the official hl7.fhir.r5.core package. Each carries its top-level elements, search parameters and a link to the official FHIR spec.

Resources by category​

Foundation​

Cross-resource infrastructure — versioning, conformance, terminology binding, capabilities.

  • AuditEvent — A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
  • Basic — Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing reso
  • Binary — A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Bina
  • Bundle — A container for a collection of resources.
  • Composition — A set of healthcare-related information that is assembled together into a single logical package that provides a single
  • Consent — A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies
  • DocumentReference — A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this r
  • Linkage — Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
  • List — A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organizatio
  • MessageHeader — The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the s
  • OperationOutcome — A collection of error, warning, or information messages that result from a system action.
  • Parameters — This resource is used to pass information into and back from an operation (whether invoked directly from REST or within
  • Permission — Permission resource holds access rules for a given data and context.
  • Provenance — Provenance of a resource is a record that describes entities and processes involved in producing and delivering or other
  • Subscription — The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
  • SubscriptionStatus — The SubscriptionStatus resource describes the state of a Subscription during notifications. It is not persisted.
  • SubscriptionTopic — Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter p

Base​

People, places and organisations participating in care.

  • Endpoint — The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b,
  • Group — Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected
  • HealthcareService — The details of a healthcare service available at a location or in a catalog. In the case where there is a hierarchy of
  • Location — Details and position information for a place where services are provided and resources and participants may be stored, f
  • Organization — A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of
  • OrganizationAffiliation — Defines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub
  • Patient — Demographics and other administrative information about an individual or animal receiving care or other health-related s
  • Person — Demographics and administrative information about a person independent of a specific health-related context.
  • Practitioner — A person who is directly or indirectly involved in the provisioning of healthcare or related services.
  • PractitionerRole — A specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organizat
  • RelatedPerson — Information about a person that is involved in a patient's health or the care for a patient, but who is not the target o

Clinical — Summary​

Patient-summary content. The longitudinal clinical picture.

  • AllergyIntolerance — Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to
  • ClinicalImpression — A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the
  • Condition — A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a leve
  • FamilyMemberHistory — Significant health conditions for a person related to the patient relevant in the context of care for the patient.
  • Goal — Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an ac
  • Procedure — An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, th
  • RiskAssessment — An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Clinical — Diagnostics​

Observations, reports, imaging, genomics.

  • BodyStructure — Record details about an anatomical structure. This resource may be used when a coded concept does not provide the neces
  • DiagnosticReport — The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, dev
  • GenomicStudy — A set of analyses performed to analyze and generate genomic data.
  • ImagingSelection — A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifi
  • ImagingStudy — Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includ
  • MolecularSequence — Representation of a molecular sequence.
  • Observation — Measurements and simple assertions made about a patient, device or other subject.
  • Questionnaire — A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detaile
  • QuestionnaireResponse — A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, correspond
  • Specimen — A sample to be used for analysis.

Clinical — Medications​

Medications, immunizations, dispensing, ordering.

  • FormularyItem — This resource describes a product or service that is available through a program and includes the conditions and constra
  • Immunization — Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a
  • ImmunizationEvaluation — Describes a comparison of an immunization event against published recommendations to determine if the administration is
  • ImmunizationRecommendation — A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supp
  • Medication — This resource is primarily used for the identification and definition of a medication, including ingredients, for the pu
  • MedicationAdministration — Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swall
  • MedicationDispense — Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a descript
  • MedicationKnowledge — Information about a medication that is used to support knowledge.
  • MedicationRequest — An order or request for both supply of the medication and the instructions for administration of the medication to a pat
  • MedicationStatement — A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may

Clinical — Care Provision​

Care plans, encounters, requests, communications.

  • CarePlan — Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or commu
  • CareTeam — The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care
  • Communication — A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a respons
  • CommunicationRequest — A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS s
  • DeviceRequest — Represents a request a device to be provided to a specific patient. The device may be an implantable device to be subseq
  • Encounter — An interaction between healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or a
  • EncounterHistory — A record of significant events/milestones key data throughout the history of an Encounter
  • EpisodeOfCare — An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. Th
  • Flag — Prospective warnings of potential issues when providing care to the patient.
  • GuidanceResponse — A guidance response is the formal response to a guidance request, including any output parameters returned by the evalua
  • NutritionIntake — A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be c
  • NutritionOrder — A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
  • RequestOrchestration — A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give thi
  • ServiceRequest — A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
  • SupplyDelivery — Record of delivery of what is supplied.
  • SupplyRequest — A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived pr
  • VisionPrescription — An authorization for the provision of glasses and/or contact lenses to a patient.

Workflow​

Scheduling, tasks and verification.

  • Appointment — A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific dat
  • AppointmentResponse — A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
  • Schedule — A container for slots of time that may be available for booking appointments.
  • Slot — A slot of time on a schedule that may be available for booking appointments.
  • Task — A task to be performed.
  • Transport — Record of transport.
  • VerificationResult — Describes validation requirements, source(s), status and dates for one or more elements.

Financial​

Coverage, claims, payments, billing.

  • Account — A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges fo
  • ChargeItem — The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referri
  • ChargeItemDefinition — The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs
  • Claim — A provider issued list of professional services and products which have been provided, or are to be provided, to a patie
  • ClaimResponse — This resource provides the adjudication details from the processing of a Claim resource.
  • Contract — Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
  • Coverage — Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insuranc
  • CoverageEligibilityRequest — The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in
  • CoverageEligibilityResponse — This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
  • EnrollmentRequest — This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
  • EnrollmentResponse — This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
  • ExplanationOfBenefit — This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account b
  • InsurancePlan — Details of a Health Insurance product/plan provided by an organization.
  • Invoice — Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
  • PaymentNotice — This resource provides the status of the payment for goods and services rendered, and the request and response resource
  • PaymentReconciliation — This resource provides the details including amount of a payment and allocates the payment items being paid.

Specialized — Public Health & Research​

Adverse events, biospecimens, research subjects, evidence.

  • AdverseEvent — An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research
  • BiologicallyDerivedProduct — A biological material originating from a biological entity intended to be transplanted or infused into another (possibly
  • BiologicallyDerivedProductDispense — A record of dispensation of a biologically derived product.
  • DetectedIssue — Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a pa
  • Evidence — The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variable
  • EvidenceReport — The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to s
  • EvidenceVariable — The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
  • NutritionProduct — A food or supplement that is consumed by patients.
  • ResearchStudy — A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical tri
  • ResearchSubject — A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study.
  • Substance — A homogeneous material with a definite composition.

Specialized — Devices​

Device identity, definition, association and observation.

  • Device — This resource describes the properties (regulated, has real time clock, etc.), adminstrative (manufacturer name, model n
  • DeviceAssociation — A record of association of a device.
  • DeviceDefinition — This is a specialized resource that defines the characteristics and capabilities of a device.
  • DeviceDispense — Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the p
  • DeviceMetric — Describes a measurement, calculation or setting capability of a device. The DeviceMetric resource is derived from the I
  • DeviceUsage — A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.

Specialized — Quality & Testing​

Measures, definitions, test scripts and reports.

  • ActivityDefinition — This resource allows for the definition of some activity to be performed, independent of a particular patient, practitio
  • EventDefinition — The EventDefinition resource provides a reusable description of when a particular event can occur.
  • Library — The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expo
  • Measure — The Measure resource provides the definition of a quality measure.
  • MeasureReport — The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resou
  • ObservationDefinition — Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health
  • PlanDefinition — This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. Th
  • SpecimenDefinition — A kind of specimen with associated set of requirements.
  • TestPlan — A plan for executing testing on an artifact or specifications
  • TestReport — A summary of information based on the results of executing a TestScript.
  • TestScript — A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specif

Specialized — Medication Definition​

Regulatory & manufacturing models for medicinal products.

  • AdministrableProductDefinition — A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple com
  • ClinicalUseDefinition — A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, m
  • Ingredient — An ingredient of a manufactured item or pharmaceutical product.
  • ManufacturedItemDefinition — The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a pack
  • MedicinalProductDefinition — Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug
  • PackagedProductDefinition — A medically related item or items, in a container or package.
  • RegulatedAuthorization — Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cite
  • SubstanceDefinition — The detailed description of a substance, typically at a level beyond what is used for prescribing.
  • SubstanceNucleicAcid — Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will
  • SubstancePolymer — Properties of a substance specific to it being a polymer.
  • SubstanceProtein — A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are ei
  • SubstanceReferenceInformation — Todo.
  • SubstanceSourceMaterial — Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material

Terminology​

Code systems, value sets, mappings, naming.

  • CodeSystem — The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its
  • ConceptMap — A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, o
  • NamingSystem — A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices
  • TerminologyCapabilities — A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be
  • ValueSet — A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particu

Conformance​

Schemas, profiles, search params, capability statements.

  • ActorDefinition — The ActorDefinition resource is used to describe an actor - a human or an application that plays a role in data exchange
  • ArtifactAssessment — This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights
  • CapabilityStatement — A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version o
  • Citation — The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Ci
  • CompartmentDefinition — A compartment definition that defines how resources are accessed on a server.
  • ConditionDefinition — A definition of a condition and information relevant to managing it.
  • ExampleScenario — A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evo
  • GraphDefinition — A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by follo
  • ImplementationGuide — A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR r
  • MessageDefinition — Defines the characteristics of a message that can be shared between systems, including the type of event that initiates
  • OperationDefinition — A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction
  • Requirements — The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, a
  • SearchParameter — A search parameter that defines a named search item that can be used to search/filter on a resource.
  • StructureDefinition — A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR
  • StructureMap — A Map of relationships between 2 structures that can be used to transform data.

Other​

Resources outside the standard FHIR R5 module decomposition.

  • InventoryItem — functional description of an inventory item used in inventory and supply-related workflows.
  • InventoryReport — A report of inventory or stock items.