REST API method / Метод REST API (настанова) (

Info
Note
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-001-001-001-0003
Microservices (namespace)	ABAC
Component	Approvals/ABAC
Component ID	COM-001-001
Link на API-специфікацію	https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/approvals/resend-sms-on-approval/resend-sms-on-approval
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_packageapi/patients/{{patiend_id}}/approvals/{{id}}/actions/resend
Scope	approval:create
Protocol type	REST
Request type	PATCH
Sync/Async	Async(def)/Sync
Public/Private	Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)It can be processed in both sync and async methods depends on Server decision.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Service Logic

Search for approval by patient_id + approval_id
1. Validate person by patient_id
  1. In case error return 404 (message "Person not found")
2. Validate approval by approval.id
  1. In case error return 404 (message "Approval with such id is not found")
Send SMS with OTP-code to persons phone from approvals.urgent.phone_number

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example
1	compositionpatiend_id	M	String ($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59	2		mpi_id	`aff00bf6-68bf-4b49-b66d-f031d48922b3`
2	id		String	approval_id	`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand

title	Example

Code Block

Headers

3

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer c2778f3064753ea70de870a53795f5c9d368a4b0-4a0e-457a-b267-32359fa6288f	M	Перевірка користувача	Authorization:Bearer c2778f3064753ea70de870a53795f5c9	d368a4b0-4a0e-457a-b267-32359fa6288f

Request data validation

...

Authorize

Verify the validity of access token
1. Return 401 in case of validation fails
Check user scope approval:create in order to perform this action
1. Return 403 in case of invalid scope

Request to process the request using a token in the headers

Validate authentication method

Resend SMS on Approval is allowed for person_authentication_method which was specified on Create Approval in the authorize_with field.
1. Return 409 in case of validation fails (message "Resend SMS is not allowed for this authentication method")

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

Description of the REST API response structure, example

...

title	Example

...

See on API-specification

Expand

title	Example

Code Block

{
  "data": {
    "id": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "granted_resources": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e"
        },
        "display_value": "null"
      }
    ],
    "granted_to": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "expires_at": 1498749591,
    "reason": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "service_request"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "status": "new",
    "access_level": "read",
    "authentication_method_current": {
      "type": "OTP",
      "number": "+38093*****85"
    }
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Expand

title	Example

Code Block

{
  "data": {
    "status": "pending",
    "eta": "2018-08-02T10:45:16.000Z",
    "links": [
      {
        "entity": "job",
        "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg"
      }
    ]
  },
  "meta": {
    "code": 202,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

1000Only for active MPI record can be created medication request!

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2			201	use payload from response
3		202	use Get job details to get processing result. Response payload will be returned in the job details
4		404	Composition Approval with such id is not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок	3	401	Unauthorized	Помилка підтвердження
4	Специфічні

5	422	5		404	Person not found
6		409	Resend SMS is not allowed for this authentication method
7	Специфічні
8

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Versions Compared

Old Version 3

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Service Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Validate authentication method

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Service Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Validate authentication method

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used