1 Purpose
2 Specification
3 Logic
4 Filters
5 Authorize
6 Headers
7 Request data validation
- 7.1 Validate token
- 7.2 Validate scopes
8 Response structure
9 HTTP status codes

Purpose

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

Specification

Link	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/risk-assessment/get-risk-assessments-by-search-params
Resource	/api/patients/{{patient_id}}/risk_assessments
Scope	risk_assessment:read
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Logic

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

Filters

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
code	String		`R80`
encounter_id	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`
episode_id	String		`f48d1b6c-a021-4d6a-a5a4-aee93e152ecc`
asserted_date_from	String		`1990-01-01`
asserted_date_to	String		`2000-01-01`

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

Response structure

See on Apiary

Example:

{
  "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

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200

E-Health

Get Risk Assessments by search params