Required parameters are marked with "*"

...

Purpose

...

This web service is designed to update existing episode of care for the patient.

Specification

...

Page Properties
Link https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/update-episode Resource /api/patients/{{patient_id}}/episodes/{{episode_id}} Scope episode:write Components Episode of Care Microservices API paragraph not found Protocol type REST Request type PATCH Sync/Async Async Public/Private/Internal Public

Logic

...

This web service is designed to update existing episode of care for the patient

Global and configurable parameters

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402009/Medical+Events+Dictionaries+and+configurations#ALLOWED_EPISODE_CARE_MANAGER_EMPLOYEE_TYPES

Input parameters

Request structure

...

See on Apiary

Example:

Expand
title Request example
Code Block { "name": "Інсулінонезалежний діабет", "care_manager": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } }

Authorize

...

Request to process the request using a token in the headers

...

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation*

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case of error return 401 

• Check user scopes in order to perform this action (scope = 'episode:write')

  • Return 403 in case invalid scope(s)

Headers

• check value of ALLOWContent-Type:application/json

• Authorization:Bearer {{access_token}}

• API-key:{{secret}}

Request data validation

Validate token

• check value of ALLOW_OTHER_LE_EMPLOYEES_TO_MANAGE_EPISODE variable EPISODE variable in charts configuration

  • if its value is equal to false, verify that user’s employees from care_manager belongs to one of the user_id from token

    • in case of error - return 422 ('User is not allowed to perform this action')

  • otherwise, verify that user’s employees from care_manager belongs to the same Legal Entity as author of the episode

    • in case of error - return 422 ('User is not allowed to perfom this action')

Validate

...

• Check user scopes in order to perform this action (scope = 'episode:write')

  1. Return 403 in case invalid scope(s)

Validate legal entity

• Validate episode belongs to the legal entity where the current user works

  • ME.episode.managing_organization==token.client_id

    • in case of error return 422 "Managing_organization in the episode does not correspond to user`s legal_entity"

Validate request

1. ME.episode.status == "active"

   1. in case of error "Episode in status {episode_status} can not be updated"

2. Validate care_manager

   1. $.care_manager.identifier.type.coding.[0].code = "employee"

      1. in case of error return 422 "Submitted code is not allowed for this field"

   2. $.care_manager.identifier.type.coding.[0].system = "eHealth/resources"

      1. in case of error return 422 "Submitted system is not allowed for this field"

   3. $.care_manager.identifier.value must meet the following requirements

      1. PRM.employee.type =

...

1. 1. 1. value from list of employee_types in configuration:
         ALLOWED_EPISODE_CARE_MANAGER_EMPLOYEE_TYPES

         1. in case of error return 409 "Employee submitted as a care_manager is not a not in the list of allowed employee types"

      2. PRM.employee.status= "active"

         1. in case of error return 409 "Employee submitted as a care_manager is not active "

      3. PRM.employee.legal_entity = token.client_id=ME.episode.care_manager.identifier.value

         1. in case of error return 409 "User doesn`t have permitions to set the employee as a care_manager of the episode" 

Processing

...

1. Set patients.episodes.#{id}.care_manager.display_value= ((PRM.parties.first_name + PRM.parties.second_name  + PRM.parties.last_name)

...

1. where PRM.parties.id == PRM.employees.party_id) where PRM.employees.id== $.care_manager.identifier.value

2. Set episodes.managing_organization.display_value = PRM.legal_entities.public_name where ( PRM.legal_entities.id == $.managing_organization.identifier.value) 

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "data": { "status": "pending", "eta": "2018-08-02T10:45:16.000Z", "links": [ { "entity": "job", "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg" } ] }, "meta": { "code": 202, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

Expand
title Response example
Code Block { "meta": { "code": 404, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "error": { "type": "NOT_FOUND", "message": "Patient not found" } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

 202

HTTP status code	Message	What caused the error
202	Response
401		Access token validation failed
403		Invalid scope
404	Patient not found
404409		Validation failed
422		Validation failed