Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This web service is designed to close an episode.

...

Specification*

Page Properties

Link

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/close-episode

Resource

/api/patients/{{patient_id}}/episodes/{{episode_id}}/actions/close

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

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

...

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

    1. Return 403 in case invalid scope(s)

Validate legal entity

  1. 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 does not correspond to user`s legal_entity"

Validate request

  1. Validate episode.status!= "entered_in_error" or "closed"

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

  2. Validate that "closing_reason" is a valid value from the corresponding dictionary 

    1. $.closing_reason.coding[*].system == "eHealth/episode_cancellation_reasons"

  3. Validate period as Period (consider period.start_date from the episode)

Processing*

  1. Set the status of the episode in "closed"

  2. Set closing_reason in status_reason

  3. Set closing_summary

  4. Set period.end

  5. Create a record in episode.status_history

Response structure*

See on Apiary

...