Building on the Platform
...
Solutions
Appointment Scheduling

Retrieve Appointment

4min

Access a patient's upcoming and past appointments from their Electronic Health Record (EHR). This data is pivotal for applications in streamlining scheduling processes, ensuring timely care delivery, and optimizing healthcare provider resources. By understanding appointment history, applications can enhance patient engagement and improve overall healthcare efficiency.

To access this clinical data you'll need the patient identifier, obtainable through the Retrieve Patient interaction.

Interaction

Retrieving the list of allergies and/or intolerances can be done by sending a GET to the Appointment endpoint:

https://api.<region>.founda.com/1/health/organizations/<org-x>/fhir/4/Appointment?<parameters>

Where <region> should be defined according to the different Founda regions and <org-x> should be replaced with the Healthcare Provider's organization ID that you are integrated with.

The response contains a Bundle with 0, 1 or N matching Appointments. The full Appointment resource can be retrieved with the identifier of the selected Appointment from the result set.

Profile

Founda adheres to recognized standards (IHE, HL7 FHIR) to ensure compatibility and harmonization among diverse systems. If there is a profile available for an interaction, it is recommended and preferred to follow the prescribed transactions.

The Retrieve Appointment interaction with the Founda Platform is based on the IHE FHIR Scheduling profile's ITI-117 transaction.

Parameters

To fetch scheduled appointments for a patient, the following search parameters are available.

Parameter

Type

Required

Description

_id

token



Logical ID of the appointment

patient

reference

Y

The patient to retrieve the Allergy and Intolerance overview for

date

date or date range



A date range for the appointment start date

status

string



Example API calls