Skip to main content

CreateFavoriteTreatmentRequest

doctor objectrequired
medical_license_numberstringrequired
country_codestringrequired
treatment object

A medical treatment (typically a drug regimen) submitted with a pre-authorization or prescription request.

brandstring

Commercial or generic drug name.

drug_form_slugstringrequired

Drug presentation slug (for example, 'tablet', 'capsule').

dosage_measurement_unit_slugstringrequired

Unit of measure slug for the dosage.

treatment_duration_daysinteger<int32>required

Total treatment duration in days.

product_idsinteger<int64>[]

Catalog product identifiers for equivalent products.

compositionstring
product_idinteger<int64>
quantityinteger<int32>
additional_notesstring
file_pathstring
number_of_refillsinteger<int32>
refill_numberinteger<int32>
refill_form_datestring<date>
treatment_indicationsstring[]
frequencies object[]required

Administration frequencies.

  • Array [
  • single_dosebooleanrequired

    True when the treatment is administered as a single dose.

    frequency_in_hoursinteger<int32>

    Number of hours between successive doses.

    frequency_in_hour_slugstring
    frequency_by_day_timestring

    Time of day for insulin administration. One of MORNING, AFTERNOON, EVENING.

    specific_administration_time object
    hourinteger<int32>
    minuteinteger<int32>
    secondinteger<int32>
    nanointeger<int32>
    dosagenumber

    Amount administered per dose.

    dosage_rightnumber

    Dosage to apply to the right side (for eye, ear, or nasal drops).

    dosage_leftnumber

    Dosage to apply to the left side (for eye, ear, or nasal drops).

  • ]
  • compositions object[]
  • Array [
  • ingredient_idinteger<int64>required
    composition_measurement_unit_slugstringrequired
    quantitynumberrequired
  • ]
  • simplified_treatment object
    product_idinteger<int64>required
    single_dosebooleanrequired
    dosagenumberrequired
    dosage_unit_of_measurestringrequired
    frequency_in_hoursinteger<int32>

    Possible values: <= 720

    treatment_duration_daysinteger<int32>required

    Possible values: <= 31

    quantityinteger<int32>required
    treatment_extendedbooleanrequired
    extended_byinteger<int32>
    chronic_treatmentboolean
    drug_typestring
    additional_notesstring
    patient_notesstring
    treatment_diagnosesstring
    treatment_indicationstring
    product_namestring
    is_externalboolean
    presentation object
    packaging_codestring
    packaging_typestring
    packaging_labelstring
    packaging_volumeinteger<int32>
    packaging_quantityinteger<int32>
    packaging_volume_unitstring
    pinstring

    Possible values: Value must match regular expression [0-9A-Za-z]{4}

    master_formula object
    ingredients object[]required
  • Array [
  • active_ingredient_idinteger<int64>required
    concentrationnumberrequired
    measurement_unit_slugstringrequired
  • ]
  • single_dosebooleanrequired
    dosagenumberrequired
    dosage_unit_of_measurestringrequired
    frequency_in_hoursinteger<int32>

    Possible values: <= 720

    treatment_duration_daysinteger<int32>required

    Possible values: <= 31

    units_per_packageinteger<int32>required
    treatment_extendedbooleanrequired
    extended_byinteger<int32>
    additional_notesstring
    patient_notesstring
    treatment_diagnosesstring
    treatment_indicationstring
    chronic_treatmentboolean
    administration_routestringrequired
    drug_form_slugstringrequired
    pinstring

    Possible values: Value must match regular expression [0-9A-Za-z]{4}

    individualized_vaccine object
    ingredients object[]required
  • Array [
  • active_ingredient_idinteger<int64>required
    concentrationnumberrequired
    measurement_unit_slugstringrequired
  • ]
  • single_dosebooleanrequired
    dosagenumberrequired
    dosage_unit_of_measurestringrequired
    frequency_in_hoursinteger<int32>

    Possible values: <= 720

    treatment_duration_daysinteger<int32>required

    Possible values: <= 31

    units_per_packageinteger<int32>required
    treatment_extendedbooleanrequired
    extended_byinteger<int32>
    additional_notesstring
    patient_notesstring
    treatment_diagnosesstring
    treatment_indicationstring
    chronic_treatmentboolean
    administration_routestringrequired
    drug_form_slugstringrequired
    pinstring

    Possible values: Value must match regular expression [0-9A-Za-z]{4}