POST/transactional-api/find-appointments-for-check-in

Find Appointments for Check-in

Returns the patient's face-to-face appointments scheduled for today that are still eligible for self check-in.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/find-appointments-for-check-in' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "patientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dateOfBirth": "2024-07-29"
  }'

Body parameters

Field	Type	Required	Description
patientId	string<uuid> (nullable)	No	Medicus patient identifier. Takes precedence over dateOfBirth if both are supplied.
dateOfBirth	string<date> (nullable)	No	Patient date of birth in Y-m-d format. Alternative to patientId for device check-in flows that collect date of birth only.

Responses

200 Appointments eligible for check-in.

[
  {
    "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "startTime": "string",
    "siteName": "string",
    "roomName": "string",
    "patientCheckInInstructions": "string",
    "practitionerName": "string"
  }
]

400 Validation error.

3 possible code values

Code	Description	When
invalid-patient-id	The patientId is not a UUID	neither patientId nor dateOfBirth supplied; or patientId present but not a UUID
invalid-date-of-birth	The dateOfBirth must be a valid date in Y-m-d format.	dateOfBirth present but not a valid Y-m-d date
multiple-patients-found	Multiple patients have appointments today for this date of birth.	more than one patient has a qualifying appointment today for the supplied date of birth

{
  "errors": [
    {
      "code": "invalid-patient-id",
      "description": "The patientId is not a UUID"
    }
  ]
}

404 No patient found for the given patientId.

{
  "errors": [
    {
      "code": "patient-not-found",
      "description": "Patient not found for the id: 3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}