Skip to main content

ProductDispensationRequest

A single product being dispensed against an authorization or prescription.

idstringrequired

Product line identifier from the source authorization or prescription.

product_codestring

Provider-side SKU for the product being dispensed.

pricenumberrequired

Unit price. Decimal number.

taxesnumberrequired

Taxes applied to this line. Decimal number.

quantityinteger<int32>required

Quantity of the original product dispensed.

substitute_product_codestring

Provider-side SKU of the substitute product used, when the original was not dispensed.

substitute_quantityinteger<int32>

Quantity of the substitute product dispensed.

substitution_reasonstring

Free-form reason describing why a substitute was dispensed.

substitution_other_descriptionstring

Additional explanation when 'substitution_reason_enum' is OTHER.

substitution_reason_enumstring

Substitution reason as an enum. One of OUT_OF_STOCK, EMERGENCY, ACTIVE_INGREDIENT, OTHER.

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: [OUT_OF_STOCK, EMERGENCY, ACTIVE_INGREDIENT, OTHER]