You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
Properties of a REST API method document
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 parameter | Mandatory | Type | Description | Example |
|---|
| 1 | | | | | |
| 2 | | | | | |
Request structure
See on API-specification
| Key | Value | Mandatory | Description | Example |
|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | 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
Example
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"status": "completed",
"description": "Some description of the clinical impression",
"code": {
"coding": [
{
"system": "eHealth/clinical_impression_patient_categories",
"code": "insulin_1"
}
]
},
"encounter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"effective_date_time": "2018-08-02T10:45:16.000Z",
"assessor": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"previous": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "clinical_impression"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"problems": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
}
],
"summary": "Some summary",
"findings": [
{
"item_reference": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"basis": "Some basis"
}
],
"supporting_info": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode_of_care"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
}
],
"note": "Some note",
"inserted_at": "2018-08-02T10:55:00.000Z",
"updated_at": "2018-08-02T10:55:00.000Z"
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
}
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | | |
| 3 | Специфічні |
| 4 | | | | | |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used