Back to Index 


 
ID ITEM
Method GET
URI
  • https://aucapiapppbspilot.azurewebsites.net/ITEM
Embargo Data No
Requires authentication No
Description A table that captures the PBS item (drug). One row per unique medicinal product, container and brand per schedule. It contains data related to a pharmaceutical benefit which is required to generate the PBS Legislative Instruments

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
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**
LI_ITEM_ID A unique identifier for each row on the Item_T table generated using the Item Code and PharmCIS internal IDs (PIG ID, MP, MPP, MPUU, TPP, TPUU)
false ?LI_ITEM_ID=**exampleValue**
DRUG_NAME The PBS Schedule drug name
false ?DRUG_NAME=**exampleValue**
LI_DRUG_NAME The legally determined name of a drug used in legislative instruments.
false ?LI_DRUG_NAME=**exampleValue**
LI_FORM The legally determined form (and strength) of a drug used in legislative instruments.
false ?LI_FORM=**exampleValue**
BRAND_NAME Brand or trade name used by the 'responsible person' or supplier of a 'brand' of drug.
false ?BRAND_NAME=**exampleValue**
PROGRAM_CODE A Program Code groups together PBS Items that have the same pricing model and follow the same business rules. Required for the PBS website, Schedule of Pharmaceutical Benefits and legislative instruments compiled by the PBS Publishing Team. Program Code Schedule PBS program EP General Extemporaneous Preparations GE General Generally Available Pharmaceutical Benefits PL General Palliative Care DB General Prescriber Bag R1 RPBS Repatriation Pharmaceutical Benefits Scheme only MF Section 100 Botulinum Toxin Program IN Section 100 Efficient Funding of Chemotherapy - Private Hospital – infusibles IP Section 100 Efficient Funding of Chemotherapy - Public Hospital - infusibles CT Section 100 Efficient Funding of Chemotherapy - Related Benefits TY Section 100 Efficient Funding of Chemotherapy - Private Hospital - Trastuzumab TZ Section 100 Efficient Funding of Chemotherapy - Public Hospital - Trastuzumab GH Section 100 Growth Hormone Program HS Section 100 Highly Specialised Drugs Program - Private Hospital HB Section 100 Highly Specialised Drugs Program - Public Hospital CA Section 100 Highly Specialised Drugs Program - Community Access IF Section 100 IVF Program MD Section 100 Opiate Dependence Treatment Program PQ Section 100 Paraplegic and Quadriplegic Program
false ?PROGRAM_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**
BENEFIT_TYPE_CODE Determines if a benefit is restricted or not and if so the level of authority required for prescribing the benefit. Four levels of restriction catagorisation used for medicines on the PBS . Entered at the prescribing rule(item code) level. U - Unrestricted R - Restricted A - Authority Required S - Authority Required: Streamlined
false ?BENEFIT_TYPE_CODE=**exampleValue**
CAUTION_INDICATOR Indicates that the text is a Caution
false ?CAUTION_INDICATOR=**exampleValue**
NOTE_INDICATOR Indicates that the text is a Note
false ?NOTE_INDICATOR=**exampleValue**
MANNER_OF_ADMINISTRATION A legal instrument terminology that decribes the manner in which a listed drug can be administered
false ?MANNER_OF_ADMINISTRATION=**exampleValue**
MAXIMUM_QUANTITY The maximum quantity of a pharmaceutical benefit allowed to be prescribed/dispensed as recommended by the Pharmaceutical Benefits Advisory Committee (PBAC).
false ?MAXIMUM_QUANTITY=**exampleValue**
NUMBER_OF_REPEATS The number of repeat prescriptions of a pharmaceutical benefit allowed to be prescribed/dispensed as recommended by the Pharmaceutical Benefits Advisory Committee (PBAC).
false ?NUMBER_OF_REPEATS=**exampleValue**
ORGANISATION_ID This is a persistent unique identfier for linking an Item to it's Manufacturer in the Organisation_T table
false ?ORGANISATION_ID=**exampleValue**
PACK_SIZE Request input from PBS Listings
false ?PACK_SIZE=**exampleValue**
PRICING_QUANTITY Request input from PBS Listings
false ?PRICING_QUANTITY=**exampleValue**
PACK_NOT_TO_BE_BROKEN_IND This flag indicates where payment for supply of certain pharmaceutical benefits will only be made if the benefit is supplied as the complete pack.
false ?PACK_NOT_TO_BE_BROKEN_IND=**exampleValue**
MARK_UP_CODE Indicates the type of retail mark-up applied. • A – no mark-up (section 100 drug types), applies to supply in Public Hospitals Drug type codes “Drug Type Code – IP (Public)” and “Drug Type Code – TZ” (Trastuzumab) • C – standard six-tier ready-prepared mark-up; is applied to the individual vial, but calculated on the price to pharmacist for maximum amount determines which tier applies –used for Drug Type Code – IN (Private) –Trastuzumab supplied in private hospitals, drug type code Drug Type Code – TY. Is the same as: • D – HSD four-tier ready-prepared mark-up; the price to pharmacist for maximum amount determines which tier applies.
false ?MARK_UP_CODE=**exampleValue**
DISPENSE_FEE_TYPE_CODE Indicates the type of fee (if any) paid to the pharmacist for dispensing a PBS benefit. The dispensing fee type and values are in the DISP.FEE. XML for reference. The types are: • DD - Dangerous Drug • EP - Extemporaneously prepared • EW - Extemporaneously prepared with water • NF - No Fee • RP - Ready Prepared.
false ?DISPENSE_FEE_TYPE_CODE=**exampleValue**
DANGEROUS_DRUG_FEE_CODE Where a drug is grouped as a dangerous drug in PharmCIS there is a handling fee which applies for dispensing the drug. The dangerous drug fee is paid for supplying dangerous drugs and is in addition to the mark-up and other dispensing fees. Dangerous drugs are listed in Schedule 3 of the National Health (Commonwealth Price and Conditions for Commonwealth Payments for Supply of Pharmaceutical Benefits) Determination 2019.
false ?DANGEROUS_DRUG_FEE_CODE=**exampleValue**
BRAND_PREMIUM A type of Special Patient Contribution, when there is more than one product per item code and the Responsible Person has set the product price above the lowest priced product. The difference is paid by the consumer.
false ?BRAND_PREMIUM=**exampleValue**
THERAPEUTIC_GROUP_PREMIUM A price premium for drugs identified as being therapeutically interchangeable with other drugs and are therefore included in a therapeutic group. The PBS subsidises up to the price of the lowest priced drug in the therapeutic group - the patient pays the difference between the lowest price and the manufacturers price.
false ?THERAPEUTIC_GROUP_PREMIUM=**exampleValue**
CMNWLTH_PRICE_TO_PHARMACIST The Price to Pharmacists is comprised of the ex-manufacutrer price with the added wholesale mark-up where applicable (see Seventh Community Pharmacy Agreement). Used to determine the DPMQ.
false ?CMNWLTH_PRICE_TO_PHARMACIST=**exampleValue**
CMNWLTH_DSP_PRICE_MAX_QTTY The price for dispensing the maximum amount of a product under a given prescribing rule. The DPMQ incorporates the price ex-manufacturer, all fees, mark-ups and patient contributions. Required for the PBS website and Schedule of Pharmaceutical Benefits.
false ?CMNWLTH_DSP_PRICE_MAX_QTTY=**exampleValue**
TGM_PRICE_PHRMCST Therapeutic Group Manufacturer Price to Pharmacists
false ?TGM_PRICE_PHRMCST=**exampleValue**
TGM_DISP_PRICE_MAX_QTTY Therapeutic Group Manufacturer Price for Maximum Quantity
false ?TGM_DISP_PRICE_MAX_QTTY=**exampleValue**
MAN_PRICE_TO_PHARMACIST The Price to Pharmacists is comprised of the ex-manufacturer price with the wholesale mark-up added (see Seventh Community Pharmacy Agreement)
false ?MAN_PRICE_TO_PHARMACIST=**exampleValue**
MAN_DISPNSD_PRICE_MAX_QTTY Same as Common Dispensing Price for Max Qty
false ?MAN_DISPNSD_PRICE_MAX_QTTY=**exampleValue**
MAX_RECORD_VAL_FOR_SAFETY_NET The maximum amount allowed to be recorded on a patients Safety Net Card. The amount comprises the Reimbursement Dispensed price for maximum quantity plus Safety Net Recording fee and is capped at the General Co Payment amount. Abbreviation: MRVSN
false ?MAX_RECORD_VAL_FOR_SAFETY_NET=**exampleValue**
CLAIMED_PRICE The price claimed by a responsible person, by reference to a quantity or number of units, to be the price for sales of a brand of a pharmaceutical item to approved pharmacists. The difference between the Dispensed Price calculated based on the Claimed Price and the Dispensed Price calculated based on the Determined Price (AEMP) is known as a brand premium and is paid by the patient.
false ?CLAIMED_PRICE=**exampleValue**
DETERMINED_PRICE The ex-manufacturer price (minus the wholesale mark-up)
false ?DETERMINED_PRICE=**exampleValue**
DETERMINED_QTTY Where it is not appropriate to display a maximum quantity for a specific drug in the NHL, for example - a drug listed only on the Prescriber Bag, a determined quantity is listed instead of the maximum quantity. Currently this defaults to the maximum quantity entered into PharmCIS.
false ?DETERMINED_QTTY=**exampleValue**
SAFETY_NET_RESUPPLY_RULE_DAYS The number of days that must elapse for a repeat supply of a drug to be counted towards a patients safety net threshold as per the National Health (Pharmaceutical benefits—early supply) Instrument 2015.
false ?SAFETY_NET_RESUPPLY_RULE_DAYS=**exampleValue**
SAFTEY_NET_RESUP_RULE_CNT_IND Flag that indicates if pharmaceutical item is subject to the Safety Net Early Supply Rule
false ?SAFTEY_NET_RESUP_RULE_CNT_IND=**exampleValue**
EXTEMPORANEOUS_INDICATOR Indicator in the Item_T table to identify medicines that are extemporaenous ingredients
false ?EXTEMPORANEOUS_INDICATOR=**exampleValue**
EXTEMPORANEOUS_STANDARD Indicates the Pharmaceutical Reference Standards which must be applied when specific drugs are compounded by a pharmacy.
false ?EXTEMPORANEOUS_STANDARD=**exampleValue**
DOCTORS_BAG_GROUP_ID A group ID indicating groups of medicines on the Prescriber Bag schedule where a prescribers can access one of the drugs from a group per month.
false ?DOCTORS_BAG_GROUP_ID=**exampleValue**
SECTION100_ONLY_INDICATOR A flag indicating that an observation (row in the Item_T table) is unique to the section 100 program/s
false ?SECTION100_ONLY_INDICATOR=**exampleValue**
DOCTORS_BAG_ONLY_INDICATOR A flag indicating that a drug is only listed on the prescriber bag program
false ?DOCTORS_BAG_ONLY_INDICATOR=**exampleValue**
BRAND_SUBSTITION_GROUP_ID A unique schedule equivalence group ID generated in PharmCIS that indicates that brands of the same form of a drug, or brands of different forms of the same drug are equivalent for the purposes of substitution by the pharmacist.
false ?BRAND_SUBSTITION_GROUP_ID=**exampleValue**
BRAND_SUBSTITUTION_GROUP_CODE A schedule equivalence 'code' used in the PBS schedule that indicates that brands of the same form of a drug, or brands of different forms of the same drug are equivalent for the purposes of substitution by the pharmacist. 'a'-flag 'b'-flag if there are two groups of equivalent brands against one item code
false ?BRAND_SUBSTITUTION_GROUP_CODE=**exampleValue**
CONTINUED_DISPENSING_CODE Continued dispensing allows a pharmacist to dispense a one month suppy of medicines to patients without a script if the pharmacist is satisfied that the patient would normally have a script for that medicine. There are two continued dispensing fields in PharmCIS 1. Continued Dispensing Allowed - for standard long term listings available without prescritpion 2. Continued Dispensing Override - for ad hoc additions to the continued dispensing listings
false ?CONTINUED_DISPENSING_CODE=**exampleValue**
SUPPLY_ONLY_INDICATOR A flag indicating a brand under a given item code has a supply only status.
false ?SUPPLY_ONLY_INDICATOR=**exampleValue**
SUPPLY_ONLY_DATE The date from which the supply only flag comes into effect\par
false ?SUPPLY_ONLY_DATE=**exampleValue**
NON_EFFECTIVE_DATE The date from which the medicine is no longer listed on the PBS
false ?NON_EFFECTIVE_DATE=**exampleValue**
PBS_PIG_ID A unique internal PharmCIS ID for the Pharmaceutical Item Group that is unique to a specified drug, form and manner of administration in the PBS listing legislative instruments.
false ?PBS_PIG_ID=**exampleValue**
PBS_MP_ID A unique internal PharmCIS ID for a Medicinal Product
false ?PBS_MP_ID=**exampleValue**
PBS_MPP_ID A unique internal PharmCIS ID for a Medicinal Product Pack
false ?PBS_MPP_ID=**exampleValue**
PBS_TPP_ID A unique internal PharmCIS ID for a Trade Product Pack
false ?PBS_TPP_ID=**exampleValue**
PBS_MPUU_ID A unique internal PharmCIS ID for a Medicinal Product Unit of Use Code
false ?PBS_MPUU_ID=**exampleValue**
PBS_TPUU_ID A unique internal PharmCIS ID for a Trade Product Unit of Use (TPUU)
false ?PBS_TPUU_ID=**exampleValue**

 

Example

curl -d https://aucapiapppbspilot.azurewebsites.net/ITEM?format=csv&include_header=true&schedule_code=2710

Sample Response

Get November 2020 Schedule's ITEM data in CSV format
https://aucapiapppbspilot.azurewebsites.net/ITEM?format=csv&include_header=true&schedule_code=2710

Sample output:

 **insert here**

Created on , last edited on 7/12/2020