Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

This web service is designed to return observations by patient_ id , episode(observation_id or encouner) related to the patient with patient_id.

Specification

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/observation/get-observation-by-id

Resource

/api/patients/{{patient_id}}/observations/{{observation_id}}

Scope

observation:read

Components

Episode of Care

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

...

API paragraph not found

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

observation_id

String

Observation identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

Request structure

API paragraph not foundSee on Apiary

Authorize

Request to process the request using a token in the headers

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Verify token is not expired

    • in case error return 401 

  • Check user scopes in order to perform this action (scope = 'observation:read')

    • Return 403 in case invalid scope(s)

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM{{access_token}}

  • API-key:{{secret}}

Request data validation

API paragraph not found

Processing

In case episode_id was submitted as a search param:

  1. Select all encounters.id where ME.patinents{patient_id}.encounters{*}.episode.identifier.value== episode_id

  2. Select all observations where ME.patients{patient_id}.observationd{*}.context.identifier.value == Select 1Get observation by ID from observations collection (MongoDB)

  3. Validate data consistency:

    1. Ensure that requested observation relates to requested Patient (from URL)

      1. Return 404 ('not found') in case of error

  4. Render a response according to specification

Response structure

See on Apiary

...

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

 200

 

 

401

 

Access token validation failed

403

 

Invalid scope