| Info |
|---|
REST API method / Метод REST API (настанова) (| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методу]DRAFT] Get Immunization by id [API-007-004-005-0260] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-007-004-005-0260 |
|---|
Microservices (namespace) | ME |
|---|
Component | EDP |
|---|
Component ID | COM-007-004 |
|---|
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/immunization/get-immunization-by-id |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/immunizations/{{immunization_id}} |
|---|
Scope | immunization:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
This web service is designed to return immunizations info by patient_id, episode_id or encouner_id.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
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 ConfluenceN/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | patient_id | | String | Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
| 2 | immunization_id | | String | Unique immunization identifier | 340b86fd-23f3-4a33-94c5-8ec19d116c33
|
Request structure
...
See on API-specification
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
API-key:{{secret}}
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
...
Access to the resource is also managed by ABAC module
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
...
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"data": {
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"status": "completed",
"not_given": false,
"vaccine_code": {
"coding": [
{
"system": "eHealth/vaccine_codes",
"code": "HepAHepB"
}
]
},
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"date": "2018-10-08T09:46:37.694Z",
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"primary_source": false,
"performer": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": "Галина Олександрівна"
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"manufacturer": "VacinePro Manufacturer",
"lot_number": "AAJN11K",
"expiration_date": "2018-10-08T09:46:37.694Z",
"site": {
"coding": [
{
"system": "eHealth/immunization_body_sites",
"code": "oral"
}
]
},
"route": {
"coding": [
{
"system": "eHealth/vaccination_routes",
"code": "IM"
}
]
},
"dose_quantity": {
"value": 18,
"unit": "mg",
"system": "eHealth/immunization_dosage_units"
},
"explanation": {
"reasons": {
"coding": [
{
"system": "eHealth/reason_explanations",
"code": "immunization_by_calendar"
}
],
"text": "Планове за календарем щеплень"
}
},
"reactions": [
{
"detail": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "observation"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
}
],
"vaccination_protocols": [
{
"dose_sequence": 1,
"description": "Vaccination Protocol Sequence 1",
"authority": {
"coding": [
{
"system": "eHealth/vaccination_authorities",
"code": "WVO"
}
]
},
"series": "Vaccination Series 1",
"series_doses": 2,
"target_diseases": [
{
"coding": [
{
"system": "eHealth/vaccination_target_diseases",
"code": "1857005"
}
]
}
]
}
]
},
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
}
} |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | | |
| 3 | | 401 | | Access token validation failed | |
| 4 | | 403 | | Invalid scope | |
| 5 | Специфічні |
| 6 | | | | | |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...