Skip to main content
API docs by Redocly

HIP EHRbase (2.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
query Parameters
active
string
Default: "false"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Event Trigger

Create Event Trigger

Authorizations:
bearerAuth
Request Body schema: application/json
required
uuid
string <uuid>
id
string
object (Languange)
state
string
Enum: "active" "inactive"
object (Author)
object (Definition)

Responses

Request samples

Content type
application/json
{
  • "id": "composition_trigger_v1",
  • "language": {
    },
  • "state": "active",
  • "author": {
    },
  • "definition": {
    }
}

Activate Event Trigger

Activate Event Trigger

Authorizations:
bearerAuth
path Parameters
uuid
required
string <uuid>
Example: 06345e0e-3b79-4dba-8c99-c0e632d328bf
query Parameters
activate
required
boolean

Responses

Get Event Trigger By Trigger-Id Or Trigger-UUID

Get Event Trigger By Trigger-Id Or Trigger-UUID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Event Trigger By Trigger-UUID

Delete Event Trigger By Trigger-UUID

Authorizations:
bearerAuth
path Parameters
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

Delete 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