Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose

...

This web service is designed to return observations by patient_id, episode_id or encouner_id.

Specification

...

Page Properties
Link
https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-observations
Resource
/api/patients/{{patient_id}}/summary/observation
Scope
patient_summary:read
Components
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription:read
Components
Patient 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

Filters

Filter	Type	Description	Example
patient_id	String	Unique patient identifier	`7a489bbd-d8e2-48d9-92fd-fcf0102f7b08`
page	Number	Page number	`1`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
code	String		`10569-2`
issued_from	String		`1990-01-01`
issued_to	String		`2000-01-01`

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

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 = 'observation:read')
1. Return 403 in case invalid scope(s)

Validate patient

Validate patient exists in MongoDB
- In case of error return 404 not found

Access to the resource is also managed by ABAC module.

Processing

...

In case episode_id was submitted as a search param:
Select all encounters.id where ME.patinents{patient_id}.encounters{}.episode.identifier.value== episode_id
Select all observations where ME.patients{patient_id}.observationd{}.context.identifier.value == Select 1

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Versions Compared

Old Version 4

New Version Current

Key

Required parameters are marked with "*"

Purpose

This web service is designed to return observations by patient_id, episode_id or encouner_id.

Specification

Logic

API paragraph not found

Filters

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

Request data validation

Validate token

Validate scopes

Validate patient

Processing

In case episode_id was submitted as a search param:
Select all encounters.id where ME.patinents{patient_id}.encounters{}.episode.identifier.value== episode_id
Select all observations where ME.patients{patient_id}.observationd{}.context.identifier.value == Select 1

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 4

New Version Current

Key

Required parameters are marked with "*"

Purpose

This web service is designed to return observations by patient_id, episode_id or encouner_id.

Specification

Logic

API paragraph not found

Filters

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

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

Request data validation

Validate token

Validate scopes

Validate patient

Processing

In case episode_id was submitted as a search param:Select all encounters.id where ME.patinents{patient_id}.encounters{*}.episode.identifier.value== episode_idSelect all observations where ME.patients{patient_id}.observationd{*}.context.identifier.value == Select 1

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

In case episode_id was submitted as a search param:
Select all encounters.id where ME.patinents{patient_id}.encounters{}.episode.identifier.value== episode_id
Select all observations where ME.patients{patient_id}.observationd{}.context.identifier.value == Select 1

Page Properties
HTTP status code
Message
What caused the error
200

...