Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Observation by id (Patient Summary) [API-007-008-011-0297]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-008-011-0297
Microservices (namespace)	ME
Component	Patient Summary
Component ID	COM-007-008
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-observation-by-id
Resource	{{host}}/api/patients/{{patient_id}}/summary/observations/{{id}}
Scope	patient_summary:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

N/A

Logic

N/A

Configuration parameters

N/A

Dictionaries

eHealth/resources - observation (parameter “id“ in request)
eHealth/observation_statuses (parameter “status“ in response)
eHealth/resources - diagnostic_report (parameter “diagnostic_report“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/observation_categories (parameter “categories“ in response)
eHealth/LOINC/observation_codes (parameter “code“ in request/response)
eHealth/resources - employee (parameter “performer“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/observation_interpretations (parameter “interpretation“ in response)
eHealth/body_sites (parameter “body_site“ in response)
eHealth/observation_methods (parameter “method“ in response)
eHealth/ucum/units (parameter “reference_ranges:low; reference_ranges:high;“ in response)
eHealth/reference_range_types (parameter “type“ in response)
eHealth/reference_range_applications (parameter “applies_to“ in response)
eHealth/ucum/units (parameter “age:low; age:high;“ in response)
eHealth/resources - specimen (parameter “specimen“ in response)
eHealth/resources - equipment (parameter “device“ in response)

Input parameters

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

Request structure

See on API-specification

Example

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

See on API-specification

Example

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

HTTP status codes

	Response code	HTTP Status code	Internal name
1	Базові
2		200	Response
3		401	Access token validation failed
4		401	Access token expired
5		403	Invalid scope
6		404	Patient not found
7	Специфічні

Post-processing processes

N/A

Technical modules where the method is used

[DRAFT] Get Observation by id (Patient Summary) [API-007-008-011-0297]

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used