AppointmentResponse

The AppointmentResponse resource is used when an external party sends a patient’s response to an appointment request to Open Aidn.

Open Aidn currently exposes selected behavior for the base HL7 FHIR R4 AppointmentResponse resource. A formal Aidn profile may be published later.

Standards and profiles

• HL7 FHIR R4: AppointmentResponse

Endpoints

Method	Path	Required scope	Description
PUT	/AppointmentResponse	patient/appointmentresponse.write	Submit an AppointmentResponse resource.

Request body

Send a FHIR AppointmentResponse resource as JSON. Open Aidn currently handles appointment responses where the participant status represents a patient cancellation.

Responses

Status	Description
200 OK	The appointment response was handled.
409 Conflict	The response could not be applied. The response body is a FHIR OperationOutcome.

OperationOutcome

Conflict responses use an OperationOutcome with an error issue and diagnostics explaining that the appointment response could not be applied to the appointment.

Example write

PUT /AppointmentResponse HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/fhir+json
Authorization: Bearer <ACCESS_TOKEN>

{
  "resourceType": "AppointmentResponse",
  "appointment": {
    "reference": "Appointment/<APPOINTMENT_ID>"
  },
  "participantStatus": "declined"
}

The response is 200 OK when Open Aidn has applied the appointment response.