Purpose

...

This WS is designed to return INNM Dosages list by filters.

Specification

...

Page Properties
Link API paragraph not found Resource /innm_dosages Scope innm_dosage:read Components Drugs and Program medications Microservices API paragraph not found Protocol type REST Request type GET Sync/Async Sync Public/Private/Internal Internal. NHS Admin

Logic

...

Use this method to obtain list of INNM Dosage. If you want to reduce amount of data that is going trough your application, use filter and show only INNMs is interested in current UI section.

...

Filter	Values	Type	Description	Example
id		String	INNM Dosage Identifier	7124259c-eeb1-4cbb-acac-ada2162675d1
name		String	Innm local name	Аміодарон
form		String	Dictionary MEDICATION_FORM	PILL
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

Request structure

...

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

...

API paragraph not found

Processing

...

Logic WS

1. Verify the validity of access token

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

3. Search INNM Dosagess by filters in payload

   SELECT * FROM medications M

   WHERE AND M.type == INNM_Dosage

       AND (M.id == $.id OR $.id IS NULL)

       AND (M.form == $.form OR $.form IS NULL)

       AND (M.name LIKE `%$.name%` OR $.name IS NULL)

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": [ { "id": "09b2bffb-699a-43c0-bc9a-5066d9b9b5a8", "name": "Амідарон", "form": "PILL", "ingredients": [ { "id": "1349a693-4db1-4a3f-9ac6-8c2f9e541982", "name": "Амідарон", "dosage": { "numerator_unit": "MG", "numerator_value": 200, "denumerator_unit": "PILL", "denumerator_value": 1 }, "is_primary": true } ], "is_active": true, "inserted_at": "2017-04-20T19:14:13Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e", "updated_at": "2017-04-20T19:14:13Z", "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  200

...