/dailymed/labels

POST /api/dailymed/labels

Price: 10 credits

Get a DailyMed drug label by its SPL set id

How to use it

Resolves one DailyMed SPL set id to the full label: the prescribing-information sections with their LOINC codes, the text of each, the tables as rows, the marketed products with their NDC codes, ingredients and package hierarchy, the manufacturing establishments and the label images. Kit components ship as products of their own, linked by `kit_ndc_product_code`; one the label gives no NDC of its own has a null `ndc_product_code` and is identified by name, dosage form and ingredients. The `label_title` field is the short catalogue title ('DUPIXENT (DUPILUMAB) INJECTION, SOLUTION [SANOFI-AVENTIS U.S. LLC]'); `document_title` is the label's own heading, which on a prescription label is the whole Highlights preamble. Section text is plain text with the tables lifted out into `tables`, so read a dosage or adverse-reaction grid there rather than from `text`. A tablet's colour, shape, size, score and imprint are in each product's characteristics, which is what identifies a loose pill.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• setid string required — DailyMed SPL set id (UUID), or a DailyMed drugInfo URL containing it (examples: "595f437d-2729-40bb-9c62-c8ece1f82780", "https://dailymed.nlm.nih.gov/dailymed/drugInfo.cfm?setid=595f437d-2729-40bb-9c62-c8ece1f82780"; minLength: 1)

Response

• @type string (default: "DailymedLabel")
• setid string required
• document_id string nullable
• version integer nullable
• label_title string nullable
• document_title string nullable
• document_type string nullable
• document_type_code string nullable
• published_at integer nullable
• effective_at integer nullable
• labeler string nullable
• labeler_duns_number string nullable
• products array (default: [])
  • @type string (default: "DailymedProduct")
  • ndc_product_code string nullable
  • name string nullable
  • generic_name string nullable
  • dosage_form string nullable
  • route string nullable
  • marketing_category string nullable
  • application_number string nullable
  • marketing_status string nullable
  • marketing_start_at integer nullable
  • marketing_end_at integer nullable
  • combination_product_type string nullable
  • dea_schedule_code string nullable
  • dea_schedule string nullable
  • kit_ndc_product_code string nullable
  • quantity_in_kit string nullable
  • characteristics array (default: [])
    • @type string (default: "DailymedProductCharacteristic")
    • code string required
    • value string required
  • ingredients array (default: [])
    • @type string (default: "DailymedIngredient")
    • name string required
    • unii string nullable
    • strength string nullable
    • is_active boolean (default: false)
    • active_moiety string nullable
  • packages array (default: [])
    • @type string (default: "DailymedPackage")
    • ndc string required
    • package_type string nullable
    • quantity string nullable
    • marketing_status string nullable
    • marketing_start_at integer nullable
    • marketing_end_at integer nullable
    • packages array (default: [])
• establishments array (default: [])
  • @type string (default: "DailymedEstablishment")
  • name string required
  • duns_number string nullable
  • operations array (default: [])
  • ndc_product_codes array (default: [])
• sections array (default: [])
  • @type string (default: "DailymedSection")
  • code string required
  • name string nullable
  • heading string nullable
  • text string nullable
  • highlight string nullable
  • tables array (default: [])
    • @type string (default: "DailymedTable")
    • caption string nullable
    • headers array (default: [])
    • rows array (default: [])
    • footers array (default: [])
  • image_names array (default: [])
  • sections array (default: [])
• images array (default: [])
  • @type string (default: "DailymedImage")
  • name string required
  • url string required
  • mime_type string nullable
  • description string nullable
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Label not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.