...

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

Необхідно зазначити призначення методу.

Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)

Specification*

Logic*

Потрібно по пунктах описати логіку методу API або додати діаграму

Preconditions

Які передумови мають бути виконані системою/користувачем. Наприклад:

• створений запис в MedicationRequest;

• рецепт відпущений (COMPLETED)

Global and configuration parameters

Потрібно вказати глобальні та конфігураційні параметри.

Наприклад:

Input parameters

Потрібно вказати вхідні параметри, наприклад:

Filters

Потрібно вказати фільтри. Наприклад:

Request structure*

See on Apiary

Example:

{
  "category": {
    "coding": [
      {
        "system": "eHealth/composition_categories",
        "code": "LIVE_BIRTH"
      }
    ]
  },
  "type": {
    "coding": [
      {
        "system": "eHealth/composition_types",
        "code": "NEWBORN"
      }
    ]
  },
  "event": [
    {
      "code": {
        "coding": [
          {
            "system": "eHealth/composition_events",
            "code": "COMPOSITION_VALIDITY_PERIOD"
          }
        ]
      },
      "period": {
        "start": "2020-06-26T15:22:53.403Z",
        "end": "2020-07-26T15:22:53.403Z"
      }
    }
  ],
  "subject": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "encounter": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "author": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "section": {
    "focus": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    }
  },
  "extension": [
    {
      "valueCode": "AUTHORIZE_WITH",
      "valueUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "valueCode": "IS_ACCIDENT",
      "valueBoolean": true
    },
    {
      "valueCode": "TREATMENT_VIOLATION",
      "valueString": "late_arrival"
    },
    {
      "valueCode": "TREATMENT_VIOLATION_DATE",
      "valueDate": "2020-12-12"
    },
    {
      "valueCode": "IS_INTOXICATED",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FOREIGN_TREATMENT",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FORCE_RENEW",
      "valueBoolean": true
    }
  ]
}

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

• api-key:uXhEczJ56adsfh3Ri9SUkc4en

Validate request*

Наприклад:

1. Validate request using JSON schema

   1. In case validation failed - generate 422 error

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}

Validation data request*

Валідація даних

Parameters that are used when processing the request

Configuration parameters

Наприклад: Доступ до методу визначається скоупом covid_certificate:get . Дозвіл на даний скоуп визначається адміністратором Системи шляхом конфігурування скоупів в контексті клієнтів і ролей.

Dictionaries

Потрібно вказати словники, які використовує метод API

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Response structure*

See on Apiary

Example:

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "PENDING",
    "eta": "string",
    "doneAt": "string",
    "links": [
      {
        "entity": "eHealth/composition",
        "href": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc",
        "error": "string"
      }
    ]
  }
}

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes

Backward compatibility

Сумісність з попередніми версіями методу

Purpose

This WS is designed to change status of contract request to DECLINED by NHS ADMIN SIGNER. NHS employee can change status of contract request through Admin portal. If NHS Admin wants to decline contract request he/she need to enter a reason.

...

Specification

apiary

json schema

Request

• status_reason

Validation

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Check if token is not expired

  • in case error return 401 - "Token is expired"

Validate user

extract user_id from token

extract client_id from token

• Check if user is active

  • in case error return 403 - (user is not active)

• check nhs_legal_entity is active

  • in case error return 403 - (Client is not active)

• Check user

   role

   role = "NHS ADMIN SIGNER"

  • in case error return 403 "User is not allowed to perform this action"

Validate scopes

• Check user scopes in order to perform this action (scope = 'contract_requests:update')

  • Return 403 in case invalid scope(s) "Your scope does not allow to access this resource. Missing allowances: contract_requests:update"

Digital signature

Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.

Validate EDRPOU

1. Check

...

1. that EDRPOU in Certificate details exists and not empty

   1. in case of error return 422 error ('Invalid EDRPOU in DS')

2. Check

...

1. that EDRPOU in Certificate details is equal

...

1. to EDPOU in legal entity

   1. Get client_id from token.

   2. Find prm.legal_entities id by client_id

   3. Compare EDRPOU in Certificate with legal_entities.edrpou

   4. In case validation fails - generate 422 error

2. Check that SURNAME in Certificate details is equal to LAST_NAME in Party

   1. Get user_id → user_parties.party_id → parties.last_name and compare to surname from DS
      

      1. Convert prm.parties.LAST_NAME and Certificate details.SURNAME to uppercase

      2. Compare prm.parties.LAST_NAME and Certificate details.SURNAME as Cyrillic letters

      3. In case validation fails - generate 422 error

Validate DRFO

1. Get parties.tax_id using party_users.party_id by user_id.

2. Compare DRFO in Certificate with party.tax_id

   1. Convert DRFO and TAX_ID to uppercase

   2. Compare DRFO and TAX_ID as Cyrillic letters

   3. Convert DRFO to Cyrillic and compare as Cyrillic letters

3. In case validation fails - generate 422 error

Validate request

1. Check that all fields are present in signed content

   1. "id"

   2. "contractor_legal_entity":

      1. "id"

      2. "name"

      3. "edrpou"

   3. "next_status"

   4. "status_reason"

   5.  "text"

2. Check next_status='DECLINED'

3. Validate contract request id.

   1. Check contract_requests.id = $.id

      1. in case error return 404 ("Contract request with id=$id doesn't exist")

4. Validate contractor_legal_entity_id

   1. Legal_entities.id = $.contractor_legal_entity.id and Legal_entities.status='ACTIVE' and is_active=true,

      1. in case error return 422 ("Legal entity in contract request should be active")

   2. $contractor_legal_entity.edrpou in request=prm.legal_entities.edrpou

   3. $contractor_legal_entity.name in request=prm.legal_entities.name

Validate contract request status

• Check contract_request.status=IN_PROCESS

  • in case error return 422 - "Incorrect status of contract_request to modify it"

Response

mapping

Save signed contract request to media storage

1. Get url for contract request upload.

   
   

   Parameter	Source
   action	'GET'
   bucket	'CONTRACT_REQUEST'
   resource_id	: CONTRACT_REQUEST_ID
   resource_name	: CONTRACT_REQUEST_DECLINED
   timestamp	:TIMESTAMP

   
   

2. Upload signed declaration to media storage

Add status to event manager

After status was changed (status = APPROVED, DECLINED, TERMINATED, NHS_SIGNED or SIGNED) - add new status to event_manager