| 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
...
Logic
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - immunization(parameter “id“ in request)
eHealth/resources - episode (parameter “status“ in response)
eHealth/vaccine_codes(parameter “vaccine_code“ in request/response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/resources - employee (parameter “performer“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/immunization_body_sites (parameter “site“ in response)
eHealth/vaccination_routes (parameter “route“ in response)
eHealth/immunization_dosage_units (parameter “dose_quantity:system“ in response)
eHealth/reason_explanations (parameter “explanation:reasons“ in response)
eHealth/reason_not_given_explanations (parameter “explanation:reasons_not_given“ in response)
eHealth/resources - observation (parameter “reactions“ in response)
eHealth/vaccination_authorities(parameter “vaccination_protocol:authority“ in response)
eHealth/vaccination_target_diseases(parameter “vaccination_protocol:authority“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | id | M | String | Unique immunization identifier |
|
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
...
Headers
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Validate token
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Validate scopes
Check user scopes in order to perform this action (scope = 'patient_summary:read')
Return 403 in case invalid scope(s)
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
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
...
...
| 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 |
| 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)