Properties of a REST API method document

Purpose

Return a list of short Encounter info filtered by search params

Logic

The endpoint returns a list of short Encounter info filtered by search params

Configuration parameters

N/A (Not applicable)

Dictionaries

1. eHealth/encounter_statuses (parameter “status“ in request / response)

2. eHealth/resources - episode (parameter “episode “ in response)

3. eHealth/encounter_typesclasses (parameter “type“ “class“ in request / response)

4. eHealth/encounter_classestypes (parameter “class“ “type“ in request / response)

5. SPECIALITY_TYPE (parameter “performer_speciality“ in request / response)

Input parameters

Request structure

See on API-specification

Headers

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)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

1. Get all patient's encounters

2. Filter using Forbidden Groups

3. Apply filters provided by user

Response structure examples

See on API-specification

...

...

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0",
      "status": "finised",
      "date": "2018-08-02T10:45:16.000Z",
      "episode": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "class": {
        "system": "eHealth/encounter_classes",
        "code": "inpatient"
      },
      "type": {
        "coding": [
          {
            "system": "eHealth/encounter_types",
            "code": "discharge"
          }
        ]
      },
      "performer_speciality": {
        "coding": [
          {
            "system": "SPECIALITY_TYPE",
            "code": "VIROLOGY"
          }
        ]
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)