1 Purpose
2 Specification
3 Logic
4 Filters
5 Request structure
6 Authorize
7 Headers
8 Processing
- 8.1 Logic WS
9 Response structure
10 HTTP status codes

Purpose

This WS is designed to return Innm list by filters.

Specification

Link	API paragraph not found
Resource	/innms
Scope	innm: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 Innms. 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.

Filters

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
id	String	Innm Identifier	`7124259c-eeb1-4cbb-acac-ada2162675d1`
sctid	String	Innm CNOMED code	`52574003`
name	String	Innm local name	`Аміодарон`
name_original	String	Innm original name	`Amiodarone`
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

Processing

Logic WS

Verify the validity of access token
Check user scopes in order to perform this action (scope = 'innm:read')
Search Innm by filters in payload
SELECT * FROM innms I
WHERE (I.id == $.id OR $.id IS NULL)
    AND (I.sctid == $.sctid OR $.sctid IS NULL)
    AND (I.name LIKE `%$.name%` OR $.name IS NULL)
    AND (I.name_original LIKE `%$.name_original%` OR $.name_original IS NULL)

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "c7d52544-0bd4-4129-97b0-2d72633e0490",
      "sctid": "52574003",
      "name": "Аміодарон",
      "name_original": "Amiodarone",
      "is_active": true
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200

E-Health

Get INNM List