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

Page Properties

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методуDRAFT] Get Procedures by search params (Patient Summary) [API-007-008-012-0299]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-008-012-0299
Microservices (namespace)	ME
Component	Patient Summary
Component ID	COM-007-008
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-procedures-by-search-params
Resource	{{host}}/api/patients/{{patient_id}}/summary/procedures
Scope	patient_summary:read
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private	Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the systemN/A

Logic

N/A

Configuration parameters

N/A

Dictionaries

eHealth/resources - service_request (parameter “based_on“ in response)
eHealth/procedure_statuses (parameter “status“ in response)
eHealth/procedure_status_reasons (parameter “status_reason“ in response)
eHealth/resources - service (parameter “code“ in response)
eHealth/resources - employee (parameter “recorded_by“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/resources - division (parameter “division “ in response)
eHealth/resources - legal_entity (parameter “managing_organization“ in response)
eHealth/resources - reason_references (parameter “condition“ in response)
eHealth/resources - equipment (parameter “used_references“ in response)
eHealth/procedure_outcomes (parameter “outcome“ in response)
eHealth/procedure_categories (parameter “category“ in response)
eHealth/resources - encounter (parameter “encounter“ in response)
eHealth/resources - episode (parameter “origin_episode“ in response)
eHealth/resources - condition (parameter “complication_details“ in response)
eHealth/assistive_products(parameter “used_codes“ in response)
procedure_focal_device_actions (parameter “focal_device“ in response)

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1	patient_id	M	String	Unique MPI patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	status		String	Procedure status	`completed`
3	code		String		`12345`
4	page		Number	Page number	`2`
5	page_size		Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Request structure

See on API-specification

Expand

title	Example

Code Block

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

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

Response structure examples

See on API-specification

Expand

title	Example

Code Block

language	json

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "7075e0e2-6b57-47fd-aff7-324806efa7e5",
      "based_on": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service_request"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "paper_referral": {
        "requisition": "1111-2222-3333-4444",
        "requester_legal_entity_name": "Some clinic",
        "requester_legal_entity_edrpou": "12345678",
        "requester_employee_name": "John",
        "service_request_date": "2018-10-08",
        "note": "Some notes"
      },
      "status": "COMPLETED",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/procedure_status_reasons",
            "code": "default"
          }
        ]
      },
      "code": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "performed_date_time": "2018-08-02T10:55:00.000Z",
      "recorded_by": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Шевченко Олесь Вікторович"
      },
      "primary_source": true,
      "performer": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ],
            "text": "Галина Олександрівна"
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
        }
      },
      "division": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "division"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "managing_organization": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "legal_entity"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Перше відділення обласної лікарня №1"
      },
      "reason_references": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        }
      ],
      "outcome": {
        "coding": [
          {
            "system": "eHealth/procedure_outcomes",
            "code": "default_outcome"
          }
        ]
      },
      "note": "Додаткова інформація по процедурі",
      "category": {
        "coding": [
          {
            "system": "eHealth/procedure_categories",
            "code": "default"
          }
        ]
      },
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "explanatory_letter": "Процедура була відмінена у зв'язку з помилкою при виборі пацієнта",
      "origin_episode (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "complication_details": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

	Response code	HTTP Status code	Internal name
1	Базові
2		200	Response
3		401	Access token validation failed
4		401	Access token expired
5		403	Invalid scope
6		404	Patient not found
7	Специфічні

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

...

Version	Old Version 10	New Version 11
Changes made by	Oksana Demchenko	Anzhela Kovalenko (SoE eHealth)
Saved on	Nov 26, 2024	Dec 19, 2024

Content Comparison

Versions Compared

Key

Purpose

Logic

Configuration parameters

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