Properties of a REST API method document

Purpose

Return single short Encounter info

Logic

The endpoint returns single short Encounter info

Configuration parameters

N/A (Not applicable)

Dictionaries

1. eHealth/resources - encounter(parameter “encounter_id“ in request)

2. eHealth/encounter_statuses (parameter “status“ in response)

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

4. eHealth/encounter_classes (parameter “class“ in response)

5. eHealth/encounter_types (parameter “type“ in response)

6. SPECIALITY_TYPE (parameter “performer_speciality“ 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)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)