Getting started
Basis informatie
BaseUrl: https://openehr-api.test.carebase24.io
Username: {username}
Password: {password}
Voor nu maken we nog gebruik van basic authenticatie, dit zal in de toekomst veranderen.
Quick start
Hieronder staan een aantal calls beschreven om een begin te maken met de OpenEHR API. Voor de volledige specificaties refereren we naar de de OpenEHR API specificaties die te vinden zijn via de navigatie bovenin.
Template uploaden
Allereerst is het nodig om de template te uploaden die je wilt gaan gebruiken. Dat kan via het volgende endpoint: POST https://{baseUrl}/v1/definition/template/adl1.4
EHR gebruiken/aanmaken
Als dit is gedaan is de volgende stap een EHR aanmaken om compositie in aan te maken. Om te kijken of een bepaalde EHR bestaat kan gebruik worden gemaakt van: GET https://{baseUrl}/v1/ehr/{ehr_id}. Als deze nog niet bestaan kan hij worden aangemaakt via POST https://{baseUrl}/v1/ehr. Waarbij in de body optioneel een EHR_STATUS object kan worden meegegeven.
Example endpoint
Om het geheel iets makkelijker te maken hebben we een /example endpoint gemaakt waarmee je een voorbeeld compositie kan genereren: GET https://{baseUrl}/v1/definition/template/adl1.4/:template_id/example. Deze kan je gebruiken als input voor het volgende request, een compositie aanmaken.
Compositie aanmaken
Zodra de EHR is aangemaakt kunnen we deze gebruiken om hier een compositie in op te slaan. Dat kan via: POST https://{baseUrl}/v1/ehr/{ehr_id}/composition. In de body wordt hier een COMPOSITIE object verwacht.
Compositie bijwerken/ophalen/verwijderen
Daarna is het mogelijk om de reeds gemaakt compositie bij te werken, op te halen of te verwijderen. Zie daarvoor de volgende documentatie: