Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

1. eHealth/resources - service_request (parameter “based_on“ in response)

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

3. eHealth/procedure_status_reasons (parameter “status_reason“ in response)

4. eHealth/resources - service (parameter “code“ in response)

5. eHealth/resources - employee (parameter “recorded_by“ in response)

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

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

8. eHealth/resources - legal_entity (parameter “managing_organization“ in response)

9. eHealth/resources - reason_references (parameter “condition“ in response)

10. eHealth/resources - equipment (parameter “used_references“ in response)

11. eHealth/procedure_outcomes (parameter “outcome“ in response)

12. eHealth/procedure_categories (parameter “category“ in response)

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

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

15. eHealth/resources - condition (parameter “complication_details“ in response)

16. eHealth/assistive_products(parameter “used_codes“ in response)

17. procedure_focal_device_actions (parameter “focal_device“ in response)

...

Request to process the request using a token in the headers

Processing

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

Response structure examples

...