Required parameters are marked with "*"

...

Purpose

...

This web service is designed to return risk assessments info by patient_id or search_params.

Specification

...

Page Properties

Link https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-risk-assessment-by-id Resource /api/patients/{{patient_id}}/summary/risk_assessments/{{risk_assessment_id}} Scope patient_summary:read Components Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary Microservices Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found Protocol type Тип протоколу, який використовується запитом, наприклад: SOAP | REST Request type GET Sync/Async Async

Logic*

API paragraph not found

...

Logic

API paragraph not found

Input parameters

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

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 = 'risk_assessment: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 { "data": { "id": "70a9e15b-b71b-4caf-8f2e-ff247e8a5600", "status": "preliminary", "method": { "coding": [ { "system": "eHealth/risk_assesment_methods", "code": "deafult_code" } ] }, "code": { "coding": [ { "system": "eHealth/risk_assesment_codes", "code": "R80" } ] }, "context": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "encounter" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "asserted_date": "2018-08-02T10:45:00.000Z", "primary_source": true, "performer": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ], "text": "Галина Олександрівна" }, "value": "97d57238-ffbe-4335-92ea-28d4de117ea2" } }, "basis": { "reference": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "patient" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "references": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "observation" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } ] }, "reason_references": [ { "type": { "coding": [ { "system": "eHealth/resources", "code": "condition" } ] }, "value": "97d57238-ffbe-4335-92ea-28d4de117ea2" } ], "predictions": [ { "outcome": { "coding": [ { "system": "eHealth/risk_assessment_outcomes", "code": "default_outcome" } ] }, "probability_range": { "low": { "value": 0, "comparator": ">", "unit": "kg", "system": "eHealth/ucum/units", "code": "kg" }, "high": { "value": 0, "comparator": ">", "unit": "kg", "system": "eHealth/ucum/units", "code": "kg" } }, "qualitative_risk": { "coding": [ { "system": "eHealth/risk_assessment_qualitative_risks", "code": "default_qualitative_risk" } ] }, "when_range": { "low": { "value": 0, "comparator": ">", "unit": "kg", "system": "eHealth/ucum/units", "code": "kg" }, "high": { "value": 0, "comparator": ">", "unit": "kg", "system": "eHealth/ucum/units", "code": "kg" } }, "rationale": "some text" } ], "mitigation": "some text", "comment": "some text", "inserted_at": "2018-08-02T10:55:00.000Z", "updated_at": "2018-08-02T10:55:00.000Z" }, "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  200

...