Versions Compared

Key

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

...

Specification

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plan-activities/get-care-plan-activities MEDICAL EVENTS MIS API · Apiary

Resource

/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities

Scope

care_plan:read

Components

Care plan

Microservices

me/api-medical-events

me/event-consumer

me/kafka-consumer

il/api(rpc)

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Public

...

Returns all the activities related to the care plan in patient context

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

MPI identifier of the patient

7c3da506-804d-4550-8993-bf17f9ee0402

care_plan_id

String

Care Plan identifier

9183a36b-4d45-4244-9339-63d81cd08d9c

Filters

Filter

Values

Type

Description

Example

author

String

author of the activity

9183a36b-4d45-4244-9339-63d81cd08d9c

kind

  • service_request

  • medication_request

Enum

kind of the activity

service_request

status

String

Care plan activity status

scheduled

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

Dictionaries

eHealth/care_plan_activity_outcomes

...

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}

...

  • Get Patient identifier from the URL

  • Check it exists in DB

    • Return 404 ('not found') in case of error

Validate Care plan

  1. Get Care plan identifier from the URL

  2. Check it exists in DB

    1. Return 404 ('not found') in case of error

Validate User

  1. Extract user_id from token.

  2. Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:

    1. has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)

      1. Return 403 ('Access denied') in case employee has no Approval on read or write

    2. has an active declaration with the patient

      1. Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true

    3. user belongs to the legal entity where the care_plans were created

      1. Return 403 ('Access denied') in case employee belongs to another legal_entity and none of conditions above is true

Processing

Service logic

Service returns activity list within specified Care plan related to the patient:

  1. Get activity list by Care plan identifier from care_plan_activities collection (MongoDB)

  2. Validate data consistency:

    1. Ensure that each requested activity in the list relates to requested Patient and Care Plan (from URL)

      1. Return 404 ('not found') in case of error

  3. Render a response according to specification

Response structure

See on Apiary

...