Skip to content

API endpoints

Severin Kohler edited this page Apr 17, 2023 · 31 revisions

/person

Required

EhrIds need to be existent in the openEHR platform.

Options

List of ehrIds that you want to be linked or blank for converting every EHR contained in the platform.

Description

If called, generates a link between person and EHR. Depending on the application.yml setting, this can be either boilerplate persons for each EHR. Otherwise, it will map the compositions that are defined in resources/person_data.

/ehr

Required

Before use the ehr needs to be linked using /person.

Options

List of ehrs which compositions are to be tranformed, or blank to convert all the compositions of the ehrs that where linked using the person endpoint.

Description

Automatically loads composition of ehrIds and transforms them into OMOP.

/eras_period

Required

Requires compositions to be contained in order to generate output.

Options

Triggers manually the generation of eras and periods, otherwise can be set using a cronjob in application.yml

Description

Triggers Eos so that it generates the eras and periods tables in the OMOP CDM db.

/ehr/{ehr_id}/composition

Required

Requires the ehrIds to be linked beforehead via /person.

Options

Composition attached as json or xml.

Description

Transforms composition into OMOP CDM.