Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

FHIR API overview

Updated on October 19, 2021

FHIR – Fast Healthcare Interoperability Resources ( is a next generation standards framework created by the HL7 organization. It is designed to support the interoperability and exchange of healthcare related information including clinical, administrative, public health, and research data between organizations. The specification leverages widely used RESTful APIs that use HTTP requests to GET, PUT, POST, and DELETE data.

Pega Foundation for Healthcare

FHIR is based on “Resources” which are common building blocks for all data exchanges. Resources are represented as either XML or JSON.

The Pega FHIR APIs in Pega Foundation for Healthcare offer pre-configured REST/JSON connectors to integrate your application with external electronic medical / health record (EMR/EHR) systems. You can also integrate your application with other clinical data repositories and fetch information about patients or consumers that you manage in your application.

This version of the Pega FHIR APIs supports the current - v4.0.1: R4 Mixed Normative and STU - version of the FHIR Standard in the REST/JSON format for the following Resources:

Allergy IntoleranceRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
BinaryA resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, PDF file, ZIP file, and so on.
Care PlanDescribes 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.
Condition (Problem)Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a diagnosis during an encounter; populating a problem list or a summary statement, such as a discharge summary.
CoverageThis resource is intended to provide the high-level identifiers and descriptors of an insurance plan, typically the information which would appear on an insurance card, which may be used to pay, in part or in whole, for the provision of health care products and services.
DeviceThis resource identifies an instance 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. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
Diagnostic ReportThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
Document ReferenceDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
EncounterAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Explanation of BenefitsThis resource provides the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
Episode of CareAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
Family Member HistorySignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
GoalDescribes the intended objective(s) for a patient, group, or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, among others.
Imaging StudyRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service- Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (for example, X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
ImmunizationDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
MedicationThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
Medication DispenseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
Medication StatementA record of a medication that is being consumed by a patient. A Medication Statement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from e.g. the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.
ObservationMeasurements and simple assertions made about a patient, device, or other subject.
PatientDemographics and other administrative information about an individual or animal receiving care or other health-related services.
PractitionerA person who is directly or indirectly involved in the provisioning of healthcare.
Practitioner RolePractitioner Role covers the recording of the location and types of services that Practitioners are able to provide for an organization
ProcedureAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
ScheduleA container for slot(s) of time that may be available for booking appointments.
SlotA slot of time on a schedule that may be available for booking appointments.

For additional information on the Resources and the Standard object model, refer to

To make use of these APIs, you will need to connect to a source clinical data system that has a FHIR server. Pega used two publicly available sandbox environments for testing the APIs:

Note: All the APIs listed above have been tested on the above open source FHIR test servers as available. The search parameters are as available at the time of the release. Pega is not responsible for any changes that may be introduced on the open source servers.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us