Properties of a REST API method document

Purpose

This web service is designed to return detailed information of the patient’s allergy intolerances.

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

1. eHealth/resources - allergy_intolerance (parameter “id“ in request)

2. eHealth/allergy_intolerance_clinical_statuses (parameter “clinical_status“ in response)

3. eHealth/allergy_intolerance_verification_statuses (parameter “verification_status“ in response)

4. eHealth/allergy_intolerance_types (parameter “type“ in response)

5. eHealth/allergy_intolerance_categories (parameter “category“ in response)

6. eHealth/allergy_intolerance_criticalities (parameter “criticality“ in response)

7. eHealth/resources - encounter (parameter “context“ in response)

8. eHealth/allergy_intolerance_codes (parameter “code“ in request / response)

9. eHealth/resources - employee (parameter “asserter“ in response)

10. eHealth/report_origins (parameter “report_origin“ in response)

Input parameters

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401 

Validate scopes

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

  1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Validate allergy intolerance

• Validate allergy intolerance exists in MongoDB

  • In case of error return 404 not found

• Check allergy intolerance belongs to patient

  • In case of error return 404 not found

Processing

1. Get allergy intolerance by ID

2. Ensure that requested allergy intolerance relates to requested Patient

3. Render a response according to specification

Response structure examples

See on API-specification

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

HTTP status codes

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)