FHIR Administration API

API specificaties

FHIR Administration API

API specificaties

De Zorgplatform Administration API geeft administratieve informatie terug bij een bepaalde werkstroom. Dit gaat bijvoorbeeld om de zorgverlener die het transmurale werkproces heeft aangevraagd, patiëntinformatie zoals naam, adres en woonplaats of de verzekeringsgegevens van de patiënt. Bekijk 'FHIR specificaties' voor de specificaties van de FHIR resources.

De FHIR Administration API is beschikbaar voor alle aangesloten vertrouwde applicaties.

API specificaties

Policies
Versie
Request format
Response format
Operaties

API specificaties

Policies
Versie
Request format
Response format
Operaties
Policies
  • Operaties kunnen uitsluitend worden aangeroepen door een geldig Zorgplatform token mee te geven.
  • Resources kunnen alleen worden opgevraagd indien de opvraging gebeurt in het kader van een workflow.
Versie

STU 3

Request format

HTTP GET application/fhir+json

De partnerapplicatie verzoekt de Zorgplatform Administration API om de Resources op te leveren door middel van een GET request op het desbetreffende endpoint conform het Zorgplatform Resources protocol. Sommige resources worden per instance opgehaald. Andere resources worden impliciet opgevraagd met een FHIR search op het endpoint.

Response format

application/fhir+json

De partnerapplicatie ontvangt de opgevraagde resources van Zorgplatform. Indien het request een individuele resource opvraagt met een resource ID, ontvangt de partnerapplicatie een resource als enkele instance. Indien het request een FHIR-search was, ontvangt de partnerapplicatie een bundle met daarin één of meerdere instanties van de opgevraagde resource. Deze resources bevatten de meest recente informatie zoals deze bekend is bij de partij die de gegevens heeft aangemeld. De gegevens worden on-demand opgehaald bij de partij die de gegevens heeft aangemeld.

Operaties
  • Patient resource
  • PractitionerRole resource
  • Practitioner resource (aanvragend zorgverlener)
  • Coverage
  • Organization resource (verzekeraar van de patiënt)