Skip to content

Retrieve prescribing options

GET/v1/catalog/items/{catalogItemId}/prescribing-options

Requires catalog:read. Returns reviewed SIG presets, guided patterns, quantity constraints and product requirements for a practice and mode. Revisions identify changed defaults. No patient-specific rationale or diagnosis is inferred.

PracticesAPI key authenticationVersion 2026-09-28

Request example

curl -X GET 'https://api.affinityrx.com/v1/catalog/items/{catalogItemId}/prescribing-options' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28'

Response example

These examples show the body structure. Values can differ. Select a status code to see its response.

{
  "compoundingReason": {
    "required": false,
    "categoryRequired": false,
    "context": "not_supported",
    "contextPrompt": "<string>",
    "choices": [
      {
        "category": "alcohol_free",
        "label": "<string>",
        "contextRequired": false,
        "contextPrompt": "<string>"
      }
    ]
  },
  "compoundingReasonCategoryDefault": "alcohol_free",
  "compoundingReasonDefault": "<string>",
  "default": {
    "directions": "<string>",
    "format": "free_text",
    "source": "affinity",
    "structuredSig": {
      "dose": "<string>",
      "doseUnit": "<string>",
      "duration": "<string>",
      "frequency": "<string>",
      "maxDailyUse": "<string>",
      "prn": false,
      "route": "<string>",
      "titrationSchedule": "<string>"
    }
  },
  "formulationDefault": {
    "directions": "<string>",
    "format": "free_text",
    "structuredSig": {
      "dose": "<string>",
      "doseUnit": "<string>",
      "duration": "<string>",
      "frequency": "<string>",
      "maxDailyUse": "<string>",
      "prn": false,
      "route": "<string>",
      "titrationSchedule": "<string>"
    }
  },
  "initial": {
    "dose": "<string>",
    "doseUnit": "<string>",
    "duration": "<string>",
    "frequency": "<string>",
    "maxDailyUse": "<string>",
    "prn": false,
    "route": "<string>",
    "titrationSchedule": "<string>"
  },
  "medication": {
    "name": "<string>",
    "rxnorm": {
      "code": "<string>",
      "display": "<string>",
      "doseForm": "<string>",
      "route": "<string>",
      "system": "rxnorm"
    }
  },
  "options": {
    "doseUnits": [
      {
        "label": "<string>",
        "source": "catalog",
        "value": "<string>"
      }
    ],
    "doses": [
      {
        "label": "<string>",
        "source": "catalog",
        "value": "<string>"
      }
    ],
    "frequencies": [
      {
        "label": "<string>",
        "source": "catalog",
        "value": "<string>"
      }
    ],
    "routes": [
      {
        "label": "<string>",
        "source": "catalog",
        "value": "<string>"
      }
    ]
  },
  "pharmacyDirections": [
    {
      "directions": "<string>",
      "format": "free_text",
      "structuredSig": {
        "dose": "<string>",
        "doseUnit": "<string>",
        "duration": "<string>",
        "frequency": "<string>",
        "maxDailyUse": "<string>",
        "prn": false,
        "route": "<string>",
        "titrationSchedule": "<string>"
      }
    }
  ],
  "templates": [
    {
      "id": "<string>",
      "initial": {
        "dose": "<string>",
        "doseUnit": "<string>",
        "duration": "<string>",
        "frequency": "<string>",
        "maxDailyUse": "<string>",
        "prn": false,
        "route": "<string>"
      },
      "label": "<string>",
      "preview": "<string>",
      "revision": "<string>"
    }
  ],
  "object": "prescribing_options",
  "catalogItemId": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
  "practiceId": "prac_01j2y8m6jcc9tt24af5pw9x1bc",
  "livemode": false,
  "revision": "<string>",
  "catalog": {
    "catalogDetails": {
      "packageComponents": [
        {
          "container": "<string>",
          "containerCount": "<string>",
          "contentsPerContainer": {
            "value": "<string>",
            "unit": "mg"
          }
        }
      ],
      "attributes": "<string>",
      "directions": [
        {
          "kind": "suggested",
          "text": "<string>"
        }
      ]
    },
    "composition": {
      "status": "complete",
      "ingredients": [
        {
          "name": "<string>",
          "role": "active",
          "basisOfStrengthSubstance": {
            "name": "<string>"
          },
          "strength": {
            "kind": "amount",
            "amount": {
              "value": null,
              "unit": "<string>"
            }
          }
        }
      ]
    },
    "allowedStates": [
      "<string>"
    ],
    "availability": "available",
    "catalogKind": "<string>",
    "fulfillmentInclusions": [
      {
        "amountCents": 0,
        "kind": "cold_chain",
        "label": "<string>",
        "priceComponent": "shipping"
      }
    ],
    "ordering": {
      "requiresPrescription": false,
      "requiresAccompanyingPrescription": false,
      "shipping": "prescription"
    },
    "category": "<string>",
    "coldShip": false,
    "pharmacyId": "pharm_01j2y8m6jcc9tt24af5pw9x1bc",
    "pharmacyName": "<string>",
    "description": "<string>",
    "dosageForm": "<string>",
    "facilityType": "<string>",
    "id": "cat_01j2y8m6jcc9tt24af5pw9x1bc",
    "imageUrl": "<string>",
    "imageUrls": "<string>",
    "medicationGroup": {
      "offerCount": 0,
      "pharmacyCount": 0,
      "strengths": [
        "<string>"
      ]
    },
    "isOrderable": false,
    "livemode": false,
    "name": "<string>",
    "object": "catalog_item",
    "patientSpecificRequired": false,
    "quantityConstraint": {
      "kind": "fixed",
      "quantity": {
        "value": "<string>",
        "unit": "<string>"
      }
    },
    "prescriptionRequirements": {
      "allowedDaysSupply": [
        0
      ],
      "allowedQuantities": [
        {
          "daysSupply": 0,
          "label": "<string>",
          "unit": "<string>",
          "value": 0
        }
      ],
      "allowedReasonCategories": [
        "alcohol_free"
      ],
      "reasonCategoryLabels": "<string>",
      "compoundingReason": "not_required",
      "compoundingReasonContext": "not_supported",
      "controlledSchedule": "II",
      "defaultDaysSupply": 0,
      "defaultQuantity": {
        "unit": "<string>",
        "value": 0
      },
      "quantityIncrement": {
        "max": 0,
        "min": 0,
        "unit": "<string>",
        "value": 0
      },
      "defaultSigs": [
        "<string>"
      ],
      "diagnosis": "not_required",
      "medicationReview": "optional",
      "diagnosisReview": "optional",
      "maxRefills": 0,
      "notes": [
        "<string>"
      ],
      "pharmacyNotes": "not_supported",
      "refills": "not_supported",
      "substitution": "not_supported"
    },
    "pricing": {
      "amountCents": "<string>",
      "basis": {
        "kind": "item",
        "quantity": "1",
        "unit": "<string>",
        "quantityPrices": "<string>"
      },
      "currency": "USD",
      "medicationSubtotalCents": "<string>"
    },
    "restrictedStates": [
      "<string>"
    ],
    "route": "<string>",
    "shippingOptions": [
      {
        "amountCents": "<string>",
        "carrier": "<string>",
        "currency": "USD",
        "destinationTypes": [
          "patient"
        ],
        "estimatedDaysMax": "<string>",
        "estimatedDaysMin": "<string>",
        "id": "shp_01j2y8m6jcc9tt24af5pw9x1bc",
        "label": "<string>",
        "serviceLevel": "<string>",
        "temperatures": [
          "ambient"
        ]
      }
    ],
    "strength": "<string>",
    "unit": "<string>"
  },
  "defaultPresetId": "<string>",
  "presets": [
    {
      "id": "<string>",
      "revision": "<string>",
      "source": "affinity",
      "directions": "<string>",
      "format": "structured",
      "structuredSig": {
        "dose": "<string>",
        "doseUnit": "<string>",
        "frequency": "<string>",
        "route": "<string>",
        "prn": false,
        "duration": "<string>",
        "indication": "<string>",
        "maxDailyUse": "<string>",
        "titrationSchedule": "<string>"
      },
      "quantity": {
        "value": 0,
        "unit": "<string>"
      },
      "daysSupply": 0,
      "refills": 0
    }
  ]
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 400,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 401,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 403,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 404,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 409,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 429,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

Implementation specification

Use these field types and limits to build your integration. Download the OpenAPI document for the complete contract.

Path parameters

catalogItemIdstringrequired

Pattern: ^cat_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query parameters

practiceIdstringrequired

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

Headers

Affinity-Versionstring

Selects the HTTP API contract for this request only. When omitted, API-key requests use their service account’s stored version. Does not change the stored default.

Pin requests to 2026-09-28.

Response specifications

200Successful response

application/json

compoundingReasonobjectrequired

No additional properties

Show compoundingReason fields
requiredbooleanrequired
categoryRequiredbooleanrequired
contextstringrequired

Allowed: "not_supported", "optional", "required"

contextPromptstring | nullrequired
Show contextPrompt fields
Any of · 1: string

string

Any of · 2: null

null

choicesobject[]required
Show choices fields

Array items · object

categorystringrequired

Allowed: "alcohol_free", "drug_shortage", "commercial_product_discontinued", "modified_release", "inactive_ingredient_sensitivity", "inactive_ingredient_toxicity", "concentration_adjustment", "alternate_route", "dosage_form_unavailable", "flavor_adjustment", "tablet_burden", "patient_cannot_use_commercial_product", "no_approved_product_available", "no_rationale_required", "other_patient_specific_need"

labelstringrequired
contextRequiredbooleanrequired
contextPromptstring | nullrequired
Show contextPrompt fields
Any of · 1: string

string

Any of · 2: null

null

compoundingReasonCategoryDefaultstring | nullrequired
Show compoundingReasonCategoryDefault fields
Any of · 1: string

string

Allowed: "alcohol_free", "drug_shortage", "commercial_product_discontinued", "modified_release", "inactive_ingredient_sensitivity", "inactive_ingredient_toxicity", "concentration_adjustment", "alternate_route", "dosage_form_unavailable", "flavor_adjustment", "tablet_burden", "patient_cannot_use_commercial_product", "no_approved_product_available", "no_rationale_required", "other_patient_specific_need"

Any of · 2: null

null

compoundingReasonDefaultstring | nullrequired
Show compoundingReasonDefault fields
Any of · 1: string

string

Any of · 2: null

null

defaultobject | nullrequired
Show default fields
Any of · 1: object
directionsstringrequired
formatstringrequired

Allowed: "free_text", "structured"

sourcestringrequired

Allowed: "affinity", "catalog", "pharmacy"

structuredSigobject | nullrequired
Show structuredSig fields
Any of · 1: object
dosestringrequired
doseUnitstringrequired
durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystringrequired
maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

prnbooleanrequired
routestringrequired
titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

formulationDefaultobject | nullrequired
Show formulationDefault fields
Any of · 1: object
directionsstringrequired
formatstringrequired

Allowed: "free_text", "structured"

structuredSigobject | nullrequired
Show structuredSig fields
Any of · 1: object
dosestringrequired
doseUnitstringrequired
durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystringrequired
maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

prnbooleanrequired
routestringrequired
titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

initialobjectrequired

No additional properties

Show initial fields
dosestring | null
Show dose fields
Any of · 1: string

string

Any of · 2: null

null

doseUnitstring | null
Show doseUnit fields
Any of · 1: string

string

Any of · 2: null

null

durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystring | null
Show frequency fields
Any of · 1: string

string

Any of · 2: null

null

maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

prnboolean | null
Show prn fields
Any of · 1: boolean

boolean

Any of · 2: null

null

routestring | null
Show route fields
Any of · 1: string

string

Any of · 2: null

null

titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

medicationobjectrequired

No additional properties

Show medication fields
namestringrequired
rxnormobject | nullrequired
Show rxnorm fields
Any of · 1: object
codestringrequired
displaystringrequired
doseFormstringrequired
routestringrequired
systemstringrequired

Allowed: "rxnorm"

Any of · 2: null

null

optionsobjectrequired

No additional properties

Show options fields
doseUnitsobject[]required
Show doseUnits fields

Array items · object

labelstringrequired
sourcestringrequired

Allowed: "catalog", "pharmacy", "rxnorm"

valuestringrequired
dosesobject[]required
Show doses fields

Array items · object

labelstringrequired
sourcestringrequired

Allowed: "catalog", "pharmacy", "rxnorm"

valuestringrequired
frequenciesobject[]required
Show frequencies fields

Array items · object

labelstringrequired
sourcestringrequired

Allowed: "catalog", "pharmacy", "rxnorm"

valuestringrequired
routesobject[]required
Show routes fields

Array items · object

labelstringrequired
sourcestringrequired

Allowed: "catalog", "pharmacy", "rxnorm"

valuestringrequired
pharmacyDirectionsobject[]required
Show pharmacyDirections fields

Array items · object

directionsstringrequired
formatstringrequired

Allowed: "free_text", "structured"

structuredSigobject | nullrequired
Show structuredSig fields
Any of · 1: object
dosestringrequired
doseUnitstringrequired
durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystringrequired
maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

prnbooleanrequired
routestringrequired
titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

templatesobject[]required
Show templates fields

Array items · object

idstringrequired
initialobjectrequired

No additional properties

Show initial fields
dosestring | null
Show dose fields
Any of · 1: string

string

Any of · 2: null

null

doseUnitstring | null
Show doseUnit fields
Any of · 1: string

string

Any of · 2: null

null

durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

frequencystring | null
Show frequency fields
Any of · 1: string

string

Any of · 2: null

null

maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

prnboolean | null
Show prn fields
Any of · 1: boolean

boolean

Any of · 2: null

null

routestring | null
Show route fields
Any of · 1: string

string

Any of · 2: null

null

labelstringrequired
previewstringrequired
revisionstringrequired

Maximum length: 100

objectstringrequired

Allowed: "prescribing_options"

catalogItemIdstringrequired

Pattern: ^cat_[0-7][0-9a-hjkmnp-tv-z]{25}$

practiceIdstringrequired

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

livemodebooleanrequired
revisionstringrequired

Maximum length: 100

catalogobjectrequired

No additional properties

Show catalog fields
catalogDetailsobjectrequired

No additional properties

Show catalogDetails fields
packageComponentsobject[] | null

Confirmed physical containers and contents. Empty or absent means container count cannot be inferred from dispense quantity.

Show packageComponents fields
Any of · 1: object[]

Array items · object

containeranyrequired
Show container fields
All of · 1: any

any

Minimum length: 1

containerCountanyrequired
Show containerCount fields
All of · 1: any

any

Greater than: 0

contentsPerContainerobjectrequired

No additional properties

Show contentsPerContainer fields
valueany & anyrequired
Show value fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

unitstringrequired

Allowed: "mg", "g", "ug", "mL", "L", "[IU]", "tablet", "capsule", "troche", "actuation", "patch", "package", "container"

Any of · 2: null

null

attributesobjectrequired
directionsobject[]required
Show directions fields

Array items · object

kindstringrequired

Allowed: "suggested", "template"

textstringrequired
compositionobjectrequired

No additional properties

Show composition fields
statusstringrequired

Allowed: "complete", "partial", "unresolved"

ingredientsobject[]required
Show ingredients fields

Array items · object

namestringrequired
rolestringrequired

Allowed: "active", "inactive"

basisOfStrengthSubstanceobject | nullrequired
Show basisOfStrengthSubstance fields
Any of · 1: object
namestringrequired
Any of · 2: null

null

strengthobjectrequired
Show strength fields
Any of · 1: object
kindstringrequired

Allowed: "amount"

amountobjectrequired

No additional properties

Show amount fields
valueanyrequired
Show value fields
All of · 1: any

any

Pattern: ^(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$

unitstringrequired
Any of · 2: object
kindstringrequired

Allowed: "ratio"

numeratorobjectrequired

No additional properties

Show numerator fields
valueanyrequired
Show value fields
All of · 1: any

any

Pattern: ^(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$

unitstringrequired
denominatorobjectrequired

No additional properties

Show denominator fields
valueanyrequired
Show value fields
All of · 1: any

any

Pattern: ^(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$

unitstringrequired
Any of · 3: object
kindstringrequired

Allowed: "unresolved"

reasonstringrequired
allowedStatesstring[]required
Show allowedStates fields

Array items · string

string

availabilitystringrequired

Allowed: "available", "backordered", "unavailable", "unknown"

catalogKindstringrequired
fulfillmentInclusionsobject[]required
Show fulfillmentInclusions fields

Array items · object

amountCentsintegerrequired
kindstringrequired

Allowed: "cold_chain", "injection_supplies"

labelstringrequired
priceComponentstringrequired

Allowed: "shipping"

orderingobjectrequired

No additional properties

Show ordering fields
requiresPrescriptionbooleanrequired
requiresAccompanyingPrescriptionbooleanrequired
shippingstringrequired

Allowed: "prescription", "accompanying_prescription"

categorystring | nullrequired
Show category fields
Any of · 1: string

string

Any of · 2: null

null

coldShipbooleanrequired
pharmacyIdanyrequired
Show pharmacyId fields
All of · 1: any

any

Pattern: ^pharm_[0-7][0-9a-hjkmnp-tv-z]{25}$

pharmacyNamestringrequired
descriptionstringrequired
dosageFormstringrequired
facilityTypestringrequired
idanyrequired
Show id fields
All of · 1: any

any

Pattern: ^cat_[0-7][0-9a-hjkmnp-tv-z]{25}$

imageUrlstring | nullrequired

Primary product photo, falling back to dosage-form artwork. Null when neither is available.

Show imageUrl fields
Any of · 1: string

string

Any of · 2: null

null

imageUrlsanyrequired
Show imageUrls fields

Array items · string

string

All of · 1: any

any

Maximum items: 40

medicationGroupobject | null
Show medicationGroup fields
Any of · 1: object
offerCountnumber | stringrequired
Show offerCount fields
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

pharmacyCountnumber | stringrequired
Show pharmacyCount fields
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

strengthsstring[]required
Show strengths fields

Array items · string

string

Any of · 2: null

null

isOrderablebooleanrequired
livemodebooleanrequired
namestringrequired
objectstringrequired

Allowed: "catalog_item"

patientSpecificRequiredbooleanrequired
quantityConstraintobject | nullrequired
Show quantityConstraint fields
Any of · 1: object
Any of · 1: object
kindstringrequired

Allowed: "fixed"

quantityobjectrequired

No additional properties

Show quantity fields
valueany & anyrequired
Show value fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

Any of · 2: object
kindstringrequired

Allowed: "choices"

quantitiesobject[]required

Minimum items: 1

Show quantities fields

Array items · object

valueany & anyrequired
Show value fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

Item 1 · object
valueany & anyrequired
Show value fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

Any of · 3: object
kindstringrequired

Allowed: "range"

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

minimumany & any | nullrequired
Show minimum fields
Any of · 1: any & any
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

Any of · 2: null

null

maximumany & any | nullrequired
Show maximum fields
Any of · 1: any & any
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

Any of · 2: null

null

incrementany & any | nullrequired
Show increment fields
Any of · 1: any & any
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

Any of · 2: null

null

Any of · 4: object
kindstringrequired

Allowed: "unresolved"

sourceTextstringrequired
Any of · 2: null

null

prescriptionRequirementsobjectrequired

No additional properties

Show prescriptionRequirements fields
allowedDaysSupplyinteger[] | null
Show allowedDaysSupply fields
Any of · 1: integer[]

Array items · integer

integer

Any of · 2: null

null

allowedQuantitiesobject[] | null
Show allowedQuantities fields
Any of · 1: object[]

Array items · object

daysSupplyinteger | null
Show daysSupply fields
Any of · 1: integer

integer

Any of · 2: null

null

labelstringrequired
unitstringrequired
valuenumber | stringrequired
Show value fields
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

allowedReasonCategoriesstring[] | null
Show allowedReasonCategories fields
Any of · 1: string[]

Array items · string

string

Allowed: "alcohol_free", "drug_shortage", "commercial_product_discontinued", "modified_release", "inactive_ingredient_sensitivity", "inactive_ingredient_toxicity", "concentration_adjustment", "alternate_route", "dosage_form_unavailable", "flavor_adjustment", "tablet_burden", "patient_cannot_use_commercial_product", "no_approved_product_available", "no_rationale_required", "other_patient_specific_need"

Any of · 2: null

null

reasonCategoryLabelsobject | null
Show reasonCategoryLabels fields
Any of · 1: object
Additional properties

string

object

Any of · 2: null

null

compoundingReasonstringrequired

Allowed: "not_required", "optional", "required"

compoundingReasonContextstring | null
Show compoundingReasonContext fields
Any of · 1: string

string

Allowed: "not_supported", "optional", "required"

Any of · 2: null

null

controlledSchedulestring | null
Show controlledSchedule fields
Any of · 1: string

string

Allowed: "II", "III", "IV", "V"

Any of · 2: null

null

defaultDaysSupplyinteger | null
Show defaultDaysSupply fields
Any of · 1: integer

integer

Any of · 2: null

null

defaultQuantityobject | null
Show defaultQuantity fields
Any of · 1: object
unitstringrequired
valuenumber | stringrequired
Show value fields
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

quantityIncrementobject | null
Show quantityIncrement fields
Any of · 1: object
maxnumber | string | null
Show max fields
Any of · 1: number | string
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

minnumber | string | null
Show min fields
Any of · 1: number | string
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

unitstringrequired
valuenumber | stringrequired
Show value fields
Any of · 1: number

number

Any of · 2: string

string

Allowed: "Infinity", "-Infinity", "NaN"

Any of · 2: null

null

defaultSigsstring[] | null
Show defaultSigs fields
Any of · 1: string[]

Array items · string

string

Any of · 2: null

null

diagnosisstringrequired

Allowed: "not_required", "optional", "required"

medicationReviewstring | null
Show medicationReview fields
Any of · 1: string

string

Allowed: "optional", "required"

Any of · 2: null

null

diagnosisReviewstring | null
Show diagnosisReview fields
Any of · 1: string

string

Allowed: "optional", "required"

Any of · 2: null

null

maxRefillsinteger | null
Show maxRefills fields
Any of · 1: integer

integer

Any of · 2: null

null

notesstring[] | null
Show notes fields
Any of · 1: string[]

Array items · string

string

Any of · 2: null

null

pharmacyNotesstringrequired

Allowed: "not_supported", "optional"

refillsstringrequired

Allowed: "not_supported", "optional"

substitutionstringrequired

Allowed: "not_supported", "optional"

pricingobject | nullrequired
Show pricing fields
Any of · 1: object
amountCentsanyrequired
Show amountCents fields
All of · 1: any

any

Minimum: 0

basisobjectrequired
Show basis fields
Any of · 1: object
kindstringrequired

Allowed: "item"

quantitystringrequired

Allowed: "1"

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

quantityPricesany | null
Show quantityPrices fields
Any of · 1: any

Array items · object

quantityany & anyrequired
Show quantity fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

amountCentsanyrequired
Show amountCents fields
All of · 1: any

any

Greater than: 0

All of · 1: any

any

Minimum items: 1

Any of · 2: null

null

Any of · 2: object
kindstringrequired

Allowed: "package"

quantityany & anyrequired
Show quantity fields
All of · 1: any

any

Maximum length: 100

All of · 2: any

any

Pattern: ^(?:0|[1-9]\d*)(?:\.\d*[1-9])?$

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

Any of · 3: object
kindstringrequired

Allowed: "unit"

quantitystringrequired

Allowed: "1"

unitanyrequired
Show unit fields
All of · 1: any

any

Minimum length: 1

currencystringrequired

Allowed: "USD"

medicationSubtotalCentsanyrequired
Show medicationSubtotalCents fields
All of · 1: any

any

Minimum: 0

Any of · 2: null

null

restrictedStatesstring[]required
Show restrictedStates fields

Array items · string

string

routestringrequired
shippingOptionsobject[]required
Show shippingOptions fields

Array items · object

amountCentsanyrequired
Show amountCents fields
All of · 1: any

any

Minimum: 0

carrierstring | nullrequired
Show carrier fields
Any of · 1: string

string

Any of · 2: null

null

currencystringrequired

Allowed: "USD"

destinationTypesstring[]required
Show destinationTypes fields

Array items · string

string

Allowed: "patient", "practice"

estimatedDaysMaxany | nullrequired
Show estimatedDaysMax fields
Any of · 1: any
All of · 1: any

any

Minimum: 0

Any of · 2: null

null

estimatedDaysMinany | nullrequired
Show estimatedDaysMin fields
Any of · 1: any
All of · 1: any

any

Minimum: 0

Any of · 2: null

null

idanyrequired
Show id fields
All of · 1: any

any

Pattern: ^shp_[0-7][0-9a-hjkmnp-tv-z]{25}$

labelstringrequired
serviceLevelstringrequired
temperaturesstring[]required
Show temperatures fields

Array items · string

string

Allowed: "ambient", "refrigerated"

strengthstring | nullrequired
Show strength fields
Any of · 1: string

string

Any of · 2: null

null

unitstring | nullrequired
Show unit fields
Any of · 1: string

string

Any of · 2: null

null

defaultPresetIdstring | nullrequired
Show defaultPresetId fields
Any of · 1: string

string

Any of · 2: null

null

presetsobject[]required
Show presets fields

Array items · object

idstringrequired
revisionstringrequired

Maximum length: 100

sourcestringrequired

Allowed: "affinity", "pharmacy", "catalog"

directionsstringrequired
formatstringrequired

Allowed: "structured", "free_text"

structuredSigobject | nullrequired
Show structuredSig fields
Any of · 1: object
dosestringrequired
doseUnitstringrequired
frequencystringrequired
routestringrequired
prnbooleanrequired
durationstring | null
Show duration fields
Any of · 1: string

string

Any of · 2: null

null

indicationstring | null
Show indication fields
Any of · 1: string

string

Any of · 2: null

null

maxDailyUsestring | null
Show maxDailyUse fields
Any of · 1: string

string

Any of · 2: null

null

titrationSchedulestring | null
Show titrationSchedule fields
Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

quantityobject | nullrequired
Show quantity fields
Any of · 1: object
valuenumberrequired
unitstringrequired
Any of · 2: null

null

daysSupplyinteger | nullrequired
Show daysSupply fields
Any of · 1: integer

integer

Any of · 2: null

null

refillsintegerrequired
400HTTP 400

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

401Unauthorized

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

403Forbidden

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

404Not found

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

409Conflict

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

429Too many requests

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

Type to search…

↑↓ navigate↵ selectEsc close