Properties of a REST API method document

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

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in ConfluenceN/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

Request structure

See on API-specification

...

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer mF_9.B5f-4.1JqM

...

Authorization:Bearer mF_9.B5f-4.1JqM

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

...

title	Example

...

...

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

HTTP status codes

Post-processing processes

Description of actions performed on data after processingN/A (Not applicable)

Technical modules where the method is used

List of pages describing technical modules where the method is used

...

N/A (Not applicable)