Purpose
This web service is designed to return episodes by search parameters.
Specification
Link | MEDICAL EVENTS MIS API · Apiary |
Resource | /api/patients/{{patient_id}}/episodes |
Scope | episode:read |
Components | Episode of Care |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
Logic
Use period_from period_to to find episodes that were active in a certain period of time.
Filters
| | | | |
|---|
patient_id | | String | Patient identifier | 70a9e15b-b71b-4caf-8f2e-ff247e8a5677
|
page | | Number | Page number | 2
|
page_size | | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 | 50
|
period_from | | String | | 2017-01-01
|
period_to | | String | | 2017-01-01
|
code | | String | | R80
|
status | | String | | active
|
managing_organization_id | | String | | 80a9e15b-b71b-4caf-8f2e-ff247e8a5677
|
Request structure
See on Apiary
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Verify token is not expired
Check user scopes in order to perform this action (scope = 'episode:write')
Access to the resource is also managed by ABAC module.
Headers
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"type": {
"system": "eHealth/episode_types",
"code": "primary_care"
},
"status": "active",
"name": "Діабет 2018",
"current_diagnoses": [
{
"condition": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/ICPC2/conditions",
"code": "A20"
}
]
},
"role": {
"coding": [
{
"system": "eHealth/diagnosis_roles",
"code": "CC"
}
]
},
"rank": 1
}
],
"diagnoses_history": [
{
"date": "2018-08-02T10:45:16.000Z",
"evidence": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"diagnoses": [
{
"condition": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/ICPC2/conditions",
"code": "A20"
}
]
},
"role": {
"coding": [
{
"system": "eHealth/diagnosis_roles",
"code": "CC"
}
]
},
"rank": 1
},
{
"condition": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/ICPC2/conditions",
"code": "A20"
}
]
},
"role": {
"coding": [
{
"system": "eHealth/diagnosis_roles",
"code": "CC"
}
]
},
"rank": 1
}
]
}
],
"status_history": [
{
"status": "active",
"status reason": {
"coding": [
{
"system": "eHealth/episode_closing_reasons",
"code": "cured"
}
]
},
"inserted_at": "2018-08-02T10:45:16.000Z"
}
],
"managing_organization": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Медікал Солюшнc"
},
"period": {
"start": "2018-08-02T10:45:16.000Z",
"end": "2018-08-03T10:45:16.000Z"
},
"care_manager": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"closing_summary": "Носові шляхи вільні, горло рожеве, температура в нормі",
"status_reason": {
"coding": [
{
"system": "eHealth/episode_closing_reasons",
"code": "cured"
}
]
},
"explanatory_letter": "Епізод був відмінений у зв'язку з помилкою при виборі пацієнта"
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
}Order by inserted_at
In case of searching by code:
select episode where ME.patients.episodes.current_diagnoses[*].code.coding[*].code == code(search param)
Post-processing processes
API paragraph not found
HTTP status codes