Properties of a REST API method document

Purpose

This method allows to get the context of Encounter in order to create approval on episode and receive access to other medical events.

Logic

Service returns context (episode), encounter based on:

• Get Encounter object by encounter_id from encounters (MongoDB)

• Get encounter.episode from Encounter object

• Render a response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

• Verify the validity of access token

  • 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 = 'medical_event_context:read')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)

Validate Person

• Get Person identifier from the URL

• Check it exists in DB

  • Return 404 ('not_found') in case of error

Validate Encounter

• Get Encounter identifier from the URL

  • Check it exists in DB

    • Return 404 ('not_found') in case of error

  • Check Encounter belongs to patient

    • Return 404 ('not_found') in case of error

Processing

N/A

Response structure examples

See on API-specification

{
  "data": {
    "episode": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "episode"
            }
          ]
        },
        "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
      },
      "display_value": "null"
    }
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used