/
Order Service

Order Service

The Order Service module adds methods for working with order data.

Dependencies

The Order Service module is dependent on the following modules:

Methods

getByPatientOrbitaId

Retrieves an order record associated with the specific patient’s Orbita ID

Parameters:

  • id (string): The Orbita ID of the patient

  • formatted (boolean, default = true): Whether or not to return the data in the intermediary model. If false, the raw data will be returned.

Returns: A promise that will resolve with the order record.

Intermediary Model

Certain methods provide an option of returning data raw from Orbita or in the format of the intermediary model that serves as an interface for other modules using the Order Service module. The intermediary order model is:

  • id (string): The Orbita ID of the order record

  • orderId (string): orderId from the Orbita record

  • patientId (string): patientId from the Orbita record

  • originProviderId (string): originProviderId from the Orbita record

  • originLocationId (string): originLocationId from the Orbita record

  • originOrderDateTime (date): originOrderDateTime from the Orbita record

  • referral (object): referral from the Orbita record

  • referralTargetService (string): referralTargetService from the Orbita record, if not specified, will try to fall back to referral.targetService

  • customData (object): customData from the Orbita record

Related content

Patient Service
Patient Service
More like this
Referral Scheduling
Referral Scheduling
More like this