ID | ITEM_ATC_RLTD |
---|---|
Method | GET |
URI |
|
Embargo Data | No |
Requires authentication | No |
Description | A table that maps the many-to-many relationships between Items and equivalent ATC's (in the ATC_T table). |
Parameters
Parameter | Description | Default | Required | Example |
format |
specifies the output format | JSON | false | ?format=csv |
include_header |
specifies whether a header is included in the results. Note: only works for CSV output formats. | false | false | ?include_header=true |
download |
specifies whether the request should prompt a download response in the user's browser (Chrome compatible) | false | false | ?download=true |
ATC_CODE |
Code used to represent the chemical, pharmacological and therapeutic grouping of the World Health Organisations ATC classification system - See also "ATC Description" | false | ?ATC_CODE=**exampleValue** |
|
SCHEDULE_CODE |
Schedule Code is a unique identifier given to each month's Schedule. By having a Schedule Code in each table, 13 months (schedules) worth of data can be maintained in the Data Mart to assist users in the identification of Delisted Items and change-over-time. In order to see what year/month/effective date a schedule code refers to, look it up in the SCHEDULE_T table | false | ?SCHEDULE_CODE=**exampleValue** |
|
PBS_CODE |
PBS Item Code relates directly to a Prescribing Rule in PharmCIS. A drug/form combination will have a different PBS Item Code for each combination of maximum quantity (or maximum amount), number of repeats, pack quantity or if the drug/form combination is listed on different programs. This information is required for the PBS website, Schedule of Pharmaceutical Benefits and legislative instruments compiled by the PBS Publishing Team. | false | ?PBS_CODE=**exampleValue** |
|
ATC_PRIORITY_PCT |
For PBS publishing purposes, where a drug is in more than one ATC group the groups are given a priority percentage. The ATC group with the higher priority will be published ahead of lower priority groups. | false | ?ATC_PRIORITY_PCT=**exampleValue** |
Example
curl -d https://aucapiapppbspilot.azurewebsites.net/ITEM_ATC_RLTD?format=csv&include_header=true&schedule_code=2710
Sample Response
Get November 2020 Schedule's ITEM_ATC_RLTD data in CSV format
https://aucapiapppbspilot.azurewebsites.net/ITEM_ATC_RLTD?format=csv&include_header=true&schedule_code=2710
Sample output:
**insert here**
Created on , last edited on 7/12/2020