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.
Create Event Trigger
Create Event Trigger
Authorizations:
bearerAuth
Request Body schema: application/json
object | |
object | |
id | string |
state | string |
Responses
Request samples
- Payload
Content type
application/json
{- "author": {
- "date": "2022-08-25T12:40:26.945Z",
- "email": "alexandru.vidrean.ext@vitagroup.ag",
- "name": "Alexandru Vidrean",
- "organisation": "VitaGroup AG"
}, - "definition": {
- "mode": "AFTER",
- "rules": [
- {
- "diastolic": {
- "then": [
- {
- "logEvent": {
- "channel": "logger",
- "command": "notify"
}
}, - {
- "amqpPublish": {
- "channel": "amqp",
- "command": "publish",
- "exchange": "demo-exchange",
- "routing-key": "*"
}
}, - {
- "kafkaNotify": {
- "command": "publish",
- "channel": "kafka",
- "topic": "myTopic"
}
}
], - "when": {
- "aql": "select e/ehr_id/value as ehr_id, c/uid/value as composition_id, o/data[at0001]/events[at0002]/data[at0003]/items[at0004]/value as diastolic from EHR e contains OBSERVATION o[openEHR-EHR-OBSERVATION.sample_blood_pressure.v1] AND COMPOSITION c where o/data[at0001]/events[at0002]/data[at0003]/items[at0004]/value/magnitude > 140"
}
}
}
]
}, - "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
- Payload
Content type
application/json
{- "author": {
- "date": "2022-08-25T12:40:26.945Z",
- "email": "alexandru.vidrean.ext@vitagroup.ag",
- "name": "Alexandru Vidrean",
- "organisation": "VitaGroup AG"
}, - "definition": {
- "mode": "AFTER",
- "rules": [
- {
- "diastolic": {
- "then": [
- {
- "logEvent": {
- "channel": "logger",
- "command": "notify"
}
}, - {
- "amqpPublish": {
- "channel": "amqp",
- "command": "publish",
- "exchange": "demo-exchange",
- "routing-key": "*"
}
}, - {
- "kafkaNotify": {
- "command": "publish",
- "channel": "kafka",
- "topic": "myTopic"
}
}
], - "when": {
- "aql": "select e/ehr_id/value as ehr_id, c/uid/value as composition_id, o/data[at0001]/events[at0002]/data[at0003]/items[at0004]/value as diastolic from EHR e contains OBSERVATION o[openEHR-EHR-OBSERVATION.sample_blood_pressure.v1] AND COMPOSITION c where o/data[at0001]/events[at0002]/data[at0003]/items[at0004]/value/magnitude > 140"
}
}
}
]
}, - "id": "simple_test_trigger_bp.v1",
- "state": "active"
}
Store tenant
Store tenant
Authorizations:
bearerAuth
Request Body schema: application/json
tenantId | string |
tenantName | string |
object |
Responses
Request samples
- Payload
Content type
application/json
{- "tenantId": "{{$guid}}",
- "tenantName": "cdr-core-sanity-check",
- "tenantProperties": {
- "client-id": "HIP-CDR-EHRbase-Service",
- "host": "{{keycloakUrl}}",
- "realm": "cdr-core-sanity-check"
}
}