| Info |
|---|
| Note |
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
Request structure
See on API-specification
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer mF_9.B5f-4.1JqM
...
Authorization:Bearer mF_9.B5f-4.1JqM
Request data validation
Authorize
Request to process the request using a token in the headers
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on Apiary
See on API-specification
...
| title | Example |
|---|
...
Dictionaries
eHealth/resources - service_request (parameter “based_on“ in response)
eHealth/diagnostic_report_statuses (parameter “status“ in request / response)
eHealth/resources - service (parameter “code“ in request / response)
eHealth/diagnostic_report_categories (parameter “category“ in response)
eHealth/ICD10_AM/condition_codes (parameter “conclusion_code“ in response)
eHealth/resources - specimen (parameter “specimens“ in response)
eHealth/resources - equipment (parameter “used_references“ in response)
eHealth/resources - employee (parameter “recorded_by“ in response)
eHealth/resources - encounter (parameter “encounter“ in response)
eHealth/resources - episode (parameter “origin_episode“ in response)
eHealth/resources - division (parameter “division“ in response)
eHealth/resources - legal_enity (parameter “managing_organization“ in response)
eHealth/resources - employee (parameter “performer“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/resources - employee (parameter “results_interpreter“ in response)
eHealth/cancellation_reasons(parameter “cancellation_reason“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | issued_from |
| String |
|
|
| 3 | issued_to |
| String |
|
|
| 4 | code | String | Service code |
| |
| 5 | page |
| Number | Page number |
|
| 6 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||||
| 2 | 200
| 200 |
| Response |
| |||||||
| 3 | Специфічні | 4 |
| 401 |
| Access token validation failed |
| |||||
| 4 |
| 401 |
| Access token expired |
| |||||||
| 5 |
| 403 |
| Invalid scope |
| |||||||
| 6 | 404 |
| Patient not found | |||||||||
| 7 | Специфічні | |||||||||||
Post-processing processes
Description of actions performed on data after processingN/A (Not applicable)
Technical modules where the method is used
List of pages describing technical modules where the method is used
...
N/A (Not applicable)