Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents
minLevel1
maxLevel7

Purpose

This WS is designed to return Medical Program detail.

Specification

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-programs/medical-program/get-medical-program-by-id

Посилання на Apiary або Swagger

Resource

/api/medical_programs/{{id}}

Посилання на ресурс, наприклад: /api/persons/create

Scope

medical_program:read

Scope для доступу

Components

ePrescriptionMedical Programs

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Logic

  • Get Medical Program by id.

  • Render a response according to specification.

Preconditions

API paragraph not found

...

No

Input parameters

Input parameter

Values

Type

Description

Example

id

UUID string

Internal medical program ID. Required.

c7d52544-0bd4-4129-97b0-2d72633e0490

Filters

No

Dictionaries

API paragraph not found

Request structure

...

Dictionaries

  • LICENSE_TYPE

  • clinical_impression_patient_categories

  • MEDICAL_PROGRAM_TYPE

  • PROVIDING_CONDITION

  • FUNDING_SOURCE

  • MR_BLANK_TYPES

Authorize

  • Verify the validity of access token

    • in case of error - return 401 (“Invalid access token”) in case of validation fails.

  • Verify that token is not expired

    • in case of error - return 401 (“Invalid access token”).

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

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: medical_program:read”) in case of invalid scope(s).

...

  • Get Medical Program identifier from the URL.

  • Check it exists in DB

    • in case of error - return 404 error (message: "Medical program does not exist ").

...

API paragraph not found

Response structure

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "c7d52544-0bd4-4129-97b0-2d72633e0490",
    "name": "Доступні ліки",
    "medical_program_settings": {
      "care_plan_required": true,
      "employee_types_to_create_medication_request": [
        "SPECIALIST",
        "DOCTOR"
      ],
      "skip_mnn_in_treatment_period": true,
      "skip_employee_validation": true,
      "speciality_types_allowed": [
        "ENDOCRINOLOGY",
        "PEDIATRIC_NEUROLOGY"
      ],
      "conditions_icd10_am_allowed": [
        "A00.0",
        "A00.1"
      ],
      "conditions_icpc2_allowed": [
        "A01",
        "A02"
      ],
      "providing_conditions_allowed": [
        "INPATIENT",
        "OUTPATIENT"
      ],
      "medication_request_max_period_day": 90,
      "skip_medication_request_employee_declaration_verify": true,
      "skip_medication_request_legal_entity_declaration_verify": true,
      "multi_medication_dispense_allowed": true,
      "skip_medication_dispense_sign": true,
      "medication_request_notification_disabled": true,
      "skip_contract_provision_verify": true,
      "medication_dispense_period_day": 90
    },
    "medical_program_settings_text": "Some text",
    "is_active": true,
    "medication_dispense_allowed": true,
    "medication_dispense_allowed_text": "Some text",
    "medication_request_allowed": true,
    "medication_request_allowed_text": "Some text",
    "type": "MEDICATION",
    "funding_source": "NHS",
    "mr_blank_type": "F-1",
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

Post-processing processes

...

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

200

Response

 

401

Invalid access token

 

403

Your scope does not allow to access this resource. Missing allowances: medical_program:read

404

Medical program does not exist

Backward compatibility

...