/

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

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

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

Owned by Kateryna Yakovleva

Last updated: Jan 03, 2025 by Anzhela Kovalenko (SoE eHealth)

2 min read

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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
- 3.1 Service Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
- 9.2 Validate authentication method
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] REST API Resend SMS on approval [API-001-001-001-0003]
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://medicaleventsmisapi.docs.apiary.io/#reference/approvals/resend-sms-on-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

It can be processed in both sync and async methods depends on Server decision.

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

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	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

Headers

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

N/A

Response structure examples

See on API-specification

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

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

	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	Approval with such id is not found
5		404	Person not found
6		409	Resend SMS is not allowed for this authentication method
7	Специфічні
8

Post-processing processes

N/A

Technical modules where the method is used

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