Versions Compared

Old Version 31

changes.mady.by.user Edward Voloshin

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Table of Contents

Specification

...

 create-innm

...

 new_innm_schema.json

...

 create_innm_response.json

Purpose

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

Input parameters

  • name
  • name_original
  • sctid
Table of Contents
minLevel1
maxLevel3

Purpose

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

Specification

Page Properties

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:

Expand
titleRequest example
Code Block
{
  "sctid": "52574003",
  "name": "Аміодарон",
  "name_original": "Amiodarone"
}

Authorize

  1. Verify the validity of access token

  2. Check user

...

  1. scope (scope = 'innm:write') in order to perform this action

    1. In case error - generate 401 response

Validate request (JSON schema)

Validate request using JSON schema.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

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:

Expand
titleResponse example
Code Block
{
  "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"
  }
}

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

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

 201

 

 

 409