...

This web service is designed to return observations by id (observation_id) related to the patient with patient_id.

Specification

Logic

...

Input parameters

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

• API-key:{{secret}}

...

Request data validation

API paragraph not found

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

...

1. Get observation by ID from observations collection (MongoDB)

2. Validate data consistency:

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

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

3. Render a response according to specification

Response structure

See on Apiary

...

API paragraph not found

HTTP status codes