Purpose

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

Specification

Apiary

...

Logic

Service returns context (episode), immunization based on:

• Get Immunization object byimmunization_id from immunizations (MongoDB)

• Get immunization.context.identifier from Immunization object

• Call Get Encounter context :

  • Get Encounter objectby immunization.context.identifier (immunization.context.identifier = encounter._id)
    AFTER

  • Get encounter.episode from Encounter object

• Render a response according to specification

Input parameters

Request structure

See on Apiary

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)

...

Headers

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation

Validate Person

• Get Person identifier from the URL

• Check it exists in DB

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

Validate Encounter

• Get Immunization identifier from the URL

  • Check it exists in DB

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

  • Check Immunization belongs to patient

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

Service logic

Service returns context (episode), immunization based on:

Get Immunization object byimmunization_id from immunizations (MongoDB)

• Get immunization.context.identifier from Immunization object

• Call https://e-health-ua.atlassian.net/wiki/spaces/PCR/pages/17003184199 :

  Get Encounter objectby immunization.context.identifier (immunization.context.identifier = encounter._id)
  AFTER

• Get encounter.episode from Encounter object

Render a response according to specification

Processing

API paragraph not found

Response structure

See on Apiary

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

Post-processing processes

API paragraph not found

HTTP status codes