Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “API paragraph not found”.

Purpose*

This WS allows to get detailed allergy intolerance info from Admin panel.

Specification*

Logic*

API paragraph not found

Preconditions

Key points

1. This is a graphQl query used in Administration panel only

2. Only authenticated and authorized NHS employee with appropriate scope can get allergy intolerance details.

3. Query returns single allergy intolerance by person (mpi id) and allergy intolerance identifier.

4. Filtration with forbidden group items not implemented for allergy intolerances, so it not used here.

5. Query should be invoked only if /wiki/spaces/AFC/pages/16680386561 for monitoring exists for current user and corresponding patient (ABAC rule_-2).

Input parameters

Request structure*

API paragraph not found

Authorize*

• Verify the validity of access token

  • in case of error - 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 = 'allergy_intolerance:practical_monitor')

  • return 403 (“Your scope does not allow to access this resource. Missing allowances: allergy_intolerance:practical_monitor”) in case of invalid scope(s)

• Check user has access to resource according to @rule_-2 in ABAC

  • return 403 (“Access denied. Justification required“) in case of error

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

Validate request*

API paragraph not found

Request data validation*

Validate legal entity

• Extract client_id from token.

• Check client scopes in order to perform this action (scope = 'allergy_intolerance:practical_monitor')

  • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: allergy_intolerance:practical_monitor”)

• Check legal entity status (status = ACTIVE)

  • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

• Check required personId submitted.

  • return 404 (“not found“) in case not exist

• Check required allergy intolerance Id submitted.

  • return 404 (“not found“) in case not exist or not related to person

Processing*

Service logic

1. Get allergy intolerance by id and patient_id

2. Render detailed allergy intolerance data according to schema

Response structure*

See on Apiary

Example:

{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "clinical_status": "active",
    "verification_status": "confirmed",
    "type": "allergy",
    "category": "food",
    "criticality": "low",
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "code": {
      "coding": [
        {
          "system": "eHealth/resources",
          "code": "patient"
        }
      ]
    },
    "onset_date_time": "2016-01-01T00:00:00.000Z",
    "asserted_date": "2018-08-02T10:45:00.000Z",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "primary_source": true,
    "asserter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": ""
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
      }
    },
    "last_occurrence": "2018-07-02T00:00:00.000Z"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*