Required parameters are marked with "*"

...

Purpose

...

API paragraph not found

...

This web service is designed to return encounters info by episode_id.

Specification

Logic*

...

Filters

Request structure

...

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

See on Apiary

Authorize

Request to process the request using a token in the headers

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401 

• Check user scopes in order to perform this action (scope = 'episode:read')

  • Return 403 in case invalid scope(s)

Headers

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqMapi{{access_token}}

• API-key:aFBLVTZ6Z2dON1V{{secret}}

Request data validation

...

API paragraph not found

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": [ { "id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0", "origin_episode": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "status": "finised", "date": "2018-08-02", "incoming_referral": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "service_request" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "paper_referral": { "requisition": "1111-2222-3333-4444", "requester_legal_entity_name": "Some clinic", "requester_legal_entity_edrpou": "12345678", "requester_employee_name": "John", "service_request_date": "2018-10-08", "note": "Some notes" }, "inserted_at": "2018-08-02T10:45:16.000Z", "updated_at": "2018-08-02T10:45:16.000Z", "visit": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "visit" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "episode": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "class": { "system": "eHealth/encounter_classes", "code": "inpatient" }, "type": { "coding": [ { "system": "eHealth/encounter_types", "code": "PC" } ] }, "performer": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "Шевченко Олесь Вікторович" }, "reasons": [ { "coding": [ { "system": "eHealth/ICPC2/reasons", "code": "T01" } ] }, { "coding": [ { "system": "eHealth/ICPC2/reasons", "code": "T90" } ] } ], "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 } ], "actions": [ { "coding": [ { "system": "eHealth/ICPC2/actions", "code": "T47" } ] }, { "coding": [ { "system": "eHealth/ICPC2/actions", "code": "T47" } ] } ], "action_references": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "service" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } ], "division": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "division" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "prescriptions": "'Дієта №1, Омепразолу 40 мг 1 раз на добу + амоксициліну 500 мг + метронідазолу 400 мг при необхідності 500 мг або тинідазолу 500 мг 3 рази на добу протягом 1 тижня'", "supporting_info": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "observation" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "diagnostic_report" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" } ], "cancellation_reason": { "coding": [ { "system": "eHealth/episode_closing_reasons", "code": "cured" } ] }, "explanatory_letter": "Діагноз був відмінений у зв'язку з помилкою при виборі пацієнта", "hospitalization": { "admit_source": { "coding": [ { "system": "Health/encounter_admit_source", "code": "default" } ] }, "re_admission": { "coding": [ { "system": "Health/encounter_re_admission", "code": "default" } ] }, "destination": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "division/legal_entity" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "discharge_disposition": { "coding": [ { "system": "Health/encounter_discharge_disposition", "code": "default" } ] }, "discharge_department": { "coding": [ { "system": "Health/encounter_discharge_department", "code": "default" } ] }, "pre_admission_identifier": "12345" } } ], "paging": { "page": 2, "page_size": 50, "total_entries": 1000, "total_pages": 20 } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

HTTP status code	Message	What caused the error
200
401		Access token validation failed
403		Invalid scope