...

...

Purpose

...

This web service is designed to return conditions by episode_id or encouner_id.

Specification

...

colour

Page Properties
Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status
Status
Green title APPROVED Version 1.0 Date of release 22 Jun 2022 Link https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-conditions Resource /api/patients/{{patient_id}}summary/conditions Scope patient_summary:read Components Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary Microservices Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found Protocol type Тип протоколу, який використовується запитом, наприклад: SOAP | REST Request type GET Sync/Async Async Метод є синхронним чи асинхронним? Public/Private/Internal Public

Logic

...

API paragraph not found

Filters

Request structure

...

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

Validate request*

...

Request data validation

...

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401 

Validate scopes

• Check user scopes in order to perform this action (scope = 'condition:read')

  1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": [ { "id": "6fe6d880-f100-4e39-a278-1d14eb8472ef", "primary_source": true, "asserter": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ], "text": "" }, "value": "97d57238-ffbe-4335-92ea-28d4de117ea2" } }, "context": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "encounter" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "code": { "coding": [ { "system": "eHealth/ICD10/condition_codes", "code": "K87" } ] }, "clinical_status": "active", "verification_status": "provisional", "severity": { "coding": [ { "system": "eHealth/condition_severities", "code": "55604002" } ] }, "body_sites": [ { "coding": [ { "system": "eHealth/body_sites", "code": "head" } ] } ], "onset_date": "2018-10-08T09:46:37.694Z", "asserted_date": "2018-10-08T09:46:37.694Z", "inserted_at": "2018-08-02T10:45:16.000Z", "updated_at": "2018-08-02T10:45:16.000Z", "stage": { "summary": { "coding": [ { "system": "eHealth/condition_stages", "code": "14803004" } ] } }, "evidences": [ { "codes": [ { "coding": [ { "system": "eHealth/ICPC2/reasons", "code": "169068008" } ] } ], "details": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "observation" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" } ] } ] } ], "paging": { "page": 2, "page_size": 50, "total_entries": 1000, "total_pages": 20 } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  200

...