Purpose

Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-risk-assessment-by-id	Посилання на Apiary або Swagger
Resource	/api/patients/patient_id/summary/risk_assessments/risk_assessment_id	Посилання на ресурс, наприклад: /api/persons/create
Scope	`patient_summary:read`	Scope для доступу
Components		Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices		Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type		Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async		Метод є синхронним чи асинхронним?
Public/Private/Internal		Потрібно зазначити тип методу за ступенем доступності

Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:

Input parameter	Values	Type	Description	Example
asyncJobId		String	Async Job Object ID

Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:

Filter	Values	Type	Description	Example
status		String	Optional	PROCESSED

See on Apiary

Example:

Request example

Request to process the request using a token in the headers

See on Apiary

Example:

Response example

HTTP status code	Message	What caused the error