PBS data API – version 3 has been released

Page last updated: 21 Feb 2024

A webinar will be held on Monday 26 February at 3pm, Canberra time (AEDT)

Here are the highlights of what you can look forward to:

API changes

1. There is now a public version of the API, that is open for access to anybody without registration via the HPP. The differences between this and the embargo version are:

a. only schedules that current, or in the past 12 months are included. Future schedules are not available.

b. The public API is rate-limited to 5 requests per minute.

2. The developer portal documentation can now be accessed without authentication.

3. The API now supports pagination so that large requests can be downloaded in pages/chunks.

Data changes

1. The item-increases endpoint has been removed from the API and data model.

2. The incorrect spelling in field name “SAFTEY_NET” in the items endpoint has been fixed.

3. The following fields have been added to the items endpoint:

a.       POLICY_APPLIED_IMDQ60_BASE_FLAG

b.       POLICY_APPLIED_IMDQ60_FLAG

c.       POLICY_APPLIED_BIO_SIM_UP_FLAG

d.       POLICY_APPLIED_INDIG_PHAR_FLAG

4.  The following field has been added to the restrictions endpoint:

a.       VARIATION_RULE_APPLIED

5. Change to formatting of HTML text within the restrictions endpoint:

a.       LI_HTML_TEXT

b.       SCHEDULE_HTML_TEXT

6. The following fields have been added to the prescribing-text endpoint:

a.       APPLY_TO_INCREASE_MQ_FLAG

b.       APPLY_TO_INCREASE_NR_FLAG

7. Several bug fixes and changes to the formatting of the summary-of-changes endpoint:

a.       Correction to SQL syntax in the SQL_STATEMENT field

b.       Addition of a PREVIOUS_DETAIL field

Additional notes

1. Comprehensive release notes, updates to the developer portal, data dictionary and data model are in progress and will be available in coming days.

2. The previous version of the API “v2-beta” will still work but will contain none of the above improvements. 

Webinar details

Monday 26 February, 3.00pm – 3.30pm (AEDT) – Version 3 of the PBS Data API

To join this webinar, use this link:

https://health-au.webex.com/health-au/j.php?MTID=me690063ef3808de989bf3b4c72a1b19f 

If prompted, enter the following details: Meeting number (access code):  2652 186 3176

Meeting password: BGhyCxJM737

To join from a mobile device, dial +61 2 9338 2221, enter the code 2652 186 3176 and #