REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

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://ehealthmedicaleventsapi.docs.apiary.io/#reference/approvals/verify-approval/resend-sms-on-approval
Resource	{{host}}/api/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

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	patiend_id		String	mpi_id	`aff00bf6-68bf-4b49-b66d-f031d48922b3`
2	id		String	approval_id	`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Request structure

See on API-specification

Example

Headers

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

Request data validation

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

See on API-specification

Example

{
  "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"
  }
}

Example

{
  "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

	Response code	HTTP Status code	Message	Internal name
1	Базові
2		201	use payload from response	sync
3		202	use Get job details to get processing result. Response payload will be returned in the job details	async: default method
4	Специфічні
5		422	Only for active MPI record can be created medication request!

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

Resend SMS on approval [API-001-001-001-0003]

Properties of a REST API method document

Purpose

Logic

Service Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Validate authentication method

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used