Appointment Management Services (Appointment)
Retrieve available slots and book an appointment for a specific health and care service, for example, from SingHealth Polyclinics into a General Medicine Consultation.
Enable view, book, cancel, and reschedule appointments. Also, let consumers register current day's appointment, view their queue status and itinerary for their visit.
Book Appointment
This API books a new appointment for NSC. For other use cases on booking appointments (NN Polyclinics, SHS Polyclinics, etc.), please refer to the official CCDP documentation.
Sample Flow
APIs
The API(s) used in this use case are as follows:
1. /Patient/$find
POST [baseURL]/Patient/$find Try API
2. /Practitioner/_search
POST [baseURL]/Practitioner/_search
*the above API is a default FHIR call.
3. /Slot/$find-available-slots
POST [baseURL]/Slot/$find-available-slots Try API
4. /Appointment
POST [baseURL]/Appointment Try API
Reschedule Appointment
This API reschedules an existing appointment.
Sample Flow
APIs
The API(s) used in this use case are as follows:
1. /Patient/$find
POST [baseURL]/Patient/$find Try API
2. /Slot/$find-available-slots
POST [baseURL]/Slot/$find-available-slots Try API
4. /Appointment/$reschedule
POST [baseURL]/Appointment/$reschedule Try API
Cancel Appointment
This API cancels an existing appointment.
Sample Flow
APIs
The API(s) used in this use case are as follows:
1. /Patient/$find
POST [baseURL]/Patient/$find Try API
2. /Appointment/_search
POST [baseURL]/Appointment/_search <a href="https://apidocs.healthx.sg/ccdp/Appointment#post-/Appointment/_search" class="try-api-button
target="_blank"">Try API
4. /Appointment/$cancel
POST [baseURL]/Appointment/$cancel Try API
Refresh Queue Status
This API refreshes a patient's queue status for non-VPC appointments.
Sample Flow
APIs
The API(s) used in this use case are as follows:
**1. /Encounter/
POST [baseURL]/Encounter/{id} Try API
Validate Patient Profile
This API validates a patient's profile (for SHS patients only) by doing the following:
- Gets the patient's information is check if patient already exists
- Creates a patient profile if it does not already exist
- Gets the patient information again to ensure it now exists
Sample Flow
APIs
The API(s) used in this use case are as follows:
1. /Patient/$get-info
POST [baseURL]/Patient/$get-info Try API