Skip to main content
API docs by Redocly

XIS chat FHIR API (1.0.0)

Download OpenAPI specification:Download

Send message from Spreekuur.nl to XIS

Request Body schema: application/fhir+json
required
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

Content type
application/fhir+json
{
  • "resourceType": "Communication",
  • "id": 1234567890,
  • "identifier": [
    ],
  • "topic": {
    },
  • "status": "completed",
  • "payload": [
    ],
  • "encounter": {
    },
  • "recipient": [],
  • "sender": [],
  • "subject": [],
  • "category": [
    ]
}

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+json
required
op
required
string
Value: "add"
path
required
string
required
object

Responses

Request samples

Content type
application/fhir+json
{
  • "op": "add",
  • "path": "/recipient/0/extension",
  • "value": {
    }
}