Notification Spreekuur.nl OpenAPI specification

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

• postSend a notification to a patient

API docs by Redocly

Spreekuur.nl Notification FHIR API (1.0.0)

Download OpenAPI specification:Download

Send a notification to a patient

Endpoint used by the XIS to send a one-way notification to a patient in Spreekuur.nl. Only Communication resources with category code melding are supported.

Request Body schema: application/fhir+json

required

resourceType required	string Value: "Communication"
required	Array of Patient (object) Contains the Patient resource referenced by Communication.recipient.
required	object The subject of the notification shown to the patient.
status required	string Value: "completed"
required	Array of objects The category will be used by Spreekuur.nl to differentiate between chat messages and notifications.
required	Array of objects The notification content shown to the patient.
required	Array of objects References the contained Patient resource that should receive the notification.

Responses

https://docs.spreekuur.nl/Communication

Request samples

• Payload

Content type

application/fhir+json

{

• "resourceType": "Communication",
• "contained": [

  • {

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

      • {

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

        }

      ],
    • "telecom": [

      • {

        • "system": "email",
        • "value": "jan.janssen@example.com"

        }

      ]

    }

  ],
• "topic": {

  • "text": "Lab results available"

  },
• "status": "completed",
• "category": [

  • {

    • "coding": [

      • {

        • "system": "nl.spreekuur.communication-category",
        • "code": "melding"

        }

      ]

    }

  ],
• "payload": [

  • {

    • "contentString": "Your lab results are available."

    }

  ],
• "recipient": [

  • {

    • "reference": "#9876543210"

    }

  ]

}