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

[DRAFT] Search Medical program provision [API-005-003-001-0057]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-003-001-0057

Microservices (namespace)

IL

Component

Contracts|Medical program provision

Component ID

COM-005-003

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-portal-and-reports/medical-program-provision/search-medical-program-provision

Resource

{{host}}/reports/stats/medical_program_provision

Scope

 

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Private

Purpose

Search Medical program provision by parameters and returne it's details

Logic

Method searches Medical program provision by parameters and returnes it's details

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

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Key

Value

Mandatory

Description

Example

Key

Value

Mandatory

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

3

 

 

 

 

 

Request data validation

API paragraph not found

 

Dictionaries

  • MEDICAL_PROGRAM_TYPE

  • FUNDING_SOURCE

  • MR_BLANK_TYPES

  • ADDRESS_TYPE

  • COUNTRY

  • SETTLEMENT_TYPE

  • STREET_TYPE

  • PHONE_TYPE

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": [ { "id": "3e34da3d-9b8c-4aaf-be8e-24a161279b6a", "medical_program": { "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" }, "division": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "Aдоніс", "type": "DRUGSTORE", "addresses": { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" }, "contacts": { "email": "email@example.com", "phones": [ { "type": "MOBILE", "number": "+380503410870" } ] }, "coordinates": { "latitude": 30.1233, "longitude": 50.32423 }, "legal_entity": { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "edrpou": "32323454", "type": "PRIMARY_CARE", "residence_address": { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" }, "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "email": "email@example.com", "website": "www.msp.com.ua", "status": "ACTIVE" }, "status": "ACTIVE", "dls_id": "2872985", "dls_verified": true }, "is_active": true, "deactivate_reason": "MANUAL_DEACTIVATION", "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

 

 

 

3

Специфічні

4

 

 

 

 

 

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

 

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