REST API method / Метод REST API (настанова) (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-0223
Microservices (namespace)	ME
Component	Care plan
Component ID	COM-007-001
Link на API-специфікацію	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/care-plan/complete-care-plan/complete-care-plan
Resource	{{host}}/api/patients/{{patient_id}}/care_plans/{{id}}/actions/complete
Scope	care_plan:write
Protocol type	REST
Request type	PATCH
Sync/Async	Async(def)/Sync
Public/Private	Public

...

Update Care plan status (update also updated_at, updated_by)
Set $.status_history

Configuration parameters

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

Dictionaries

eHealth/care_plan_complete_reasons

Input parameters

...

parameters

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

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example API-specification

Expand

title	Example

Code Block
{ "status_reason": { "coding": [ { "system": "eHealth/care_plan_complete_reasons", "code": "some code" } ] } }

...

	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}}

...

token}}
3	API-key	{{mis_client_secret}}			API-key:{{mis_client_secret}}

Request data validation

Authorize

Verify the validity of access token
1. Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
1. in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'care_plan:write')
1. Return (403, 'Your scope does not allow to access this resource. Missing allowances: care_plan:write') in case of invalid scope(s)

Request to process the request using a token in the headers

Validate legal entity

Extract client_id from token
Check legal entity status is ACTIVE
1. In case of error - return 409 ('Legal entity must be ACTIVE')
Check legal entity type in me_allowed_transactions_le_types config parameter
1. in case of error - return 409 ('Action is not allowed for the legal entity type')

...

Get Care plan activities
Check all activities has final status.
1. Return 409 (Care plan has scheduled or in-progress activities) in case if activities not in final statuses found
Check that Care plan has at least one activity in status=completed
1. Return 409 ('Care plan has no one completed activity') in case if completed activities 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 (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example

Expand

title	Example

Code Block

{
  "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"
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

...

6

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		201	use payload from response	sync
3		202202	use Get job details to get processing result. Response payload will be returned in the job details	async: default method
4		401	Invalid access token	validation fails token is expired	5	401	Unauthorized		Помилка підтвердження	token is expired
5		403	Access denied	invalid scope(s)
76		403	Your scope does not allow to access this resource. Missing allowances: care_plan:write	employee has no Approval on write
87	1000		404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок	9	404	not found	The submitted Care Plan is not related to the Patient
108		409	Action is not allowed for the legal entity type
119		409	Care plan in status <cancelled/completed> cannot be cancelled	Validation error
1210		409	Care plan has scheduled or in-progress activities
1311		409	Care plan has no one completed activity
1412		409	Legal entity must be ACTIVE
1513		422	value is not allowed in enum	Validation error
1614	Специфічні
17		422	Only for active MPI record can be created medication request!	15

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 4

New Version 5

Key

Properties of a REST API method document

Configuration parameters

Dictionaries

Input parameters

parameters

Request structure

Request data validation

Authorize

Validate legal entity

Processing

Response structure examples

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Properties of a REST API method document

Configuration parameters

Dictionaries

Input parameters

parameters

Request structure

Request data validation

Authorize

Validate legal entity

Processing

Response structure examples

Post-processing processes

Technical modules where the method is used