POST/transactional-api/mark-patient-as-arrived

Mark Patient as Arrived

Checks a patient in for the given appointment, setting its arrival status to arrived when the appointment is still pending.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/mark-patient-as-arrived' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }'

Body parameters

Field	Type	Required	Description
appointmentId	string<uuid>	Yes	Medicus appointment identifier.

Responses

200 Patient checked in.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "arrivalStatus": "string",
  "patientInstructions": "string"
}

400 Validation error.

4 possible code values

Code	Description	When
missing-appointment-id	The appointmentId is required	appointmentId missing
invalid-appointment-id	The appointmentId is not valid	appointmentId not a valid UUID
appointment-not-found	Appointment not found for this appointmentId	appointmentId doesn't exist
cannot-check-in-late-patients	It wasn't possible to check you in because your appointment was scheduled to start at 09:10.	more than 5 minutes have passed since the appointment's intended start time

{
  "errors": [
    {
      "code": "missing-appointment-id",
      "description": "The appointmentId is required"
    }
  ]
}