Patient Spreekuur.nl OpenAPI specification

This page describes the Patient API specification Spreekuur.nl provides.

• postSearch for a patient by identifier (BSN or patientIdpId)
• getDiscover if a patient has a Spreekuur.nl account.
• postSend invitation mail to a Patient to start using Spreekuur.nl or invite to an existing chat

API docs by Redocly

Spreekuur.nl Patient FHIR API (1.1.0)

Download OpenAPI specification:Download

Search for a patient by identifier (BSN or patientIdpId)

header Parameters

organization_agb required

string Example: 12345678 The AGB code of the organization that is performing the search.

Request Body schema: application/x-www-form-urlencoded

required

identifier required

string Patient identifier in the format 'system|value'. Use 'http://fhir.nl/fhir/NamingSystem/bsn|{bsn}' for BSN search or 'http://spreekuur.nl/fhir/NamingSystem/patientIdpId|{uuid}' for patientIdpId search.

Responses

https://docs.spreekuur.nl/Patient/_search

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Example

Search by BSNSearch by Patient IDP IDSearch by BSN

identifier=http%3A%2F%2Ffhir.nl%2Ffhir%2FNamingSystem%2Fbsn%7C336226068

Response samples

• 200

Content type

application/fhir+json

Example

Response when searching by BSNResponse when searching by patientIdpIdResponse when searching by BSN

Returns a patient with BSN identifier; resource includes spreekuurIdpId extension.

{

• "resourceType": "Bundle",
• "id": "af72b4e3-d5ae-4f01-8602-a2a48d62e4a9",
• "meta": {

  • "lastUpdated": "2026-02-03T12:10:48.654+01:00"

  },
• "type": "searchset",
• "total": 1,
• "link": [

  • {

    • "relation": "self",
    • "url": "https://api-samen.test.spreekuur.nl/fhir/r4/Patient/_search"

    }

  ],
• "entry": [

  • {

    • "fullUrl": "https://api-samen.test.spreekuur.nl/fhir/r4/Patient/900249110",
    • "resource": {

      • "resourceType": "Patient",
      • "id": "900249110",
      • "extension": [

        • {

          • "url": "http://spreekuur.nl/fhir/NamingSystem/spreekuurIdpId",
          • "valueString": "2911b89c-2680-4778-964d-6377a2372bf9"

          }

        ],
      • "identifier": [

        • {

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

          }

        ]

      }

    }

  ]

}

Discover if a patient has a Spreekuur.nl account.

query Parameters

identifier required

string Example: identifier=http://fhir.nl/fhir/NamingSystem/bsn|123456782 The patient's BSN number or Patient IDP ID in the format system|value

header Parameters

organization_agb required

string Example: 12345678 The AGB code of the organization that is performing the search.

Responses

https://docs.spreekuur.nl/Patient

Response samples

• 200

Content type

application/fhir+json

{

• "resourceType": "Bundle",
• "meta": {

  • "versionId": "4037143"

  },
• "type": "searchset",
• "total": 1,
• "entry": [

  • {

    • "resource": {

      • "resourceType": "Patient",
      • "id": 123456782,
      • "extension": [

        • {

          • "url": "http://spreekuur.nl/fhir/NamingSystem/spreekuurIdpId",
          • "valueString": "2911b89c-2680-4778-964d-6377a2372bf9"

          }

        ],
      • "identifier": [

        • {

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

          }

        ]

      }

    }

  ]

}

Send invitation mail to a Patient to start using Spreekuur.nl or invite to an existing chat

header Parameters

organization_agb required

string Example: 88888888 The AGB code of the organization inviting the patient

Request Body schema: application/fhir+json

required

One of

resourceType required	string Value: "Patient"
id required	string
required	Array of objects Patient identifier. Use either BSN or patientIdpId system.
required	Array of objects

Responses

https://docs.spreekuur.nl/Patient

Request samples

• Payload

Content type

application/fhir+json

Example

PatientInvitePatientInviteForChatPatientInvite

{

• "resourceType": "Patient",
• "id": "example-patient-id",
• "identifier": [

  • {

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

    }

  ],
• "telecom": [

  • {

    • "system": "email",
    • "value": "patient@example.com"

    }

  ]

}