Skip to main content
API docs by Redocly

EHRbase Enterprise (1.0.0)

Download OpenAPI specification:Download

HIP EHRbase Enterprise operations that are not part of the OSS, but are part of enterprise feature. Requires authorization with a tenant user upfront.

Event Trigger

Get All Event Triggers

Get All Event Triggers

Authorizations:
bearerAuth

Responses

Create Event Trigger

Create Event Trigger

Authorizations:
bearerAuth
Request Body schema: application/json
object
object
id
string
state
string

Responses

Request samples

Content type
application/json
{
  • "author": {
    },
  • "definition": {
    },
  • "id": "simple_test_trigger_bp.v1",
  • "state": "active"
}

Activate Event Trigger

Activate Event Trigger

Authorizations:
bearerAuth
path Parameters
event_trigger_uuid
required
string
Example: 06345e0e-3b79-4dba-8c99-c0e632d328bf
query Parameters
activate
string
Example: activate=false
Request Body schema: application/json
object
object
id
string
state
string

Responses

Request samples

Content type
application/json
{
  • "author": {
    },
  • "definition": {
    },
  • "id": "simple_test_trigger_bp.v1",
  • "state": "active"
}

Get Event Trigger

Get Event Trigger

Authorizations:
bearerAuth
path Parameters
event_trigger_id
required
string
Example: c1246a5c-07e8-4601-a5b5-7eab501d3bd9

Responses

Delete Event Trigger

Delete Event Trigger

Authorizations:
bearerAuth
path Parameters
event_trigger_id
required
string
Example: c1246a5c-07e8-4601-a5b5-7eab501d3bd9

Responses

Multi tenant

Get tenants

Get tenants

Authorizations:
bearerAuth

Responses

Store tenant

Store tenant

Authorizations:
bearerAuth
Request Body schema: application/json
tenantId
string
tenantName
string
object

Responses

Request samples

Content type
application/json
{
  • "tenantId": "{{$guid}}",
  • "tenantName": "cdr-core-sanity-check",
  • "tenantProperties": {
    }
}

Delete Tenant

Get tenants

Authorizations:
bearerAuth
path Parameters
tenant_id
required
string
Example: {{$guid}}

Responses

Compensation

Rollback

Rollback

Authorizations:
bearerAuth
path Parameters
ehr_id
required
string
Example: {{ehrId}}
contribution_id
required
string
Example: c25c5c9c-0463-4ce3-9753-fb6732827859

Responses