1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
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	REST API Get medical programs list [API-011-001-004-0391]
Guideline ID	GUI-0011
Author	@Iryna Lishtaba (SoE eHealth)
Document version	1
Document status	PROD
Date of creation	14.10.2025
Date of update	06.03.2025
Method API ID	API-011-001-004-0391
Microservices (namespace)	PRM
Link на API-специфікацію	ESOZ · Apiary
Resource	{{host}}/api/medical_programs
Scope	medical_program:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This WS is designed to return Medical Program list filtered by search parameters.

Logic

Get all medical programs from prm.medical_programs table filtered by search params.
Render a response according to specification.

Configuration parameters

N/A

Dictionaries

LICENSE_TYPE

clinical_impression_patient_categories

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	id	O	String	Medical program identifier	d290f1ee-6c54-4b01-90e6-d701748f0851
2	name	O	String	Name of the Medical program	Доступні ліки
3	is_active	O	Boolean	Is medical program active or not. Default: true	true
4	mr_blank_type	O	String	Type of blank required by Program for prescription of Medications	F-1
5	page	O	Number	Page number	2
6	page_size	O	Number	A limit on the number of objects to be returned, between 1 and 300. Default: 50	50
7	type	O	String	medical program type	MEDICATION

Request structure

See on API-specification

Headers

Request data validation

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)

Processing

N/A

Response structure examples

See on API-specification

{
  "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"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response
3		401	Invalid access token
4		403	Your scope does not allow to access this resource. Missing allowances: medical_program:read
5	Специфічні
6

Post-processing processes

N/A

Technical modules where the method is used

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

REST API Get medical programs list [API-011-001-004-0391]

Analytics

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Related content