Patient Spreekuur.nl OpenAPI specification

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

• postDiscover if a patient has a Spreekuur.nl account.
• postSend invitation mail to a Patient to start using Spreekuur.nl

API docs by Redocly

Spreekuur.nl Patient FHIR API (1.0.0)

Download OpenAPI specification:Download

Discover if a patient has a Spreekuur.nl account.

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

required

identifier required

string The patient's BSN number in the format system|value

Responses

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

Response samples

• 200

Content type

application/fhir+json

{

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

  • "versionId": "4037143"

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

  • {

    • "resource": {

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

        • {

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

          }

        ],
      • "extension": [

        • {

          • "url": "http://spreekuur.nl/fhir/NamingSystem/spreekuurIdpId",
          • "valueString": "d3641041-50c5-4141-b1eb-4e54d9bd0c15"

          }

        ]

      }

    }

  ]

}

Send invitation mail to a Patient to start using Spreekuur.nl

Request Body schema: application/fhir+json

required

resourceType required	string Value: "Patient"
id required	string
required	Array of objects
required	Array of objects

Responses

https://docs.spreekuur.nl/Patient

Request samples

• Payload

Content type

application/fhir+json

{

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

  • {

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

    }

  ],
• "telecom": [

  • {

    • "system": "email",
    • "value": "example-patient@example.local"

    }

  ]

}