Properties of a REST API method document

Purpose

This web service is designed to return conditions by episode_id or encouner_id.

Logic

Configuration parameters

N/A (Not applicable)

Dictionaries

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

2. eHealth/report_origins (parameter “patient“ in response)

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

4. eHealth/ICD10/condition_codes(parameter “code“ in response)

5. eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)

6. eHealth/condition_verification_statuses (parameter “verification_status“ in response)

7. eHealth/condition_severities (parameter “severity“ in response)

8. eHealth/body_sites(parameter “body_sites“ in response)

9. eHealth/condition_stages(parameter “body_sites“ in response)

10. eHealth/ICPC2/reasons(parameter “evidences:codes“ in response)

11. eHealth/resources - observations (parameter “evidences:details“ 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 = 'condition:read')

  1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module

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)