Versions Compared

Key

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

...

...

...

...

Overview

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

Note:

  1. Encounter cannot be created without an episode. Corresponding episode must be in the system or must be created before submitting encounter package.

  2. Episode is created without diagnoses. Diagnoses will be automatically copied from the last submitted encounter that references the episode.

Specification

Apiary

Authorization

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)

Validate user

  • If BLOCK_UNVERIFIED_PARTY_USERS is true, then check user's party data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

    • in case not match - return 403 ("Access denied. Party is not verified")

Request validation

  1. Validate legal entity from token  

    1. legal_entities.type in me_allowed_transactions_le_types and legal_entities.status =='active'

  2. 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"

  3. Validate episode id is unique

    1. $.id is unique 

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

  4. Validate request according to Apiary

    1. in case of error return 422

  5. Validate type

    1. according to legal entity type: Medical Events Dictionaries and configurations#legal_entity_episode_types

      1. in case of error return 409 "Episode type <type> is forbidden for your legal entity type"

    2. according to employee type: Medical Events Dictionaries and configurations#employee_episode_types

      1. in case of error return 409 "Episode type <type> is forbidden for your employee type"

  6. 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"

  7. 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"

  8. 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 = value from list of employee_types in configuration: Medical Events Dictionaries and configurations#ALLOWED_EPISODE_CARE_MANAGER_EMPLOYEE_TYPES

        1. in case of error return 409 "Employee submitted as a care_manager is 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

        1. in case of error return 409 "Employee #{employee_id} doesn't belong to your legal entity"

    4. $.care_manager.identifier.value belongs to one of the user’s employee

      1. in case of error return 422 "<use the same error msg like on encounter.performer>"

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

...