/pmda/drugs/package_insert

POST /api/pmda/drugs/package_insert

Price: 10 credits

Return the structured text of one Japanese prescription-drug package insert. Carries the generic name, every brand name on the insert with its brand and YJ code, the active ingredients, the therapeutic classification, the approval details, the indications, the dosage and administration, the warnings, contraindications and important precautions, the adverse reactions with the frequency band each was recorded at, the drug interactions with their clinical symptoms and mechanism, the revision version and month against the previous one, and every remaining section of the insert as named text.

How to use it

The whole insert is Japanese and is returned as written; nothing is translated. `sections` holds every top-level block of the insert under the regulator's own element names, so anything the typed fields do not carry — pharmacokinetics, clinical trial results, storage, packaging — is there. One insert often covers several presentations of the same drug, which is why `brands` and `yj_codes` are lists. Figures are images inside the archive: `figure_captions` gives their captions and `attachment_names` their file names, and neither is fetchable through this endpoint. An id that does not exist is a 412, because the register answers a bad id with a 200 error page that this endpoint rejects.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• doc_id string required — Package insert id from pmda/drugs/search, shaped {company}_{yj_code}_{bkno}_{version}. A ResultDataSetXML or ResultDataSetPDF URL carrying one is accepted too (examples: "430574_1149019C1149_1_13", "170050_4291435A2025_1_27"; minLength: 1)

Response

• @type string (default: "PmdaPackageInsert")
• id string required
• xml_kind string (default: "")
• drug_type string nullable
• precautions_for_use_reference string nullable
• precautions_for_handling_reference string nullable
• package_insert_number string nullable
• company_identifier string nullable
• company string nullable
• generic_name string nullable
• therapeutic_classification string nullable
• approval_details string nullable
• brands array (default: [])
  • @type string (default: "PmdaInsertBrand")
  • brand_name string (default: "")
  • brand_code string (default: "")
  • yj_code string (default: "")
• yj_codes array (default: [])
• active_ingredients array (default: [])
• revision_version string nullable
• revision_month string nullable
• previous_revision_version string nullable
• previous_revision_month string nullable
• indications string nullable
• dosage_and_administration string nullable
• warnings string nullable
• contraindications string nullable
• important_precautions string nullable
• adverse_reactions array (default: [])
  • @type string (default: "PmdaAdverseReaction")
  • frequency string (default: "")
  • description string (default: "")
• interactions array (default: [])
  • @type string (default: "PmdaDrugInteraction")
  • drug_name string (default: "")
  • clinical_symptoms string (default: "")
  • mechanism_and_risk_factors string (default: "")
• sections array (default: [])
  • @type string (default: "PmdaInsertSection")
  • name string (default: "")
  • text string (default: "")
• figure_captions array (default: [])
• attachment_names array (default: [])
• pdf_url string (default: "")
• xml_url string (default: "")

Errors

• 422 — doc_id was not shaped {company}_{yj_code}_{bkno}_{version}. 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 — No package insert carries that id. 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.