Info |
---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
...
Page Properties | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This web service is designed to return conditions by 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)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
...
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/report_origins (parameter “patient“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/ICD10/condition_codes(parameter “code“ in response)
eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)
eHealth/condition_verification_statuses (parameter “verification_status“ in response)
eHealth/condition_severities (parameter “severity“ in response)
eHealth/body_sites(parameter “body_sites“ in response)
eHealth/condition_stages(parameter “body_sites“ in response)
eHealth/ICPC2/reasons(parameter “evidences:codes“ in response)
eHealth/resources - observations (parameter “evidences:details“ in response)
Input parameters
...
Headers
Key
Value
Mandatory
Description
Example
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
Authorization
Bearer mF_9.B5f-4.1JqM
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | 2 |
Request structure
See on API-specification
...
title | Example |
---|
patient_id | M | String | Unique MPI patient identifier |
| |
2 | code |
| String | Condition code |
|
3 | onset_date_time_from |
| String |
|
|
4 | onset_date_time_to |
| String |
|
|
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
...
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 API
Response structure examples
...
See on API-specification
...
title | Example |
---|
...
...
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
"primary_source": true,
"asserter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": ""
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/ICD10/condition_codes",
"code": "K87"
}
]
},
"clinical_status": "active",
"verification_status": "provisional",
"severity": {
"coding": [
{
"system": "eHealth/condition_severities",
"code": "55604002"
}
]
},
"body_sites": [
{
"coding": [
{
"system": "eHealth/body_sites",
"code": "head"
}
]
}
],
"onset_date": "2018-10-08T09:46:37.694Z",
"asserted_date": "2018-10-08T09:46:37.694Z",
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"stage": {
"summary": {
"coding": [
{
"system": "eHealth/condition_stages",
"code": "14803004"
}
]
}
},
"evidences": [
{
"codes": [
{
"coding": [
{
"system": "eHealth/ICPC2/reasons",
"code": "169068008"
}
]
}
],
"details": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "observation"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
]
}
]
}
],
"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 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)