Versions Compared

Version Old Version 1 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

...

Document type

Метод REST API

Document title

[DRAFT] Get Risk Assessment Assessments by id search params [API-007-013-001-00010002]

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-00010002

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-assessmentassessments-by-idsearch-params

Resource

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

Scope

risk_assessment:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

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

Logic

N/AService returns Risk Assessments related to the patient filtered by submitted parameter

Configuration parameters

N/A

...

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

...

2

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
...
Response structure examples
See on API-specification
 Expand
titleExample
 Code Block
languagejson
{
  "datameta": {
    "idcode": "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"
    }
  ],
  "metapaging": {
    "codepage": 2002,
    "urlpage_size": "http://example.com/resource"50,
    "typetotal_entries": "object"1000,
    "requesttotal_idpages": "req-adasdoijasdojsda"20
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 
3
 
...