Skip to main content

Order

Order API

GET /patients/{id}/orders​

This API serves as a means to access and retrieve medical procedure orders specific to a patient. It is designed to provide valuable information to healthcare professionals and patients alike. The essential details included in the response from the service offer insight into the nature of the medical procedure, the healthcare provider responsible, the related health care service, and the means to access the necessary documentation.

  • PDF URL for Visualizing the Digital Order: One of the key components of the information returned by the API is the URL of the digital order in PDF format. This URL acts as a direct link to the order documentation, enabling quick and easy access to its content. The digital format enhances accessibility, making it convenient for both medical practitioners and patients to review the order details.
  • ID of the Doctor Who Prescribed the Order: The API response includes the ID of the medical professional who prescribed the order. This ID can be used to identify and establish a connection with the responsible doctor. This information is valuable for ensuring clear communication and understanding between patients, healthcare providers, and the medical facility.
  • ID of the Medical Procedure: Each medical order is associated with a specific medical procedure. The API provides the ID of the procedure for which the order was created. This linkage between the order and the procedure is crucial for accurate record-keeping and seamless coordination within the healthcare system.
  • ID of the patient’s health insurances: The API response also includes the ID of the patient’s health insurances which was created. This piece of information helps to create an appoiment’s offer.

URI Parameters​

  • patient_id: Patient's identifier.

Query Parameters​

  • start_date: represents the starting date from which you want to retrieve orders (formatted as "yyyy-mm-dd").
  • end_date: represents the ending date until which you want to retrieve orders (formatted as "yyyy-mm-dd").

Response:​

Code 200
 {
    "orders": [
        {
            "id":"65717250-53a4-4e67-a15a-a38b0c05f4c4",
            "practicioner_id": "8a7c3e1f-449b-4aa7-b2e3-6d987d0b52f1",  
            "patients_health_insurances": "45e00934-8516-4c34-a478-eb27a37678a0",
            "health_care_service_id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
            "date": "2022-11-07",
            "pdf": "https://www.osana.com/order/62a5f527-86f5-4a41-811a-76fdaeed9a7f.pdf",
        }
    ]
}