Reference Data: Medicine
URLs
Gets all of the medicine products, optionaly can filter the results based on the registration authority, species, and classification
GET /reference/treatment/medicine-products?registration_authority={registration_authority}&species={species}&classification={classification}
Gets the medicine product based on the scheme its registered under and the id for that scheme
GET /reference/treatment/medicine-products/{identifierScheme}/{identifierId}
Searches for medicine products based on the name
GET /reference/treatment/medicine-products/{search}
Data Returned
A call to the Medicine API returns the following fields.
{
"form": "string",
"registrant": "string",
"registrationDate": "DateTimeOffset",
"expiryDate": "DateTimeOffset",
"classification": "string",
"species": "string",
"activeIngredients": {...},
"withholdings": {...},
"meta": {...},
"resourceType": "string",
"approved": "string",
"registeredId": {...},
"self": "string",
"location": {...}
}
Response item | Description | Data type |
---|---|---|
Form | The physical form of a dose of the medicine. Enumeration modified from the PubCRIS database. | Enumeration medicine-form |
Registrant | The registering company or manufacturer of the medicine | String |
Registration Date | The date the medicine was registered in the scheme | Date/Time |
Expiry Date | The date the registration of the medicine in the scheme expires. | Date/Time |
Classification | The classification or type of medicine. Enumeration modified from the PubCRIS database. | Enumeration medicine-classification |
Species | The species that may be treated by this medicine. (Valid values: Buffalo, Cattle, Deer, Elk, Goat, Horse, Pig, Sheep) | Array icarAnimalSpecieType |
Active Ingredients | The active ingredients in the medicine. | Array medicine-ingredient-type |
Withholdings | The withholding periods defined for this medicine for a species for a particular product or food item. | Array medicine-withholding-type |
Resource Type | The fixed discriminator for medicine product reference type | String |
Approved | The approval state for this medicine product | String |
Registered Id | The Id for the medicine product in the given scheme | Identifier |
Self | A link to this specific Medicine Product | URI |
Location | The location where this medicine product is registered | Identifier |
Enumerations
Type: medicine-form
Values:
Aerosol AqueousConcentrate AqueousSuspension AqueousSuspensionWithMicroencapsulatedActive AqueousTopicalSolution Aural-Ophthalmic-Oro/NasoPharyngeal Backline Bait BaitConcentrate BlendingConcentrate Block(Inc.Stick) Briquet CapsuleSuspension Cartridge Collar-Medalion Cream DermalPaste+OralPaste Diagnostic DispersibleConcentrate DryFlowable Dust DustablePowder EarTag EmulsifiableConcentrate EmulsifiableConcentrate+DryFlowable EmulsifiableGranule EmulsifiableSuspension Emulsion Emulsion-OilInWater EncapsulatedGranule FineGranule FishTankMedication Gas(SoilFumigant) GasGeneratingProduct Gel GeneticMaterial GranularFormulation ImpregnatedPlasticStrips ImpregnatedWetTissue Injection Intra-Mammary Intra-RuminalDevice Intra-Vaginal/UterinePrep/Device LaminatedBlanket Liquid LiquidConcentrate LiquidVaporiser LiquifiedGas Lotion MatrixReleaseFormulation MedicatedDressing-TopicalDevice MicroEmulsifiableConcentrate MicroEmulsion Microencapsulated MicroencapsulatedGel MicroencapsulatedPaste Microgranule MixedFormulationOfCapsuleSuspensionAndSuspensionConcentrate MixedFormulationOfCsAndEw Non-AqueousConcentrate OilMiscibleLiquid Oil-BasedSuspensionConcentrate Oil-BasedSuspensionConcentrates Ointment(Inc.Lotion-Salve-Dressing) OralBlock-Lick OralBolus+IntraVaginal/Uterine OralBolus-Chewable OralBolus/Chewable+TopicalSolution/Suspension OralCapsule OralChewable+TopicalCream-Ointment-Paste-Gel OralFood(Can/Semi-Dry/Dry) OralGel OralGranules-Pellets OralPaste OralPowder-Pre-Mix OralSeleniumFertilizer OralSolution/Suspension OralSyrup OralTablet OralTablet+TopicalSolution OtherLiquidsToBeAppliedUndiluted Paint ParenteralImplant-Device ParenteralLiquid/Solution/Suspension Paste Pellet(EgSnailBait) Powder PowderForDrySeedTreatment PressurisedGas PressurisedSpray Ready-To-UseBait RectalSuppository Resin Sachet Shampoo SlowReleaseGenerator(Inc.FleaCollars) SmokeGenerator(FumigantInsectOrFungicide) Soap Soap(Inc.Shampoo) Solid(Inc.MosquitoCoilsAndCandles-Premixes) SolubleConcentrate SolublePowder SolutionForSeedTreatment SuspensionConcentrate SuspensionConcentratesForSeedTreatment(FS) Suspoemulsion Tablet(Inc.Pellet-Bolus-Suppository-Capsule) TabletsForDirectApplication Topical+OralSolution/Suspension TopicalAerosolSpray TopicalCream-Ointment-Paste-Gel-Lotion TopicalDust-Powder TopicalPumpSpray TopicalSoln+Aural-Opthal-Oro TopicalSolution/Suspension TopicalSpray+Lotion ToweletWithImpregnatedLiquid TrackingPowder TransgenicPlant TreatedApparelAndGear UltraLowVolume VaccineOrAntisera VaccinesOrAntiSera VapourReleasingProduct Vet* VeterinaryInhalationAnaesthetics WaterDispersibleGranule WaterDispersibleGranule+AqueousConcentrate WaterMiscibleLiquid WaterSolubleGels WaterSolubleGranules WaxBlock WettablePowder
Type: medicine-classification
values:
ActiveConstituent AlimentarySystem Anaesthetics/Analgesics Antibiotic+Related Antibiotic+Nutritional Antibiotic+Genitourinary Antidotes Antihistamines BrandingSubstance CentralNervousSystem Dermal+EquipDisinfectant DermatologicalPreparations Disinfectant EndocrineSystem Euthanasiates GenitourinarySystem Immuno+Parasite+Nutrition Immunotherapy MusculoskeletalSystem Nutrition+Metabolism OphthalmicPreparations Parasiticide+Nutritional Parasiticides
medicine-withholding-type
Information about the Withholding periods for the medication
{
"hours": "number",
"market": "string",
"species": "string",
"productType": "string",
}
Response item | Description | Data type |
---|---|---|
Hours | The duration that the product must be withheld for in hour | Number |
Market | The market where this withholding period must be followed | String |
Species | The species of animal that this withholding period applies to. (Valid values: Buffalo, Cattle, Deer, Elk, Goat, Horse, Pig, Sheep) | icarAnimalSpecieType |
Product Type | The product that this withholding period applies to. (Valid values: Meat, Milk, Eggs, Honey, Velvet, Fibre, Other) | icarWithdrawalProductType |
medicine-ingredient-type
Identifies the active ingredients in the medicine product
{
"id": "string",
"name": "string"
}
Response item | Description | Data type |
---|---|---|
ID | The ID of the active ingredient | String |
Name | The name of the active ingredient | String |