/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-007-008-006-0288
Microservices (namespace)	ME
Component	Patient Summary
Component ID	COM-007-008
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-diagnostic-report-by-search-params
Resource	{{host}}/api/patients/{{patient_id}}/summary/diagnostic_reports/
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)

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

N/A (Not applicable)

eHealth/resources - service_request (parameter “based_on“ in response)
eHealth/diagnostic_report_statuses (parameter “status“ in request / response)
eHealth/resources - service (parameter “code“ in request / response)
eHealth/diagnostic_report_categories (parameter “category“ in response)
eHealth/ICD10_AM/condition_codes (parameter “conclusion_code“ in response)
eHealth/resources - specimen (parameter “specimens“ in response)
eHealth/resources - equipment (parameter “used_references“ in response)
eHealth/resources - employee (parameter “recorded_by“ in response)
eHealth/resources - encounter (parameter “encounter“ in response)
eHealth/resources - episode (parameter “origin_episode“ in response)
eHealth/resources - division (parameter “division“ in response)
eHealth/resources - legal_enity (parameter “managing_organization“ in response)
eHealth/resources - employee (parameter “performer“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/resources - employee (parameter “results_interpreter“ in response)
eHealth/cancellation_reasons (parameter “cancellation_reason“ in response)

	Input parameter	Mandatory	Type	Description	Example
1	patient_id	M	String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	page		Number	Page number	`2`
3	page_size		Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
4	issued_from		String		`1990-01-01`
5	issued_to		String		`2017-01-01`
6	code		String		`12345`

Request to process the request using a token in the headers

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

N/A (Not applicable)

N/A (Not applicable)