Versions Compared

Old Version 2

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

...

idpage_properties_method_REST API

...

Document type

...

Метод REST API

...

Guideline ID

...

GUI-0011

...

Author

...

@

...

Document version

...

1

...

Document status

...

DRAFT

...

Date of creation

...

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

...

Date of update

...

ХХ.ХХ.ХХХХ (дата зміни версії)

...

Method API ID

...

API-001-001-001-0001

...

Microservices (namespace)

...

MPI

...

Component

...

Auth

...

Component ID

...

COM-001-001

...

Link на API-специфікацію

...

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details

...

Resource

...

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

...

Scope

...

Protocol type

...

Request type

...

Sync/Async

...

Public/Private

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 parameters

Description of input parameters

...

Input parameter

...

Mandatory

...

Type

...

Description

...

Example

...

composition_id

...

 M

...

String ($uuid) (path)

...

Composition object ID

...

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

...

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

...

titleExample

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example

code
Expand
titleExample
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

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
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Care Plan activities [API-007-001-002-0227]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-001-002-0227

Microservices (namespace)

ME

Component

Care plan

Component ID

COM-007-001

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plan-activities/get-care-plan-activities

Resource

{{host}}/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities

Scope

care_plan:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS is designed to return all records about the activities related to the care plan in patient context

Процеси роботи з планом лікування (care plan) | Отримання інформації первинного призначення плану лікування

Logic

Returns all the activities related to the care plan in patient context

Service logic

Service returns activity list within specified Care plan related to the patient:

  1. Get activity list by Care plan identifier from care_plan_activities collection (MongoDB)

  2. Validate data consistency:

    1. Ensure that each requested activity in the list relates to requested Patient and Care Plan (from URL)

      1. Return 404 ('not found') in case of error

  3. Render a response according to specification

Configuration parameters

N/A

Dictionaries

eHealth/care_plan_activity_outcomes

eHealth/ICD10_AM/condition_codes

eHealth/care_plan_activity_goals

eHealth/care_plan_activity_cancel_reasons

eHealth/care_plan_activity_complete_reasons

eHealth/ucum/units

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

MPI identifier of the patient

7c3da506-804d-4550-8993-bf17f9ee0402

2

care_plan_id

 

String

Care Plan identifier

9183a36b-4d45-4244-9339-63d81cd08d9c

Request structure

See on API-specification

Expand
titleExample
Code Block
Headers
Headers 
Request data validation
Authorize
  • Verify the validity of access token
    • Return (401, 'Invalid access token') in case of validation fails
  • Verify that token is not expired
    • in case of error - return (401, 'Invalid access token')
  • Check user scopes in order to perform this action (scope = 'care_plan:read')
    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: care_plan:read') in case of invalid scope(s)
Request to process the request using a token in the headers
Validate Patient
  • Get Patient identifier from the URL
  • Check it exists in DB
    • Return 404 ('not found') in case of error
Validate Care plan
  1. Get Care plan identifier from the URL
  2. Check it exists in DB
    1. Return 404 ('not found') in case of error
Validate User
  1. Extract user_id from token.
  2. Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:
    1. has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)
      1. Return 403 ('Access denied') in case employee has no Approval on read or write
    2. has an active declaration with the patient
      1. Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true
    3. user belongs to the legal entity where the care_plans were created
      1. Return 403 ('Access denied') in case employee belongs to another legal_entity and none of conditions above is true
Processing
N/A
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "75a5d991-0bf7-476f-b3cf-bec73f044b2e",
      "author": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "care_plan": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "detail": {
        "kind": "service_request",
        "product_reference": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "service"
                }
              ],
              "text": ""
            },
            "value": "97d57238-ffbe-4335-92ea-28d4de117ea3"
          }
        },
        "reason_code": [
          {
            "coding": [
              {
                "system": "eHealth/ICD10_AM/condition_codes",
                "code": "X85"
              }
            ]
          }
        ],
        "reason_reference": [
          {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "condition"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            }
          }
        ],
        "goal": [
          {
            "coding": [
              {
                "system": "eHealth/care_plan_activity_goals",
                "code": "diabetes_treatment"
              }
            ]
          }
        ],
        "quantity": {
          "value": 13,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        },
        "scheduled_timing": {
          "event": [
            "2018-08-02T10:45:16Z"
          ],
          "repeat": {
            "bounds_duration": {
              "value": 10,
              "comparator": ">",
              "unit": "доба",
              "system": "eHealth/ucum/units",
              "code": "day"
            },
            "count": 10,
            "count_max": 20,
            "duration": 15,
            "duration_max": 25,
            "duration_unit": "day",
            "frequency": 1,
            "frequency_max": 4,
            "period": 1,
            "period_max": 3,
            "period_unit": "day",
            "day_of_week": [
              "mon"
            ],
            "time_of_day": [
              "16:00:00"
            ],
            "when": [
              "WAKE"
            ],
            "offset": 20
          },
          "code": {
            "coding": [
              {
                "system": "TIMING_ABBREVIATION",
                "code": "Q4H"
              }
            ]
          }
        },
        "location": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "division"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "performer": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "employee"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "daily_amount": {
          "value": 13.5,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        },
        "description": "Some activity description",
        "do_not_perform": false,
        "program": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "medical_program"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "status": "completed",
        "status_reason": {
          "coding": [
            {
              "system": "eHealth/care_plan_activity_cancel_reasons",
              "code": "some code"
            }
          ]
        },
        "remaining_quantity": {
          "value": 12,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        }
      },
      "outcome_reference": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "encounter"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        }
      ],
      "outcome_codeable_concept": [
        {
          "coding": [
            {
              "system": "eHealth/care_plan_activity_outcomes",
              "code": "some code"
            }
          ]
        }
      ],
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ]
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
3
401
Unauthorized
Помилка підтвердження
4
Специфічні
5
422
Only for active MPI record can be created medication request!
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
...
200
 Response
 
3
401
Invalid access token
Invalid access token
4
403
Access denied
Employee has no Approval on read or write
5
403
Your scope does not allow to access this resource. Missing allowances: care_plan:read
Invalid scope(s)
6
404
Not found
Request data validation error
7
Специфічні
8
Post-processing processes
N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...