Required parameters are marked with "*"

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

Purpose*

API paragraph not found

Specification*

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/service-requests/manage-service-requests/qualify-service-request-by-id
Resource	/api/service_requests/{{service_request_id}}/actions/qualify
Scope	service_request:use
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	POST
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example
service_request_id		String	Unique service request identifier	`aff00bf6-68bf-4b49-b66d-f031d48922b3`

Request structure*

See on Apiary

Example:

Request example

{
  "programs": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "medical_program"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    }
  ]
}

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Validate request*

API paragraph not found

Request data validation*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "program_id": "59781de0-2e64-4359-b716-bcc05a32c10f",
      "program_name": "Fee-For-Service",
      "status": "INVALID",
      "rejection_reason": "Service is not included in the program"
    }
  ]
}

Post-processing processes*

API paragraph not found

HTTP status codes*

HTTP status code	Message	What caused the error
200

Qualify Service Request by id_NEW

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Validate request*

Request data validation*

Processing*

Response structure*

Post-processing processes*

HTTP status codes*