ЕСОЗ - публічна документація

Create INNM

Owned by Edward Voloshin (Unlicensed)
Last updated: Feb 28, 2023 by Oleksandr Zhuk (SoE eHealth)
1 min read

Purpose

This WS is designed to create new Innm (post).

 

Specification

Link

API paragraph not found

Resource

/innms

Scope

innm:write

Components

Drugs and Program medications

Microservices

API paragraph not found

Protocol type

REST

Request type

POST

Sync/Async

Sync

Public/Private/Internal

Internal. NHS Admin

 

Logic

This method is used to create new innm. Fields descriptions are listed in request Example view.

 

Request structure

See on Apiary

Example:

{ "sctid": "52574003", "name": "Аміодарон", "name_original": "Amiodarone" }

 

Authorize

  1. Verify the validity of access token

  2. Check user scope (scope = 'innm:write') in order to perform this action

    1. In case error - generate 401 response

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

Create new Innm

  1. Create new record in `innms`

  2. Fill data

Destination

Source

Destination

Source

id

 

name

$.name

name_original

$.name_original

sctid

$.sctid

is_active

TRUE

inserted_at

:timestamp

inserted_by

user_id

updated_at

:timestamp

updated_by

user_id

 

Response structure

See on Apiary

Example:

{ "meta": { "code": 201, "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, "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" } }

 

{ "meta": { "code": "409", "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "error": { "type": "duplicate", "message": "innm duplicate" } }

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 201

 

 

 409

 

 

 

ЕСОЗ - публічна документація