Skip to main content

PrescriptionResource

idinteger<int64>
doctor object
namestring
medical_license_numberstring
specialty_namestring
patient object
idinteger<int64>
given_namesstring
surnamesstring
full_namestring
codestring
ageinteger<int32>
sexstring
date_of_birthstring
identity_document_typestring
identity_document_codestring
nationality_country_codestring
area_codeinteger<int32>
phone_numberstring
email_addressstring
enabledboolean
manually_createdboolean
identity_verifiedboolean
passport_issuing_countrystring
codestring
statusstring
confidentialboolean
signed_document_idstring<uuid>
signaturestring
laboratory_notesstring
diagnostic_test_notesstring
additional_notesstring
diagnoses object[]
  • Array [
  • idinteger<int64>
    coding_systemstring
    codestring
    statusstring

    Per-product decision inside an authorization.

    • APPROVED: the product is covered by the authorization.
    • REJECTED: the product is not covered. 'reason' explains why.
    • MANUAL_APPROVAL_REQUIRED: the product needs manual review by the sponsor before being approved or rejected.

    Possible values: [APPROVED, REJECTED, MANUAL_APPROVAL_REQUIRED]

    reasonstring
  • ]
  • products object[]
  • Array [
  • idinteger<int64>

    Authorization product-line identifier.

    product_idinteger<int64>

    OSIGU catalog product identifier.

    product_namestring

    Product name.

    product_type_slugstring

    Slug of the product type.

    treatment_duration_daysinteger<int32>

    Prescribed treatment duration in days.

    quantityinteger<int32>

    Quantity requested by the doctor.

    authorized_quantityinteger<int32>

    Quantity the sponsor authorized to be dispensed.

    claimed_quantityinteger<int32>

    Quantity that has already been claimed against this line.

    recurrent_treatmentboolean

    True when the product is part of a recurring treatment plan.

    recurrenceinteger<int32>

    Current recurrence number, when 'recurrent_treatment' is true.

    total_of_recurrencesinteger<int32>

    Total number of recurrences authorized for the treatment plan.

    statusstring

    Current status of this product line (for example, APPROVED, REJECTED, PENDING_REVIEW).

    reasonstring

    Free-text explanation of the current status.

    provider_products object[]

    Provider-side SKUs mapped to this authorized product line.

  • Array [
  • provider_slugstring

    Provider slug.

    provider_product_codestring

    Provider-side product code.

  • ]
  • ]
  • treatments object[]
  • Array [
  • brandstring
    drug_form_slugstring
    dosage_measurement_unit_slugstring
    treatment_duration_daysinteger<int32>
    quantityinteger<int32>
    product_idsinteger<int64>[]
    compositionstring
    additional_notesstring
    frequencies object[]
  • Array [
  • single_doseboolean
    frequency_in_hoursinteger<int32>
    frequency_by_day_timestring

    Possible values: [MORNING, AFTERNOON, EVENING]

    specific_administration_time object
    hourinteger<int32>
    minuteinteger<int32>
    secondinteger<int32>
    nanointeger<int32>
    dosagenumber
    dosage_rightnumber
    dosage_leftnumber
  • ]
  • compositions object[]
  • Array [
  • ingredient_idinteger<int64>
    composition_measurement_unit_slugstring
    quantitynumber
  • ]
  • ]
  • simplified_treatments object[]
  • Array [
  • idinteger<int64>
    product_idinteger<int64>
    ingredient_idinteger<int64>
    product_namestring
    codestring
    single_doseboolean
    dosagenumber
    dosage_unit_of_measurestring
    frequency_in_hoursinteger<int32>
    treatment_duration_daysinteger<int32>
    quantityinteger<int32>
    treatment_extendedboolean
    extended_byinteger<int32>
    additional_notesstring
    treatment_indicationstring
    administration_routestring
    narcotic_drugboolean
    psychotropic_drugboolean
    pinstring
    chronic_treatmentboolean
    simplified_treatment_items object[]
  • Array [
  • 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
  • ]
  • ]
  • ]
  • master_formulas object[]
  • Array [
  • idinteger<int64>
    prescription_idinteger<int64>
    codestring
    single_doseboolean
    dosagenumber
    dosage_unit_of_measurestring
    frequency_in_hoursinteger<int32>
    treatment_duration_daysinteger<int32>
    units_per_packageinteger<int32>
    treatment_extendedboolean
    extended_byinteger<int32>
    chronic_treatmentboolean
    additional_notesstring
    intake_descriptionstring
    administration_routestring
    narcotic_drugboolean
    psychotropic_drugboolean
    formula_items object[]
  • Array [
  • 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
  • ]
  • ]
  • formula_ingredients object[]
  • Array [
  • active_ingredient_idinteger<int64>required
    concentrationnumberrequired
    measurement_unit_slugstringrequired
  • ]
  • pinstring
  • ]
  • individualized_vaccines object[]
  • Array [
  • idinteger<int64>
    prescription_idinteger<int64>
    codestring
    single_doseboolean
    dosagenumber
    dosage_unit_of_measurestring
    frequency_in_hoursinteger<int32>
    treatment_duration_daysinteger<int32>
    units_per_packageinteger<int32>
    treatment_extendedboolean
    extended_byinteger<int32>
    chronic_treatmentboolean
    additional_notesstring
    intake_descriptionstring
    administration_routestring
    narcotic_drugboolean
    psychotropic_drugboolean
    formula_items object[]
  • Array [
  • 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
  • ]
  • ]
  • formula_ingredients object[]
  • Array [
  • active_ingredient_idinteger<int64>required
    concentrationnumberrequired
    measurement_unit_slugstringrequired
  • ]
  • pinstring
  • ]
  • medical_devices object[]
  • Array [
  • idinteger<int64>
    product_idinteger<int64>
    product_namestring
    codestring
    treatment_duration_daysinteger<int32>
    quantityinteger<int32>
    treatment_indicationstring
    pinstring
    chronic_treatmentboolean
    items object[]
  • Array [
  • 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
  • ]
  • ]
  • ]
  • prescription_documents object[]
  • Array [
  • codestring
    typestring
    rendering_statusstring
    email_process_statusstring
    links object[]
  • Array [
  • relstring

    Relation of this link to the current resource (for example, 'self', 'next', 'first', 'last').

    hrefstring

    Target URL.

    hreflangstring

    Language of the target resource, when applicable.

    mediastring

    Media type of the target resource, when applicable.

    titlestring

    Human-readable title of the link.

    typestring

    Content type of the target resource.

    deprecationstring

    Deprecation notice for the link, when applicable.

    profilestring

    Profile URI describing the semantics of the target resource.

    namestring

    Optional secondary identifier for the link.

  • ]
  • ]
  • es_simplified_treatments object[]
  • Array [
  • idinteger<int64>
    product_namestring
    codestring
    single_doseboolean
    dosagenumber
    dosage_unit_of_measurestring
    frequency_in_hoursinteger<int32>
    treatment_duration_daysinteger<int32>
    quantityinteger<int32>
    additional_notesstring
    intake_descriptionstring
  • ]
  • prescription_recommendations object[]
  • Array [
  • namestring
    instructionsstring[]
  • ]
  • prescription_treatment_plan object
    namestring
    contentstring
    external_signature_urlstring
    created_atstring<date-time>
    created_bystring
    updated_atstring<date-time>
    updated_bystring
    links object[]
  • Array [
  • relstring

    Relation of this link to the current resource (for example, 'self', 'next', 'first', 'last').

    hrefstring

    Target URL.

    hreflangstring

    Language of the target resource, when applicable.

    mediastring

    Media type of the target resource, when applicable.

    titlestring

    Human-readable title of the link.

    typestring

    Content type of the target resource.

    deprecationstring

    Deprecation notice for the link, when applicable.

    profilestring

    Profile URI describing the semantics of the target resource.

    namestring

    Optional secondary identifier for the link.

  • ]