Chat Spreekuur.nl OpenAPI specification

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

• postSend message from XIS to Spreekuur.nl
• putClose a chat

API docs by Redocly

Spreekuur.nl chat FHIR API (1.0.0)

Download OpenAPI specification:Download

Send message from XIS to Spreekuur.nl

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

https://docs.spreekuur.nl/Communication

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": "Example message from XIS to Spreekuur.nl.",
    • "contentAttachment": {

      • "contentType": "jpeg",
      • "url": "http://test.local/test.jpg",
      • "title": "Test afbeelding"

      }

    }

  ],
• "encounter": {

  • "identifier": [

    • {

      • "system": "nl.example-xis.encounter-id",
      • "value": 1234567890

      }

    ]

  },
• "sender": [

  • {

    • "reference": "PractitionerRole/d131fb4e-e9fe-458f-9ec3-b55c80c2cd75"

    }

  ],
• "recipient": [

  • {

    • "identifier": [

      • {

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

        }

      ]

    }

  ],
• "subject": [

  • {

    • "identifier": [

      • {

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

        }

      ]

    }

  ],
• "category": [

  • {

    • "coding": [

      • {

        • "system": "nl.spreekuur.communication-type",
        • "code": "chat"

        }

      ]

    }

  ]

}

Close a chat

Request Body schema: application/fhir+json

required

resourceType required	string Value: "Encounter"
id required	string
required	Array of objects
status required	string Value: "finished"

Responses

https://docs.spreekuur.nl/Encounter

Request samples

• Payload

Content type

application/fhir+json

{

• "resourceType": "Encounter",
• "id": 1234567890,
• "identifier": [

  • {

    • "system": "https://example-xis.nl/encounter-id",
    • "value": 1234567890

    }

  ],
• "status": "finished"

}