Versions Compared

Key

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

...

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

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

PROVIDING_CONDITION

Request structure

Authorize

  1. Verify the validity of access token

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

  2. Verify that token is not expired

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

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

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

Headers

Наприклад:

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

Request data validation

API paragraph not foundNo

Processing

Service logic

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

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

  2. If submitted, filter list above by status

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

Response structure

See on Apiary

...

Page Properties

HTTP status code

Message

What caused the error

200

 200 Response

  

401

  • unauthorized

Invalid access token

403

  • invalid scopes

Invalid scope(s)