Properties of a REST API method document

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

1. 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")

2. 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

Request structure

See on API-specification

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. Return 401 in case of validation fails

2. 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

1. 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

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

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