Skip to main content

Available Apointments

Available Apointments API

GET /available-appointments/search​

Returns available appointments on a specific health care service for a patient's health coverage. Optionally, can be used to search by practitioner and/or location

URI Parameters​

  • patient_id: Patient's identifier.
  • health_insurance_id: Patient's health insurance id.
  • health_care_service_id: Required health care service's id.
  • practitioner_id: Practitioner id. If provided, it is expected to return only available appointments for the specified Practitioner
  • location_id: Location id. If provided, it is expected to return only available appointments for the specified location
Example:
 GET /available-appointments/search?patient_id=f6262835-fbd8-423a-8746-46069edbaf18&health_insurance_id=45e00934-8516-4c34-a478-eb27a37678a0&health_care_service_id=e2c6370f-eeed-4170-bb55-12936fafbcde

Response:​

Code 200

{
     "appointments": [
            {
                "date": "2023-08-23T17:45:00",
                "health_care_service_id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
                "practitioner_id": "6f94a98c-420e-44c1-89b9-f619dc75c382",
                "location_id": "b570a440-c305-4604-9228-8e4b88e3dcf2",
                "mode": "in-person"
            },
            {
                "date": "2023-08-23T18:00:00",
                "health_care_service_id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
                "practitioner_id": "6f94a98c-420e-44c1-89b9-f619dc75c382",
                "location_id": "b570a440-c305-4604-9228-8e4b88e3dcf2",
                "mode": "in-person"
            }
      ]
}