Appointment update Spreekuur.nl OpenAPI specification

This page describes the Appointment update API specification Spreekuur.nl provides. The XIS uses this endpoint to create, modify or cancel appointments.

• putCreate, modify or cancel an Appointment

API docs by Redocly

Spreekuur.nl Appointment update FHIR API (1.0.0)

Download OpenAPI specification:Download

Create, modify or cancel an Appointment

The XIS uses this endpoint to send Appointment updates to Spreekuur.nl. Based on the status of the Appointment and whether it is already known in Spreekuur.nl, the update is handled as a new appointment (status booked, not yet known), a modification (status booked, already known) or a cancellation (status cancelled, already known).

path Parameters

id required

string The logical id of the Appointment resource in the XIS.

header Parameters

x-organization-identifier required

string Example: http://fhir.nl/fhir/NamingSystem/agb-z|01000001 The identifier of the organization the Appointment belongs to, in FHIR token format: http://fhir.nl/fhir/NamingSystem/agb-z|{agb-code}.

Request Body schema: application/fhir+json

required

resourceType required	string Value: "Appointment"
id required	string The logical id of the Appointment in the XIS.
status required	string Enum: "booked" "cancelled" Use booked when creating or modifying an appointment. Use cancelled when cancelling an appointment.
start required	string <date-time> The start time of the appointment.
end required	string <date-time> The end time of the appointment.
comment	string Additional comments about the appointment.
required	Array of objects (serviceCategory)
required	Array of objects The participants of the appointment. At minimum, the patient participant must be included with an identifier (BSN) so Spreekuur.nl can match the Appointment to the correct patient.

Responses

https://docs.spreekuur.nl/Appointment/{id}

Request samples

• Payload

Content type

application/fhir+json

{

• "resourceType": "Appointment",
• "id": "12345",
• "status": "booked",
• "start": "2026-04-10T09:00:00Z",
• "end": "2026-04-10T09:30:00Z",
• "comment": "Please arrive 10 minutes early.",
• "serviceCategory": [

  • {

    • "coding": [

      • {

        • "system": "http://www.example-xis.nl/ns/communication-type",
        • "code": "CONSULT",
        • "display": "Consult"

        }

      ]

    }

  ],
• "participant": [

  • {

    • "actor": {

      • "reference": "Patient/456",
      • "display": "Jan Jansen",
      • "identifier": {

        • "system": "http://fhir.nl/fhir/NamingSystem/bsn",
        • "value": "123456789"

        }

      },
    • "status": "accepted"

    }

  ]

}