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

Request Body schema: application/fhir+json

required

resourceType required	string Value: "Communication"
required	Array of Patient (object)
required	object
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
required	Array of objects

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": "notification"

        }

      ]

    }

  ],
• "payload": [

  • {

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

    }

  ],
• "recipient": [

  • {

    • "reference": "#9876543210"

    }

  ]

}