The RED interchange API provides a request to load and open a patient in RED medical. This may be used when the user uses a patient in an external system and wants to continue with the same patient in RED (e.g. clicking on an appointment in an external scheduling solution to open the selected patient in RED.
The patient is identified by its user readable identifier (visible in the RED patient header).
OpenPatient is a GET request.
{{baseURL}}/{{tenant}}/TI?action=$openpatient&id={{patientidentifier}}
Example: this GET request opens the patient identified by patientidentifier in RED
See RED Interchange API - Postman Collection 0290 - OpenPatient
In order to open a patient by its identifier the external system must know the identifier. There are several ways to provide this.
- RED manages patient identifiers
- Patients are created and managed in RED (manually or by importing data from their insurance smart cards) → Erlkönig - Patienten und Episoden
- The user may enter the patient identifier in the external system. Alternatively patients may be searched in the external system using the RED interchange API → RED interchange API - Search/Read Patients.
- If a patient was identified the external system stores the patient identifier which then can be used for OpenPatient
- The external system manages patient identifiers
- The external system creates patients in RED. The patient identifier may be set in Patient.id → RED interchange API - Create Data Patient
- The external system uses the identifier in OpenPatient
