Skip to main content

Item

idinteger<int64>
codestring
start_datestring<date-time>
end_datestring<date-time>
expires_atstring<date-time>
quantityinteger<int32>
datamatrixstring
datamatrix_imagestring
dispensation_statusstring

Possible values: [DISPENSABLE, LOCKED, DISPENSED, SUBSTITUTED, EXPIRED, PENDING_VISA, VISA_REJECTED, PARTIALLY_DISPENSED, MASTER_FORMULA_ON_GOING, PARTIALLY_SUBSTITUTED, SUSPENDED]

dispensed_quantityinteger<int32>
prescription_item_dispensation_logs object[]
  • Array [
    • prescription_item_codestring
    action_slug_registeredstring
    dispensation_statusstring

    Possible values: [DISPENSABLE, LOCKED, DISPENSED, SUBSTITUTED, EXPIRED, PENDING_VISA, VISA_REJECTED, PARTIALLY_DISPENSED, MASTER_FORMULA_ON_GOING, PARTIALLY_SUBSTITUTED, SUSPENDED]

    dispensed_quantityinteger<int32>
    substitution_reasonstring

    Reason the provider dispensed a substitute product instead of the originally prescribed one.

    • OUT_OF_STOCK: the prescribed product was not available at the point of sale.
    • EMERGENCY: dispensed under emergency conditions.
    • ACTIVE_INGREDIENT: substituted with an equivalent by active ingredient.
    • OTHER: another reason, described in 'substitution_other_description'.

    Possible values: [ACTIVE_INGREDIENT, EMERGENCY, OUT_OF_STOCK, OTHER]

    substitution_descriptionstring
    dispensation_product_idinteger<int64>
    dispensation_product_namestring
    lock_reasonstring

    Possible values: [HIGHER_DOSE_THAN_PRESCRIBED, INTOLERANCE, CONTRAINDICATION, TREATMENT_COMPLETED, OTHER]

    lock_descriptionstring
    void_reasonstring

    Possible values: [DISPENSING_ERROR, WRONG_PRODUCT_IDENTIFICATION, WRONG_CONTAINERS_QUANTITY, WRONG_PATIENT_IDENTIFICATION, SUBSTITUTION_VOID, PRESCRIBER_INDICATION, REFUND]

    created_atstring<date-time>
    created_bystring
  • ]