Versions Compared

Old Version 1

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version 2

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

Key

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

Table of Contents
minLevel1
maxLevel3

Purpose

API paragraph not found

Specification

Page Properties
idAPI_Specification

Link

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

Посилання на Apiary або Swagger

Resource

/api/patients/patient_id/summary/risk_assessments/risk_assessment_id

Посилання на ресурс, наприклад: /api/persons/create

Scope

patient_summary:read

Scope для доступу

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Метод є синхронним чи асинхронним?

Public/Private/Internal

Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Input parameters

...

Input parameter

Values

Type

Description

Example

asyncJobIdpatient_id

String

Async Job Object ID

Filters

Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:

...

Filter

...

Values

...

Type

...

Description

...

Example

...

status

...

String

...

Optional

...

PROCESSED

Request structure

See on Apiary

Example:

...

titleRequest example

...

Unique patient identifier

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

risk_assessment_id

String

Unique immunization identifier

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

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

  • X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Expand
titleResponse 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
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 

 

 

  200