Composities plaatsen

Composities plaatsen#

Compositie maken#

Er zijn veel verschillende manieren om composities te maken. In principe kan je deze genereren uit de template, maar dat te veel werk voor nu. Er zijn verschillende tools die voorbeelden kunnen genereren:

  • Cabolabs

  • openEHR SDK

  • VS Code

  • MedBlocks

  • EHRBase example

  • EHRScape example

  • …

De EHRBase API kan ook een voorbeeld compositie genereren uit een template. Deze API ondersteund op dit moment echter in Swagger alleen XML /definition/template/adl1.4/{template_id}/example. Op zich is XML een prima format, maar het is niet heel fijn om met de hand aan te passen. Voor deze workshop zullen we daarom kiezen uit het FLAT format. EHRBase ondersteund dit format in Swagger op dit moment alleen in de (deprecated) EhrScape API /rest/ecis/v1/template/{templateId}/example.

In een API client is het mogelijk om de header aan te passen en dan kan de openEHR API wel gebruik maken van het FLAT format. Hiervoor moet accept: application/openehr.wt.flat.schema+json worden meegegeven in de header.

_images/template-example-bruno.png

Fig. 23 Template voorbeelden genereren in Bruno.#

_images/template-example-swagger.png

Fig. 24 Template voorbeelden genereren in Swagger UI.#

import requests

template_id = "workshop-example"
url = f"http://localhost:8080/ehrbase/rest/ecis/v1/template/{template_id}/example"

querystring = {"format":"FLAT"}

response = requests.get(url, params=querystring)

print(response.json())

TBD

Opdracht

Genereer een template voorbeeld met de EhrScape API of de openEHR API. Gebruik dit voorbeeld vervolgens om een fictief voorbeeld te maken voor de casus. Pas de waarden in de datavelden aan voor een realistisch voorbeeld.

Compositie plaatsen#

Het plaatsen van een compositie kan via de /rest/openehr/v1/ehr/{ehr_id}/composition endpoint. Een compositie wordt altijd geplaatst in een EHR, dus als onderdeel van de endpoint moet men een EHR ID meegeven. Ben je de EHR ID kwijt? Dan kan je deze opzoeken door toe zoeken met subject_id en subject_namespace. Als je deze niet hebt, ben je aangewezen op de Query API. De EhrScape API geeft de compositie ID terug via de URL in de respons. In Swagger kan men geen FLAT composities plaatsen. In een API client wel, en hiervoor moet format=FLAT meegegeven worden in de query parameters.

_images/composition-post-bruno.png

Fig. 25 Composities uploaden in Bruno via de openEHR API.#

_images/composition-post-swagger.png

Fig. 26 Composities uploaden in de Swagger UI via de EhrScape API.#

import json
import requests

ehr_id = ""
url = f"http://localhost:8080/ehrbase/rest/openehr/v1/ehr/{ehr_id}/composition"

querystring = {"templateId":"workshop-example","format":"FLAT"}

with open('composition.json', 'r') as file:
    payload = json.load(file)

headers = {"content-type": "application/json"}

response = requests.post(url, json=payload, headers=headers, params=querystring)

print(response.json())

Zie https://docs.ehrbase.org/docs/EHRbase/openEHR-Introduction/Load-Data#ehrbase-client-library

Opdracht

Plaats de compositie in de EHR door gebruik te maken van de openEHR API. Bewaar de identifier die je terugkrijgt na het plaatsen.