Overview

This web service allows to create a new episode of care for a patient.

Specification

Apiary

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 

Validate scopes

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

  1. Return 403 in case invalid scope(s)

Request validation

1. Validate patient status

   1. Medical_data status for this patient must be in "active" status

      1. in case of error return 409 - "Patient is not active"

2. Validate episode id is unique

   1. $.id is unique 

      1.  in case of error return 422 - "Episode with such id already exists"

3. Validate that episode number is unique 

   1. $.number is unique 

      1. in case of error return 409 - "Episode with such number already exists. Episode number must be unique"

4. Validate request according to JSON Schema LINK

   1. in case of error return 422

5. Validate type according to legal entity type: https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402009/Medical+Events+Dictionaries+and+configurations#legal_entity_episode_types

6. Validate status= "active" - resolved by JSON schema

7. Validate managing_organization

   1. Only one item is allowed in coding array

      1. in case of error return 422 "Only one item is allowed in "coding" array " 

   2. $.managing_organization.identifier.type.coding.[0].code = "legal_entity"

      1. in case of error return 422 "Only legal_entity could be submitted as a managing_organization"

   3. $.managing_organization.identifier.value = token.client_id

      1. in case of error return 422 "Managing_organization does not correspond to user`s legal_entity"

   4. $.managing_organization.identifier.type.coding.[0].system = "eHealth/resources"

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

8. Validate period

   1. $.period.start <= current_date

      1. in case of error return 422 - "Start date of episode must be in past"

   2. $.period.end is absent

      1. in case of error return 422 - "End date of episode could not be submitted on creation"

9. Validate care_manager

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

      1. in case of error return 422 "Only employee could be submitted as a care_manager"

   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 = "DOCTOR" OR "SPECIALIST"

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

      2. PRM.employee.status= "active"

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

      3. PRM.employee.legal_entity = token.client_id

         1. in case of error return 409 "User can create an episode only for the doctor that works for the same legal_entity"

Error example:

Request Processing

1. Set episodes.care_manager.display_value = ((PRM.parties.first_name + PRM.parties.second_name  + PRM.parties.last_name) 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) 

3. Create a record in status_hstr