Concepts
An introduction to the concepts used on the Rupa platform.
Objects
In Rupa, Orders are placed by Practitioners on behalf of Patients. Orders
are comprised of one of more OrderedTests, each of which corresponds to a Lab Test. Each LabTest
belongs to a single LabCompany.
OrderIntents
When using our API, Orders
are created using OrderIntents. OrderIntents
are similar to carts in e-commerce systems: they contain one or more LabTests
and can be used to create Orders
.
An OrderIntent
becomes an Order
by directing the Practitioner
to the URL given in OrderIntent.checkout_url
. You'll learn more about that in Rupa Checkout.
Order lifecycle
Orders
transition through multiple status after being created and before completion. The statuses below represent the normal order flow, but additional statuses can exist.
Your system can be notified of changes to a Practitioner's
Order
via Events sent to your webhook. You'll learn more about that in Results Syncing.
Next
Next, get started by setting up Authentication.