Hier vindt u alle informatie voor ontwikkelaars
FHIR specificaties
Task
Patient
PractitionerRole
Practitioner
Organization
Coverage
DocumentManifest
DocumentReference
Binary
Flag
AllergyIntolerance
CapabilityStatement
Bundle
OperationOutcome
FHIR specificaties
Task
Patient
PractitionerRole
Practitioner
Organization
Coverage
DocumentManifest
DocumentReference
Binary
Flag
AllergyIntolerance
CapabilityStatement
Bundle
OperationOutcome
Via Zorgplatform kan logistieke en medische patiëntinformatie gedeeld worden. De Zorgplatform FHIR API's worden gebruikt om FHIR Resources uit te wisselen tussen vertrouwde partijen. Het uitwisselen van Resources gebeurt conform het Zorgplatform Resources protocol.
Momenteel zijn de volgende Resources uit te wisselen via Zorgplatform.
- Task: Task STU3
- Patient: NL-Core-Patient profiel
- Practitioner: NL-Core-Practitioner profiel
- PractitionerRole: NL-Core-PractitionerRole profiel
- Organization: NL-Core-Organization profiel
- Coverage: ZIB Betaler
- DocumentManifest: IHE MHD Document Manifest profiel
- DocumentReference: IHE MHD Document Reference profiel
- Binary: Binary
- Flag: ZIB Alert
- AllergyIntolerance: ZIB AllergyIntolerance
- CapabilityStatement
- Bundle
- OperationOutcome
Resources worden als losse instances of in een FHIR Bundle resource uitgewisseld.
Bekijk de Swagger documentatie om per API voorbeelden van de FHIR resources te zien, de wijze waarop deze opgehaald kunnen worden en mogelijke foutmeldingen. Hiervan is momenteel enkel de FHIR BgZ API beschikbaar.
Task
Task
Een van de functionaliteiten van Zorgplatform is het ondersteunen van werkstromen tussen vertrouwde partijen. De Task resource is daar een onderdeel van. De Task resource kan per instance uitgewisseld worden op https://api.zorgplatform.online/fhir/v1/Task.
Deze resource kan opgehaald worden door digitale zorg applicaties aangesloten op Zorgplatform met het workflow-id als parameter als onderdeel van een app voorschrift, verwijzing of andere vorm van samenwerking tussen een zorginstelling en een applicatie. In deze resource staat een verwijzing naar onder andere de patiënt. Voor meer informatie over workflows, zie de Workflow API.
Deze resource kan geüpdatet worden wanneer (een actie in) het samenwerkingsproces is afgewezen, geaccepteerd of afgerond. Het is momenteel enkel mogelijk om de Task.status aan te passen naar ‘rejected’, ‘accepted’ of ‘completed’. Het resource-id wordt gebruikt om de update per instance uit te voeren.
Een van de functionaliteiten van Zorgplatform is het ondersteunen van werkstromen tussen vertrouwde partijen. De Task resource is daar een onderdeel van. De Task resource kan per instance uitgewisseld worden op https://api.zorgplatform.online/fhir/v1/Task.
Deze resource kan opgehaald worden door digitale zorg applicaties aangesloten op Zorgplatform met het workflow-id als parameter als onderdeel van een app voorschrift, verwijzing of andere vorm van samenwerking tussen een zorginstelling en een applicatie. In deze resource staat een verwijzing naar onder andere de patiënt. Voor meer informatie over workflows, zie de Workflow API.
Deze resource kan geüpdatet worden wanneer (een actie in) het samenwerkingsproces is afgewezen, geaccepteerd of afgerond. Het is momenteel enkel mogelijk om de Task.status aan te passen naar ‘rejected’, ‘accepted’ of ‘completed’. Het resource-id wordt gebruikt om de update per instance uit te voeren.
Patient
Patient
Wanneer een digitale zorg applicatie patiëntgegevens uit de zorginstelling nodig heeft (zoals NAW-gegevens voor aanmelding bij een digitale zorg applicatie), kan daarvoor de Patient resource ingezet worden. De Patient resource kan per instance uitgewisseld worden op https://api.zorgplatform.online/fhir/v1/Patient. De resource voldoet aan het NL-Core Patient profiel.
Deze resource kan opgehaald worden door digitale zorg applicaties aangesloten op Zorgplatform met het resource-id als parameter als onderdeel van een workflow. De Patient resource kan opgehaald worden met behulp van de reference in de Task resource.
Wanneer een digitale zorg applicatie patiëntgegevens uit de zorginstelling nodig heeft (zoals NAW-gegevens voor aanmelding bij een digitale zorg applicatie), kan daarvoor de Patient resource ingezet worden. De Patient resource kan per instance uitgewisseld worden op https://api.zorgplatform.online/fhir/v1/Patient. De resource voldoet aan het NL-Core Patient profiel.
Deze resource kan opgehaald worden door digitale zorg applicaties aangesloten op Zorgplatform met het resource-id als parameter als onderdeel van een workflow. De Patient resource kan opgehaald worden met behulp van de reference in de Task resource.
PractitionerRole
PractitionerRole
De PractitionerRole resource (samen met de Practitioner resource) omschrijft de verantwoordelijke zorgverlener in een werkproces. Dit kan bijvoorbeeld de aanvragende arts zijn in het kader van een verwijzing. De PractionerRole resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/PractitionerRole.
De resource voldoet aan het NL-Core-PractitionerRole profiel.
PractionerRole resource kan opgehaald worden bij Zorgplatform. De PractitionerRole resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
De PractitionerRole resource (samen met de Practitioner resource) omschrijft de verantwoordelijke zorgverlener in een werkproces. Dit kan bijvoorbeeld de aanvragende arts zijn in het kader van een verwijzing. De PractionerRole resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/PractitionerRole.
De resource voldoet aan het NL-Core-PractitionerRole profiel.
PractionerRole resource kan opgehaald worden bij Zorgplatform. De PractitionerRole resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
Practitioner
Practitioner
De Practitioner resource (samen met de PractitionerRole resource) omschrijven de verantwoordelijke zorgverlener in een werkproces. De Practitioner resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Practitioner. De resource voldoet aan het NL-Core-Practitioner profiel.
De Practitioner resource kan opgehaald worden bij Zorgplatform. De Practitioner resource kan opgehaald worden met behulp van de reference in de PractitionerRole resource als id.
De Practitioner resource (samen met de PractitionerRole resource) omschrijven de verantwoordelijke zorgverlener in een werkproces. De Practitioner resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Practitioner. De resource voldoet aan het NL-Core-Practitioner profiel.
De Practitioner resource kan opgehaald worden bij Zorgplatform. De Practitioner resource kan opgehaald worden met behulp van de reference in de PractitionerRole resource als id.
Organization
Organization
De Organization resource omschrijft een organisatie. Dit kan bijvoorbeeld de verzekeraar van de patiënt of een zorgaanbieder in het werkproces zijn. De Organization resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Organization. De resource voldoet aan het NL-Core-Organization profiel.
Organization resource kan opgehaald worden bij Zorgplatform. De Organization resource wordt opgehaald met een resource-id uit de Coverage resource (voor de verzekeraar) of uit de Task resource (voor de zorgaanbieder in het werkproces).
De Organization resource omschrijft een organisatie. Dit kan bijvoorbeeld de verzekeraar van de patiënt of een zorgaanbieder in het werkproces zijn. De Organization resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Organization. De resource voldoet aan het NL-Core-Organization profiel.
Organization resource kan opgehaald worden bij Zorgplatform. De Organization resource wordt opgehaald met een resource-id uit de Coverage resource (voor de verzekeraar) of uit de Task resource (voor de zorgaanbieder in het werkproces).
Coverage
Coverage
De Coverage resource omschrijft de verzekeringsgegevens van de patiënt, en kan een referentie bevatten naar de Organization resource voor de verzekeraar. De Coverage resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Coverage. De resource maakt gebruik van het profiel ZIB Payer.
Coverage resource kan opgehaald worden bij Zorgplatform. De Coverage resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
De Coverage resource omschrijft de verzekeringsgegevens van de patiënt, en kan een referentie bevatten naar de Organization resource voor de verzekeraar. De Coverage resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Coverage. De resource maakt gebruik van het profiel ZIB Payer.
Coverage resource kan opgehaald worden bij Zorgplatform. De Coverage resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
DocumentManifest
DocumentManifest
De Document Manifest resource wordt gebruikt om metadata van Document Reference resource(s)op te leveren. De Document Manifest resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/DocumentManifest. Er wordt gebruik gemaakt van het IHE MHD Document Manifest profiel.
De Document Manifest resource wordt gebruikt om metadata van Document Reference resource(s)op te leveren. De Document Manifest resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/DocumentManifest. Er wordt gebruik gemaakt van het IHE MHD Document Manifest profiel.
DocumentReference
DocumentReference
De DocumentReference resource wordt gebruikt om metadata van Binary resource(s) op te leveren. De DocumentReference resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/DocumentReference. Er wordt gebruik gemaakt van het IHE MHD Document Reference profiel.
DocumentReference resource kan opgehaald worden bij Zorgplatform. De resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
De DocumentReference resource wordt gebruikt om metadata van Binary resource(s) op te leveren. De DocumentReference resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/DocumentReference. Er wordt gebruik gemaakt van het IHE MHD Document Reference profiel.
DocumentReference resource kan opgehaald worden bij Zorgplatform. De resource kan momenteel alleen opgehaald worden met behulp van een (impliciete) search. Hier wordt op basis van het workflow-id de juiste resultaten bijbehorend bij de workflow terug gegeven.
Binary
Binary
De Binary resource kan gebruikt worden om PDF documenten of CDA documenten uit te wisselen met Zorgplatform. De Binary resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Binary.
Binary resource kan opgehaald worden bij Zorgplatform. De Binary resource wordt opgehaald met een resource-id uit de DocumentReference
De Binary resource kan gebruikt worden om PDF documenten of CDA documenten uit te wisselen met Zorgplatform. De Binary resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Binary.
Binary resource kan opgehaald worden bij Zorgplatform. De Binary resource wordt opgehaald met een resource-id uit de DocumentReference
Flag
Flag
De Flag resource is een melding voor een zorgverlener waarop actie ondernomen moet worden. Dit kan bijvoorbeeld bij een thuismeting van een patiënt die buiten drempelwaarden valt, of bij een chatberichtje van een patiënt waar iemand in de zorginstelling naar moet kijken. De Flag resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Flag. De resource is volgens het profiel ZIB Alert.
De Alert resource kan per instance gestuurd worden naar Zorgplatform voor een nieuwe alert bij een workflow. Zorgplatform maakt een resource-id hiervoor. De Alert resource kan geüpdatet worden wanneer een melding afgehandeld wordt. Het is momenteel enkel mogelijk om de Flag.Status op ‘Inactive’ te zetten. Het resource-id wordt gebruikt om de update per instance uit te voeren.
De Flag resource is een melding voor een zorgverlener waarop actie ondernomen moet worden. Dit kan bijvoorbeeld bij een thuismeting van een patiënt die buiten drempelwaarden valt, of bij een chatberichtje van een patiënt waar iemand in de zorginstelling naar moet kijken. De Flag resource wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/Flag. De resource is volgens het profiel ZIB Alert.
De Alert resource kan per instance gestuurd worden naar Zorgplatform voor een nieuwe alert bij een workflow. Zorgplatform maakt een resource-id hiervoor. De Alert resource kan geüpdatet worden wanneer een melding afgehandeld wordt. Het is momenteel enkel mogelijk om de Flag.Status op ‘Inactive’ te zetten. Het resource-id wordt gebruikt om de update per instance uit te voeren.
AllergyIntolerance
AllergyIntolerance
De AllergyIntolerance resource wordt gebruikt om overgevoeligheden uit te wisselen. De AllergyIntolerance wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/AllergyIntolerance. Er wordt gebruik gemaakt van de ZIB AllergyIntolerance.
De AllergyIntolerance kan binnenkort opgehaald worden bij Zorgplatform
De AllergyIntolerance resource wordt gebruikt om overgevoeligheden uit te wisselen. De AllergyIntolerance wordt uitgewisseld op https://api.zorgplatform.online/fhir/v1/AllergyIntolerance. Er wordt gebruik gemaakt van de ZIB AllergyIntolerance.
De AllergyIntolerance kan binnenkort opgehaald worden bij Zorgplatform
CapabilityStatement
CapabilityStatement
De CapabilityStatement wordt gebruikt om aan te geven welke interacties er op welke FHIR resources ondersteund worden door Zorgplatform. De CapabilityStatement kan binnenkort opgehaald worden bij Zorgplatform.
De CapabilityStatement wordt gebruikt om aan te geven welke interacties er op welke FHIR resources ondersteund worden door Zorgplatform. De CapabilityStatement kan binnenkort opgehaald worden bij Zorgplatform.
Bundle
Bundle
Bij het uitwisselen van meerdere resources, wordt er gebruik gemaakt van de Bundle resource. In de Bundle resource zitten de andere resources zoals omschreven in deze specificaties. Het resultaat van een (impliciete) search van resources is altijd een Bundle resource.
Bij het uitwisselen van meerdere resources, wordt er gebruik gemaakt van de Bundle resource. In de Bundle resource zitten de andere resources zoals omschreven in deze specificaties. Het resultaat van een (impliciete) search van resources is altijd een Bundle resource.
OperationOutcome
OperationOutcome
Waar mogelijk wordt de OperationOutcome gebruikt voor foutsituaties. In plaats van de gevraagde Resource wordt dan de OperationOutcome opgeleverd.
Waar mogelijk wordt de OperationOutcome gebruikt voor foutsituaties. In plaats van de gevraagde Resource wordt dan de OperationOutcome opgeleverd.