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

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
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-001-0219
Microservices (namespace)	ME
Component	Care plan
Component ID	COM-007-001
Link на API-специфікацію	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/care-plan/get-care-plan-by-id/get-care-plan-by-id
Resource	{{host}}/api/patients/{{patient_id}}/care_plans/{{id}}
Scope	care_plan:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

Returns care plan details by it's identifier in patient context. To obtain activity list for the Care plan 1f1fa-1f1e6Get Care Plan activities should be used.

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

Logic

Returns care plan details by it's identifier in patient context

Service logic

Service returns specified Care plan related to the patient, but without Care plan’s activities:

Get activity by ID from care_plan_activities collection (MongoDB)
Validate data consistency:
1. Ensure that requested Care plan relates to requested Patient (from URL)
  1. Return 404 ('not found') in case of error
Render a response according to specification

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

eHealth/care_plan_categories

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example
1	patient_id		String	MPI identifier of the patient	`7c3da506-804d-4550-8993-bf17f9ee0402`
2	id		String	Care Plan identifier	`7c3da506-804d-4550-8993-bf17f9ee0403`

Request structure

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

Description of the REST API request structure, example

Expand

title	Example

Code Block

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {{access_token}}			Authorization:Bearer {{access_token}}
3	API-key	{{mis_client_secret}}			API-key:{{mis_client_secret}}

Request data validation

Validate Patient

Get Patient identifier from the URL
Check it exists in DB
1. Return 404 ('not found') in case of error

Validate Care plan

Get Care plan identifier from the URL
Check it exists in DB
1. Return 404 ('not found') in case of error
Check Care plan belongs to patient
1. Return 404 ('not found') in case of error

Validate User

Extract user_id from token.
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

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 (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

Expand

title	Example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "based_on": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "care_plan"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "part_of": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "care_plan"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "category": {
      "coding": [
        {
          "system": "eHealth/care_plan_categories",
          "code": "diabetics"
        }
      ]
    },
    "title": "Diabetics health plan",
    "description": "Some description of the care plan",
    "period": {
      "start": "2018-08-02T10:45:16.000Z",
      "end": "2018-08-02T11:00:00.000Z"
    },
    "supporting_info": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "note": "Some notes",
    "intent": "order",
    "encounter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "addresses": [
      {
        "coding": [
          {
            "system": "eHealth/ICD10_AM/condition_codes",
            "code": "E11.9"
          }
        ]
      }
    ],
    "author": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "contributor": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "terms_of_service": {
      "coding": [
        {
          "system": "PROVIDING_CONDITION",
          "code": "INPATIENT"
        }
      ]
    },
    "inform_with": {
      "auth_method_id": "cc949559-5dfe-420f-ac05-065e443b2cc6"
    },
    "status": "active",
    "subject": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "patient"
            }
          ]
        },
        "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
      }
    },
    "status_history": [
      {
        "status": "active",
        "status_reason": {
          "coding": [
            {
              "system": "eHealth/care_plan_cancel_reasons",
              "code": "some code"
            }
          ]
        },
        "inserted_at": "2018-08-02T10:45:16.000Z",
        "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e"
      }
    ],
    "requisition": "0123-4567-89AB-CEIK",
    "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"
  },
  "urgent": {
    "informing_method_current": {
      "type": "OTP",
      "phone_number": "+38093*****85"
    }
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response
3		401	Invalid access token	Invalid access token
4		401	Unauthorized		Помилка підтвердження
5		403	Access denied	Employee has no Approval on read or write
6		403	Your scope does not allow to access this resource. Missing allowances: care_plan:read	Invalid scope(s)
7	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
8		404	Not found	Request data validation error
9	Специфічні
10		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

List of pages describing technical modules where the method is used

Название	ID ТМ	Статус
/wiki/spaces/ESOZ/pages/17378181218	TM0112
/wiki/spaces/YK/pages/17837688354

Versions Compared

Old Version 1

New Version 2

Key

Properties of a REST API method document

Purpose

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Validate Patient

Validate Care plan

Validate User

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Properties of a REST API method document

Purpose

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Validate Patient

Validate Care plan

Validate User

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used