Versions Compared

Old Version 19

changes.mady.by.user Serhii.Matiushyn

Saved on

compared with

New Version 20

changes.mady.by.user Serhii.Matiushyn

Saved on

Key

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

Purpose

This service WS must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125038637/care+plan#%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D0%BD%D0%BD%D1%8F-%D1%96%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D1%96%D1%97-%D0%BF%D0%BB%D0%B0%D0%BD%D1%83-%D0%BB%D1%96%D0%BA%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F

Specification

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plans-by-requisition/get-care-plans-by-requisition

Resource

/api/patients/care_plans

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

...

This service must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list

...

Input parameters

Filter

Input parameter

Values

Type

Description

Example

requisition

String

requisition number

0123-4567-89AB-CEIK

Filters

Filter

Values

Type

Description

Example

status

String

Care plan's status

active

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_categories

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

...

  • Verify the validity of access token

    • Return (401, 'unauthorized') in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'unauthorized')

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

    • Return (403, 'invalid scopes') in case of invalid scope(s)

Headers

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

  • api-key:uXhEczJ56adsfh3Ri9SUkc4en

...

API paragraph not found

Processing

...

Service logic

Service returns all Care plans with specified requisition number filtered by status if submitted:

  • Get all care plan by requisition from care_plans collection (MongoDB)

  • If submitted, filter list above by status

  • Render a response according to specification with found Care plan entities. Care plans should be rendered without their activities.

Response structure

See on Apiary

...

Post-processing processes

API paragraph not foundNo

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

 200

 

 

...