Overview

This web service is designed to cancel episode in case it was entered in error

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)

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 403 "User is not allowed to perform actions with an episode that belongs to another legal entity"

Validate request

1. Validate episode is not already canceled
   1. ME.patients{patient_id}.episodes{episode_id}.status!="entered_in_error"
      1. in case of error "Episode in <status> can not be canceled"  
2. Validate that "canceleation_reason" is a valid value from the corresponding dictionary 
   1. $.cancellation_reason.coding[*].system == "eHealth/cancellation_reasons"
3. Validate that all encounters created on episode are already canceled
   1.   ME.patients{patient_id}.episodes{episode_id}.encounters{*}.status != `entered_in_error`
      1. in case of error - "Episode can not be canceled while it has not canceled encounters"

Request processing

1. Set the status of the episode in "entered_in_error"
2. Set $.cancellation_reason to ME.patients.episodes.status_reason
3. Set explanatory_letter
4. Create a record in ME.episode.status_history