Chat XIS OpenAPI specification
This page describes the Chat API specification the XIS should provide to Spreekuur.nl.
XIS chat FHIR API (1.0.0)
Download OpenAPI specification:Download
Send message from Spreekuur.nl to XIS
Request Body schema: application/fhir+jsonrequired
resourceType required | string Value: "Communication" |
id required | string |
required | Array of objects |
object | |
status required | string Value: "completed" |
required | Array of objects |
required | object |
required | Array of objects |
required | Array of objects |
required | Array of objects |
required | Array of objects |
Responses
Request samples
- Payload
Content type
application/fhir+json
{- "resourceType": "Communication",
- "id": 1234567890,
- "identifier": [
- {
- "system": "nl.spreekuur.communication-id",
- "value": 1234567890
}
], - "topic": {
- "text": "Example topic"
}, - "status": "completed",
- "payload": [
- {
- "contentString": "Dit is een testbericht van Spreekuur.nl naar het XIS.",
- "contentAttachment": {
- "contentType": "jpeg",
- "title": "Test afbeelding"
}
}
], - "encounter": {
- "identifier": [
- {
- "system": "nl.example-xis.encounter-id",
- "value": 1234567890
}
]
}, - "recipient": [
], - "sender": [
], - "subject": [
], - "category": [
- {
- "coding": [
- {
- "system": "nl.spreekuur.communication-type",
- "code": "chat"
}
]
}
]
}
Mark message as read.
This endpoint uses the "conditional patch" operation. See https://build.fhir.org/http.html#cond-patch for more information.
path Parameters
communicationId | string The id of the Communication resource which should be marked as read. |
Request Body schema: application/fhir+jsonrequired
op required | string Value: "add" |
path required | string |
required | object |
Responses
Request samples
- Payload
Content type
application/fhir+json
{- "op": "add",
- "path": "/recipient/0/extension",
- "value": {
- "url": "nl.spreekuur.nl.ResourceSeenAt",
- "valueDateTime": "2024-09-09T16:35:47"
}
}