Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose

API paragraph not found”.

Purpose*

This WS allows to get detailed observation info from Admin panel.

Specification

...

Page Properties
Link
https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-observation-by-id
Resource
/api/patients/{{patient_id}}/summary/observations/{{id}}
Scope
patient_summary:read
Components
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary
Microservices
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
Request type
GET
Sync/Async
Async
Метод є синхронним чи асинхронним?
Public/Private/Internal
Public

Logic

...

API paragraph not found

Preconditions

Key points

...

This is a graphQl query used in Administration panel only

...

Only authenticated and authorized NHS employee with appropriate scope can get observation details.

...

Query returns single observation by person (mpi id) and observation identifier.

...

Filtration with forbidden group items not implemented for observations, so it not used here.

...

Input parameters

Input parameter	Values	Type	Description	Example
patient_id		String	Unique patient identifier	`7a489bbd-d8e2-48d9-92fd-fcf0102f7b08`
id		String	Unique observation identifier	`340b86fd-23f3-4a33-94c5-8ec19d116c33`

Request structure

...

API paragraph not found

Authorize

...

Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'observation:practical_monitor')
return 403 (“Your scope does not allow to access this resource. Missing allowances: observation:practical_monitor”) in case of invalid scope(s)
Check user has access to resource according to @rule_-2 in ABAC
return 403 (“Access denied. Justification required“) in case of error
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

API paragraph not found

Request data validation*

Validate legal entity

Extract client_id from token.
Check client scopes in order to perform this action (scope = 'observation:practical_monitor')
- in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: observation:practical_monitor”)
Check legal entity status (status = ACTIVE)
- In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

Check required personId submitted.
- return 404 (“not found“) in case not exist
Check required observation Id submitted.
- return 404 (“not found“) in case not exist or not related to person

Processing*

Service logic

Get observation by id and patient_id
Render detailed observation data according to schema

...

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "status": "valid",
    "diagnostic_report (Reference_response, optional)": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "diagnostic_report"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "categories": [
      {
        "coding": [
          {
            "system": "eHealth/observation_categories",
            "code": "vital_signs"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "eHealth/LOINC/observation_codes",
          "code": "10569-2"
        }
      ]
    },
    "effective_date_time": "2018-10-08T09:46:37.694Z",
    "issued": "2018-08-02T10:45:16.000Z",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "primary_source": false,
    "performer": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "Шевченко Олесь Вікторович"
    },
    "interpretation": {
      "coding": [
        {
          "system": "eHealth/observation_interpretations",
          "code": "L"
        }
      ]
    },
    "comment": "Some comment",
    "body_site": {
      "coding": [
        {
          "system": "eHealth/body_sites",
          "code": "head"
        }
      ]
    },
    "method": {
      "coding": [
        {
          "system": "eHealth/observation_methods",
          "code": "anamnesis"
        }
      ]
    },
    "value_quantity": {
      "value": 0,
      "comparator": ">",
      "unit": "kg",
      "system": "eHealth/ucum/units",
      "code": "kg"
    },
    "reference_ranges": [
      {
        "low": {
          "value": 0,
          "comparator": ">",
          "unit": "kg",
          "system": "eHealth/ucum/units",
          "code": "kg"
        },
        "high": {
          "value": 0,
          "comparator": "<",
          "unit": "kg",
          "system": "eHealth/ucum/units",
          "code": "kg"
        },
        "type": {
          "coding": [
            {
              "system": "eHealth/reference_range_types",
              "code": "normal"
            }
          ]
        },
        "applies_to": {
          "coding": [
            {
              "system": "eHealth/reference_range_applications",
              "code": "male"
            }
          ]
        },
        "age": {
          "low": {
            "value": 18,
            "comparator": ">",
            "unit": "years"
          },
          "high": {
            "value": 35,
            "comparator": "<",
            "unit": "years"
          }
        },
        "text": "Some text"
      }
    ]
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose

Purpose*

Specification

Logic

API paragraph not found

Preconditions

Key points

Input parameters

Request structure

API paragraph not found

Authorize

Headers

Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
...

Request data validation

Request data validation*

Validate legal entity

Validate request

Processing*

Service logic

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
HTTP status code
Message
What caused the error
200

...

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose

Purpose*

Specification

Logic

API paragraph not found

Preconditions

Key points

Input parameters

Request structure

API paragraph not found

Authorize

Headers

Наприклад:Content-Type:application/jsonAuthorization:Bearer mF_9.B5f-4.1JqM...

Request data validation

Request data validation*

Validate legal entity

Validate request

Processing*

Service logic

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page PropertiesHTTP status codeMessageWhat caused the error 200 ...

Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
...

Page Properties
HTTP status code
Message
What caused the error
200

...