/

[DRAFT] Get Risk Assessments by search params [API-007-013-001-0002]

In progress

ЕСОЗ - публічна документація

[DRAFT] Get Risk Assessments by search params [API-007-013-001-0002]

Owned by Anzhela Kovalenko (SoE eHealth)

Last updated: yesterday at 1:31 PM

2 min read

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
- 9.2 Validate token
- 9.3 Validate scopes
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Risk Assessments by search params [API-007-013-001-0002]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-013-001-0002
Microservices (namespace)	ME
Component	Risk Assessment
Component ID	COM-007-013
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/risk-assessment/get-risk-assessments-by-search-params
Resource	{{host}}/api/patients/{{patient_id}}/risk_assessments
Scope	risk_assessment:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

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

Logic

Service returns Risk Assessments related to the patient filtered by submitted parameter

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

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

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200
3

Post-processing processes

N/A

Technical modules where the method is used

Related content

[DRAFT] Get Risk Assessment by id [API-007-013-001-0001]

[DRAFT] Get Risk Assessment by id [API-007-013-001-0001]

ЕСОЗ публічна документація

More like this

[DRAFT] Get Risk Assessments by search params (Patient Summary) [API-007-008-013-0301]

[DRAFT] Get Risk Assessments by search params (Patient Summary) [API-007-008-013-0301]

ЕСОЗ публічна документація

More like this

[DRAFT] Get Risk Assessment by id (Patient Summary) [API-007-008-013-0300]

[DRAFT] Get Risk Assessment by id (Patient Summary) [API-007-008-013-0300]

ЕСОЗ публічна документація

More like this

[DRAFT] Get Diagnostic Report by search params (Patient Summary) [API-007-008-006-0288]

[DRAFT] Get Diagnostic Report by search params (Patient Summary) [API-007-008-006-0288]

ЕСОЗ публічна документація

More like this

[DRAFT] Get Clinical Impression by search params [API-007-004-002-0247]

[DRAFT] Get Clinical Impression by search params [API-007-004-002-0247]

ЕСОЗ публічна документація

More like this

[DRAFT] Get Condition by id [API-007-008-003-0283]

[DRAFT] Get Condition by id [API-007-008-003-0283]

ЕСОЗ публічна документація

More like this

ЕСОЗ - публічна документація