| ID | ITEM_RESTRICTION_RLTD |
|---|---|
| Method | GET |
| URI |
|
| Embargo Data | No |
| Requires authentication | No |
| Description | A table that maps the many-to-many relationships between Items and Restrictions. It also allows Note and Caution Restrictions to map simultaneoulsy to other. It’s a joining table which uses the various ID’s in the table to look up and return the matching restriction text contained in the restriction text table (RESTRICTION_TEXT_T). |
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 |
RES_CODE |
This is a unique and persistent identifier to identify the Restriction, Caution or Note | false | ?RES_CODE=**exampleValue** |
|
NOTE_RES_CODE |
Request input from Nick Carr | false | ?NOTE_RES_CODE=**exampleValue** |
|
CAUTION_RES_CODE |
Each element of a restriction in PharmCIS has a concept ID. The Caution Restriction Code is the concept ID for a caution. A caution forms part of an items restriction in the PBS schedules but is not included in the restriction in the listing legislation. | false | ?CAUTION_RES_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** |
|
INDICATION_CODE |
The Treatment of Code (ToC) required for the legislative instruments compiled by the PBS Publishing Team. The ToC maps to the legal text of a restriction. | false | ?INDICATION_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** |
|
COMPLEX_AUTHORITY_RQRD_CODE |
Determines if a benefit is CAR or HSD CAR. Complex authorities are dealt with by a specific Services Australia office in Hobart. One of three codes used to determine the complexity of the authority requirement of a restriction. Can be either: - Not complex - must meet the authority requirements as layed out in the restriction - Complex - Non HSD CAR - must meet the authority requirements as layed out in the restriction which will include contacting Services Australia. - Is Complex - HSD CAR must meet the authority requirements as layed out in the restriction which will include contacting Services Australia. HSD CAR drugs are listed in legislation and "Complex Authority Required" Code is a Unique Identifier. | false | ?COMPLEX_AUTHORITY_RQRD_CODE=**exampleValue** |
|
ASSESSMENT_TYPE_CODE |
One of two criteria used to determine the 'level' of authority required from Services Australia for a prescriber to prescribe an authority required medicine Immediate - the authority can be assessed by prescriber answering YES/NO questions i.e. set criteria. Full - the authority needs to be assessed by a someone at Services Australia. This usually requires evidence to be submitted to Services Australia in written form. | false | ?ASSESSMENT_TYPE_CODE=**exampleValue** |
|
CONDITION_TYPE_CODE |
Business to advise | false | ?CONDITION_TYPE_CODE=**exampleValue** |
|
INCREASED_MQR_FLAG |
Description TBA | false | ?INCREASED_MQR_FLAG=**exampleValue** |
|
RESTRICTION_INDICATOR |
This indicates that the linked Text is of type Restriction (as compared to a Note or Caution) | false | ?RESTRICTION_INDICATOR=**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** |
Example
curl -d https://aucapiapppbspilot.azurewebsites.net/ITEM_RESTRICTION_RLTD?format=csv&include_header=true&schedule_code=2710
Sample Response
Get November 2020 Schedule's ITEM_RESTRICTION_RLTD data in CSV format
https://aucapiapppbspilot.azurewebsites.net/ITEM_RESTRICTION_RLTD?format=csv&include_header=true&schedule_code=2710
Sample output:
**insert here**
Created on , last edited on 7/12/2020