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

Authorizations:

bearerAuth

query Parameters

active

string

Default: "false"

Responses

Response samples

200

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"id": "string",
"language": {"original_language": "string"
},
"state": "active",
"author": {"date": "2019-08-24T14:15:22Z",
"name": "string",
"email": "string",
"organisation": "string"
},
"definition": {"rules": [{"name": "string",
"when": {"type": "string",
"expression": "string"
},
"then": [{"name": "string",
"type": "SPEL",
"arguments": {"property1": "string",
"property2": "string"
}
}
]
}
],
"data_type": "EHR_STATUS",
"event_type": ["CREATE"
],
"pre_condition": ["string"
]
}
}
]

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

Payload

Content type

application/json

{"id": "composition_trigger_v1",
"language": {"original_language": "ISO_639-1::en"
},
"state": "active",
"author": {"date": "2021-11-02T00:00:00.000+00:00",
"name": "Me",
"email": "info@vitagroup.ag",
"organisation": "VitaGroup AG"
},
"definition": {"mode": "AFTER",
"data_type": "COMPOSITION",
"event_type": ["CREATE",
"UPDATE",
"DELETE"
],
"rules": [{"high diastolic": {"when": {"aql": "select c/uid/value as diastolic from EHR e contains COMPOSITION c"
},
"then": [{"notify": {"command": "publish",
"channel": "amqp",
"exchange": "ex",
"routing-key": "ex"
}
},
{"log": {"command": "notify",
"channel": "logger"
}
}
]
}
}
],
"pre_condition": [ ]
}
}

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

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"id": "string",
"language": {"original_language": "string"
},
"state": "active",
"author": {"date": "2019-08-24T14:15:22Z",
"name": "string",
"email": "string",
"organisation": "string"
},
"definition": {"rules": [{"name": "string",
"when": {"type": "string",
"expression": "string"
},
"then": [{"name": "string",
"type": "SPEL",
"arguments": {"property1": "string",
"property2": "string"
}
}
]
}
],
"data_type": "EHR_STATUS",
"event_type": ["CREATE"
],
"pre_condition": ["string"
]
}
}
]

Delete Event Trigger By Trigger-UUID

Authorizations:

bearerAuth

path Parameters

id

required

string

Example: c1246a5c-07e8-4601-a5b5-7eab501d3bd9

Responses

Multi tenant

Get tenants

Authorizations:

bearerAuth

Responses

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"
}
}

Delete Tenant

Delete Tenants

Authorizations:

bearerAuth

path Parameters

tenant_id

required

string

Example: {{$guid}}

Responses

Compensation

Rollback

Authorizations:

bearerAuth

path Parameters

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

HIP EHRbase (2.0.0)

Event Trigger

Get All Event Triggers

Authorizations:

query Parameters

Responses

Response samples

Create Event Trigger

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Activate Event Trigger

Authorizations:

path Parameters

query Parameters

Responses

Get Event Trigger By Trigger-Id Or Trigger-UUID

Authorizations:

path Parameters

Responses

Response samples

Delete Event Trigger By Trigger-UUID

Authorizations:

path Parameters

Responses

Multi tenant

Get tenants

Authorizations:

Responses

Store tenant

Authorizations:

Request Body schema: application/json

Responses

Request samples

Delete Tenant

Authorizations:

path Parameters

Responses

Compensation

Rollback

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required