Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

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-013-0300

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-risk-assessment-by-id

Resource

{{host}}/api/patients/{{patient_id}}/summary/risk_assessments/{{risk_assessment_id}}

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

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

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

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - employee (parameter “risk_assessment_id“ in request)

  2. eHealth/risk_assessment_statuses(parameter “status“ in response)

  3. eHealth/risk_assesment_methods(parameter “method“ in response)

  4. eHealth/risk_assesment_codes (parameter “code“ in response)

  5. eHealth/resources - encounter (parameter “context“ in response)

  6. eHealth/resources - employee (parameter “performer“ in response)

  7. eHealth/report_origins (parameter “report_origin“ in response)

  8. eHealth/resources - observation (parameter “basis:references“ in response)

  9. eHealth/resources - patient (parameter “basis:reference“ in response)

  10. eHealth/resources - condition (parameter “reason_references“ in response)

  11. eHealth/risk_assessment_reasons (parameter “reason_codes“ in response)

  12. eHealth/risk_assessment_outcomes(parameter “predictions:outcome“ in response)

  13. eHealth/risk_assessment_qualitative_risks(parameter “qualitative_risk“ in response)

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Unique patient identifier

e549c257-232e-4dab-9f1e-b2322cac3968

2

risk_assessment_id

 

String

Unique immunization identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

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

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

Response structure examples

See on API-specification

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

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

N/A (Not applicable)