...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This web service is designed to return detailed information of the patient’s Allergy Intolerancesallergy intolerances.
Logic
N/A (Not applicable)
...
Dictionaries
eHealth/resources - patient (parameter “patient_id“ in request)
eHealth/resources - allergy_intolerance (parameter “id“ “id“ in request)
eHealth/allergy_intolerance_clinical_statuses (parameter “clinical_status“ in response)
eHealth/allergy_intolerance_verification_statuses (parameter “verification_status“ in response)
eHealth/allergy_intolerance_types (parameter “type“ “type“ in response)
eHealth/allergy_intolerance_categories (parameter “category“ “category“ in response)
eHealth/allergy_intolerance_criticalities (parameter “criticality“ “criticality“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/allergy_intolerance_codes(parameter “code“ in request / response)
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
...
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | id | M | String | Unique allergy intolerance identifier |
|
Request structure
See on API-specification
Headers
See on Headers
...
Authorize
Request to process the request using a token in the headers
Request data validation
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 allergy intolerance exists in MongoDB
In case of error return 404 not found
Check allergy intolerance belongs to patient
In case of error return 404 not found
...
Response structure examples
See on API-specification
...
...
| Code Block |
|---|
{
"data": {
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"clinical_status": "active",
"verification_status": "confirmed",
"type": "allergy",
"category": "food",
"criticality": "low",
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/resources",
"code": "patient"
}
]
},
"onset_date_time": "2016-01-01T00:00:00.000Z",
"asserted_date": "2018-08-02T10:45:00.000Z",
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"primary_source": true,
"asserter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": ""
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"last_occurrence": "2018-07-02T00:00:00.000Z"
},
"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 | 401 | Access token validation failed | ||||
| 4 |
| 401 |
| Access token expired |
| |
| 5 |
| 403 |
| Invalid scopeYour scope does not allow to access this resource. Missing allowances: patient_summary:read | Forbiden | |
| 6 | 404 |
| Not found | |||
| 7 | Специфічні | |||||
...