Skip to main content

CreatePrescriptionRequestV1_1

doctor objectrequired
medical_license_numberstringrequired
country_codestringrequired
patient objectrequired
idinteger<int64>
given_namesstringrequired
surnamesstringrequired
sexstring
date_of_birthstring<date-time>
identity_document_typestring
identity_document_codestring
identity_document_nationality_country_codestring
passport_issuing_country_codestring
passport_issuing_country_namestring
nationality_country_codestring
area_codeinteger<int32>

Possible values: >= 1 and <= 999

phone_numberstring

Possible values: Value must match regular expression ^[+]{0}[(]{0}[0-9]{0}[)]{0}[-\s0-9]*$

email_addressstring

Possible values: Value must match regular expression [a-z0-9!#$%&'*+/=?^_{|}~-]+(?:.[a-z0-9!#$%&'*+/=?^_{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?

tutor_identificationboolean
data_use_consent_grantedboolean
identity_verifiedboolean
allergies object[]
  • Array [
  • idinteger<int64>
    namestringrequired
    codestring
    coding_systemstring
    synonym_idinteger<int64>
    custom_diagnosisboolean
  • ]
  • additional_information object[]
  • Array [
  • fallback_namestringrequired
    slugstringrequired
    valuestringrequired
  • ]
  • diagnoses object[]
  • Array [
  • coding_systemstringrequired

    Coding system used for the diagnosis (for example, ICD-10).

    codestringrequired

    Diagnosis code within the coding system.

    typestring

    Diagnosis type. One of CHIEF_COMPLAINT, DIFFERENTIAL_DIAGNOSIS, MEDICAL_DIAGNOSIS.

  • ]
  • products object[]
  • Array [
  • indexinteger<int32>

    Position of the product within the request. Used to correlate response entries with request entries.

    product_idstring

    Provider-side product identifier. Free-form string.

    pricenumberrequired

    Unit price of the product. Decimal number.

    quantityinteger<int32>required

    Number of units being dispensed or invoiced.

    substitute_product_idstring

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

    substitute_quantityinteger<int32>

    Quantity of the substitute product dispensed.

    authorization_product_idinteger<int64>required

    Identifier of the pre-authorization product line this claim item corresponds to.

  • ]
  • treatments object[]
  • Array [
  • 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_treatments object[]
  • Array [
  • 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}

  • ]
  • additional_notesstring
    laboratory_notesstring
    diagnostic_test_notesstring
    template_slugstring
    observationstring
    ip_addressstring
    user_agentstring
    prescription_idinteger<int64>
    provider_slugsstring[]