Logo: Department of HealthLogo: Pharmaceutical Benefits SchemeMapping Specification
PBS XML Schema Version 3.1.9

This document details how the information items in the PBS Standard and ANS Text Extracts are related to elements in the PBS XML.

The mapping from the text files to XML is based on version 3.0 (or later) of the PBS XML Schema.

XML Namespaces

The XML Namespace URIs and prefixes used in this document are detailed below:

Prefix

Namespace URI

pbs:

http://schema.pbs.gov.au/

p:

http://pbs.gov.au/

dbk:

http://docbook.org/ns/docbook

db:

http://docbook.org/ns/docbook#

rdf:

http://www.w3.org/1999/02/22-rdf-syntax-ns#

skos:

http://www.w3.org/2004/02/skos/core#

terms:

http://purl.org/dc/terms/

xlink:

http://www.w3.org/1999/xlink

Readme.txt File

This file contains explanatory information about the other files.

The PBS XML Schema describes the structure of PBS XML documents. It is published separately to the PBS XML documents.

Control.txt File

The Control.txt file gives information about the Standard Extract of data, specifying the date it was extracted from the Australian Department of Health and Ageing's database and its date of effect.

Field

XPath

Example

Comments

Publication/Extract

N/A

Environment

N/A

Publication/Extract Date

/pbs:root/pbs:info/terms:valid[1]

Extracted from Mainframe

/pbs:root/pbs:info/terms:created

Fees.txt File

The Fees yyyymmdd.txt file contains details of patient contributions, mark-ups and fees that are relevant to the prices of drugs shown in the file Drug yyyymmdd.txt. It is a free format text file containing the fields listed below.

Patient Contribution

Field

XPath

Example

Comments

Code

Code "C" is represented by the URI http://pbs.gov.au/copayment/concessional.

Code "G" is represented by the URI http://pbs.gov.au/copayment/general.

Contribution type

/pbs:root/rdf:RDF/p:copayment[@rdf:about = "http://pbs.gov.au/copayment/concessional"]/db:title

/pbs:root/rdf:RDF/p:copayment[@rdf:about = "http://pbs.gov.au/copayment/general"]/db:title

Maximum contribution

/pbs:root/pbs:schedule/pbs:values-list/pbs:threshold[@rdf:resource = "http://pbs.gov.au/threshold/concessional"]/pbs:amount

/pbs:root/pbs:schedule/pbs:values-list/pbs:threshold[@rdf:resource = "http://pbs.gov.au/threshold/general"]/pbs:amount

Minimum Safety Net

Obsolete information item.

Container Fee

Field

XPath

Example

Comments

Code

Code "I" is represented by container for "Injectables", identified by URI http://pbs.gov.au/container/injectable.

Code "O" is represented by container for "Other items", identified by URI http://pbs.gov.au/container/other.

Container type

/pbs:root/rdf:RDF/p:container[@rdf:about = "http://pbs.gov.au/container/injectable"]/db:title

/pbs:root/rdf:RDF/p:container[@rdf:about = "http://pbs.gov.au/container/other"]/db:title

Container Fee

/pbs:root/pbs:schedule/pbs:program[pbs:info/pbs:code = "GE"]/pbs:dispensing-rules-list/pbs:dispensing-rule[@rdf:resource = "http://pbs.gov.au/dispensing-rule/rp-s90-cp"]/pbs:container-definitions-list/pbs:container-definition[rdf:resource = "http://pbs.gov.au/container/injectable"]/pbs:amount

/pbs:root/pbs:schedule/pbs:program[pbs:info/pbs:code = "GE"]/pbs:dispensing-rules-list/pbs:dispensing-rule[@rdf:resource = "http://pbs.gov.au/dispensing-rule/rp-s90-cp"]/pbs:container-definitions-list/pbs:container-definition[rdf:resource = "http://pbs.gov.au/container/other"]/pbs:amount

Dispensing Fees

Field

XPath

Example

Comments

Code

Code "DD" is represented by the fee for the "Dangerous Drug" group, identified by the URI http://pbs.gov.au/fee/dangerous-drug.

Code "RP" is represented by the dispensing fee for the "General" program, identified by the URI http://pbs.gov.au/fee/dispensing.

Code "EP" is represented by the dispensing and extemporaneous fees for the "General" program, identified by the URIs http://pbs.gov.au/fee/dispensing and http://pbs.gov.au/fee/extemp.

Code "EW" is represented by the dispensing, extemporaneous and water-added fees for the "General" program, identified by the URIs http://pbs.gov.au/fee/dispensing, http://pbs.gov.au/fee/extemp and http://pbs.gov.au/fee/water-added.

Code "NF" is represented by the fee "No Fee", identified by the URI http://pbs.gov.au/fee/none.

Fee Description

/pbs:root/rdf:RDF/p:fee[@rdf:about = "http://pbs.gov.au/fee/dispensing"]/db:title

/pbs:root/rdf:RDF/p:fee[@rdf:about = "http://pbs.gov.au/fee/dangerous-drug"]/db:title

/pbs:root/rdf:RDF/p:fee[@rdf:about = "http://pbs.gov.au/fee/extemp"]/db:title

/pbs:root/rdf:RDF/p:fee[@rdf:about = "http://pbs.gov.au/fee/water-added"]/db:title

/pbs:root/rdf:RDF/p:fee[@rdf:about = "http://pbs.gov.au/fee/none"]/db:title

Dispensing Fee

pbs:fee-definition/pbs:amount

Combination fees ("EP", "EW") are the sum of their individual fees.

Additional Fee

pbs:fee-definition[@rdf:resource = "http://pbs.gov.au/fee/extra"]/pbs:amount

Markups

Field

XPath

Example

Comments

Code

pbs:markup-band/pbs:code

Each prescribing rule contains a pbs:product-listing//pbs:price/pbs:markup/pbs:amount element that contains the markup added to an individual pricing component.

Drug Types

pbs:markup-band/ancestor::pbs:program/pbs:info/pbs:code

Markup Low Value

pbs:markup-band/pbs:limit

Markup High Value

This value is calculated by finding the next highest limit for the program/dispensing-rule and subtracting $0.01. If there is no higher limit then the value is infinity (or $99999.00 for compatibility with legacy systems).

Markup

pbs:markup-band/pbs:fixed

pbs:markup-band/pbs:variable

Markup bands have both a fixed and a variable component. Whichever is the non-zero amount should be used as the value of this column. For compatibility with legacy systems, if a markup band has both its fixed and variable amounts as non-zero values then the variable amount should be used.

Mnfr.txt File

The Mnfr yyyymmdd.txt file provides name, address, telephone and facsimile number information for the sponsors of drugs listed in the Schedule. The delimiter in this file is the exclamation mark (!).

Field

XPath

Example

Comments

Manufacturer Code

pbs:organisation/pbs:code

A product listing also includes the manufacturer code of the listed product.

Manufacturer Name

pbs:organisation/pbs:title

Street Address

pbs:organisation/pbs:address

The pbs:address element provides a structured address. It may include the following child elements:

  • dbk:street

  • dbk:postcode

  • dbk:state

  • dbk:city

  • dbk:country

  • dbk:otheraddr

Telephone Number

pbs:organisation/pbs:contact/dbk:phone

Mobile phones numbers may also be included.

Facsimile Number

pbs:organisation/pbs:contact/dbk:fax

Email and Web address may also be included.

ATC.txt File

The ATC yyyymmdd.txt file provides information on ATC codes and their meanings. The ATC codes are used to provide the sort order for the drugs in the Schedule. The delimiter in this file is the exclamation mark (!).

Note

The PBS XML includes the ATC information in an embedded RDF tuple-store. Not all RDF tuples may be ATC codes. The ATC hierarchy starts with the tuple @rdf:about = "http://www.whocc.no/ATC".

Field

XPath

Example

Comments

ATC Code

skos:Concept/skos:prefLabel

ATC meaning

skos:Concept/skos:definition

Drug.txt File

The Drug yyyymmdd.txt file contains details of items listed on the PBS and RPBS. The delimiter in this file is the exclamation mark (!).

In the PBS XML, the equivalent of a PBS Item is a prescribing rule. A prescribing rule is represented by a pbs:prescribing-rule element. Prescribing rules for ready-prepared pharmaceuticals contain the pbs:ready-prepared or pbs:solvent-rule child element. Prescribing rules for infusible pharmaceuticals contain the pbs:infusible child element. Prescribing rules for Extemporaneous Preparations contain the pbs:drug-tariff, pbs:standard-formula-preparation or pbs:extemporaneous-preparation child elements.

Prescribing rules with the pbs:drug-tariff, pbs:extemporaneous-preparation or pbs:standard-formula-preparation child element represent Extemporaneously Prepared items and do not appear in this text file.

Prescribing rules with the pbs:solvent-rule child element represent the adding of an approved solvent to an injectable item and do not appear in this text file.

The XPaths given in the following table have the prescribing rule as their initial context.

The pseudo-function "xpointer" means that a hyperlink lookup must be performed using the given value as a URL. All references in PBS XML documents are local, so when using an XSL stylesheet this lookup may be performed with a key.

Field

XPath

Example

Comments

Drug Type Code

ancestor::pbs:program/pbs:info/pbs:code

<program>
  <info>
    <dbk:title>Ready-prepared Pharmaceutical Benefits</dbk:title>
    <code>GE</code>
  </info>

  <dispensing-rules-list>...</dispensing-rules-list>

    <prescribing-rule>...</prescribing-rule>
</program>

ATC (Nordic) Code

xpointer(*/pbs:ATC/@rdf:resource)/skos:prefLabel

<prescribing-rule>
  <code>2709N</code>
  <ready-prepared>
    ...
    <ATC>http://www.whocc.no/ATC#J01AA02</ATC>
    ...
  </ready-prepared>
</prescribing-rule>

...

<rdf:RDF>
  ...
  <skos:Concept rdf:about="http://www.whocc.no/ATC#J01AA02">
    <skos:prefLabel>J01AA02</skos:prefLabel>
    <skos:broader rdf:resource="http://www.whocc.no/ATC#J01AA"/>
    <skos:definition>Doxycycline</skos:definition>
  </skos:Concept>
  ...
</rdf:RDF>

ATC Type

pbs:ready-prepared/pbs:ATC

<prescribing-rule>
  <code>3451P</code>
  <ready-prepared>
    ...
    <ATC>http://www.whocc.no/ATC#C01CA24</ATC>
      <ATC>http://www.whocc.no/ATC#R03CA</ATC>
    ...
  </ready-prepared>
</prescribing-rule>

All ATC element are represented by the code "P".

ATC Print Option

1

All entries have the value "1".

PBS Code

pbs:code

Restriction Flag

pbs:benefit-types-list/pbs:benefit-type[pbs:member-of-list/pbs:member-of[@rdf:resource = "http://pbs.gov.au/prescriber/medical"]]/@rdf:resource

@rdf:resource = "http://pbs.gov.au/benefit-type/unrestricted" maps to "U". @rdf:resource = "http://pbs.gov.au/benefit-type/restricted" maps to "R". @rdf:resource = "http://pbs.gov.au/benefit-type/authority-required" or @rdf:resource = "http://pbs.gov.au/benefit-type/streamlined" map to "A".

Caution Flag

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:caution

xpointer(pbs:prescribing-text-references-list/pbs:caution-reference/@xlink:href)

If any cautions are present, then the value "C" is used. Blank otherwise. caution elements may be indirectly referenced.

Note Flag

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:administrative-advice

xpointer(pbs:prescribing-text-references-list/pbs:administrative-advice-reference/@xlink:href)

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:foreword

xpointer(pbs:prescribing-text-references-list/pbs:foreword-reference/@xlink:href)

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:prescriber-instruction

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:definition

If any notes are present, then the value "N" is used. Blank otherwise. foreword, prescriber-instruction, definition and administrative-advice elements may be indirectly referenced.

Maximum Quantity

pbs:ready-prepared/pbs:maximum-prescribable[@rdf:resource = 'http://pbs.gov.au/reference/unit-of-use']/pbs:value

OR

pbs:ready-prepared/pbs:maximum-prescribable[@rdf:resource = 'http://pbs.gov.au/reference/pack']/pbs:value

OR

pbs:ready-prepared/pbs:maximum-prescribable[not(@rdf:resource)]/pbs:value

OR (for infusibles)

pbs:infusible/pbs:maximum-prescribable[starts-with(@rdf:resource, 'http://pbs.gov.au/reference/unit-of-measure/')]/pbs:value

The pbs:maximum-prescribable element with attribute rdf:resource with value http://pbs.gov.au/reference/unit-of-use is used. If this is not present, then the pbs:maximum-prescribable element with attribute rdf:resource with value http://pbs.gov.au/reference/pack is used. If this is not present, then the pbs:maximum-quantity element with no rdf:resource attribute is used.

For pbs:infusible prescribing rules, this value gives the Maximum Amount. The rdf:resource attribute refers to a terminology concept that represents the unit of measure.

Number of Repeats

*/pbs:number-repeats/pbs:value

Manufacturer's Code

*/pbs:product-listing/pbs:code

There are entries in the text file for each distinct item and brand (TPP).

Pack Size

xpointer(*/pbs:product-listing/pbs:tpp-reference/@xlink:href)/pbs:pack-size

NB. For infusibles the pack size is not the pack content.

Mark-up Code

xpointer(*/pbs:product-listing/pbs:reimbursement/pbs:pharmacist/pbs:price[default dispensing rule]/pbs:markup/@xlink:href)/pbs:code

Dispense Fee Type Code

xpointer(*/pbs:product-listing/pbs:dpmq/pbs:price[default dispensing rule]/pbs:fee/@xlink:href)/rdf:resource

Infusibles: IN

Code "EP" is represented by the fee for the "Extemp Prepared" group, URI http://pbs.gov.au/fee/extemp. Code "EW" is represented by the fee for the "Water Added" group, URI http://pbs.gov.au/fee/water-added. Code "RP" is represented by the fee for the "General" program, URI http://pbs.gov.au/fee/dispensing. Code "NF" is represented by the fee for the "General" program, URI http://pbs.gov.au/fee/none.

Dangerous Drug Fee Code

xpointer(*/pbs:product-listing/pbs:dpmq/pbs:price[default dispensing rule]/pbs:fee/@xlink:href)/rdf:resource

If the MPP is a member of the dangerous drug group, then code "http://pbs.gov.au/fee/dangerous-drug" ("DD")is used.

Brand Premium

pbs:ready-prepared/pbs:product-listing/pbs:dpmq/pbs:price[default dispensing rule]/pbs:contribution[rdf:resource = "http://pbs.gov.au/contribution/brand"]/pbs:amount

<prescribing-rule>
  <code>2709N</code>
  <ready-prepared>
    ...
    <product-listing>
      ...
      <dpmq>
        <price>
	  <contribution rdf:resource="http://pbs.gov.au/contribution/brand">
          <amount>1.53</amount>
          </contribution>
          ...
	</price>
      </dpmq>
    </product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

Left blank for infusible prescribing rules.

Therapeutic Group Premium

ready-prepared/prioduct-listing/dpmq/price[default dispensing rule]/contribution[rdf:resource = "http://pbs.gov.au/contribution/therapeutic-group"]/pbs:amount

<prescribing-rule>
  <code>1002R</code>
  <ready-prepared>
    ...
    <product-listing>
      ...
      <dpmq>
        <price>
	  <contribution rdf:resource="http://pbs.gov.au/contribution/therapeutic-group">
        <amount>1.05</amount>
          </contribution>
	</price>
      </dpmq>
      ...
    </product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

Left blank for infusible prescribing rules.

Commonwealth Price to Pharmacist

*/product-listing/reimbursement/to-pharmacist/price[default dispensing rule]/amount

<prescribing-rule>
  <code>2709N</code>
  <ready-prepared>
    ...
    <product-listing>
      ...
      <reimbursement>
        ...
        <to-pharmacist>
          <price>
	    <dispensing-rule-reference xlink:href="#d4832716">
	      <code>rp-s90-cp</code>
	      ...
	    </dispensing-rule-reference>
            <amount>8.05</amount>
	  </price>
	  ...
        </to-pharmacist>
        ...
      </reimbursement>
    </product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

Commonwealth Dispensed Price for Maximum Quantity

ready-prepared/product-listing/reimbursement/dpmq/price[default dispensing rule]/amount

<prescribing-rule>
  <code>2709N</code>
  <ready-prepared>
    ...
    <product-listing>
      ...
      <reimbursement>
        ...
        <dpmq>
          <price>
	    <dispensing-rule-reference xlink:href="#d4832716">
	      <code>rp-s90-cp</code>
	      ...
	    </dispensing-rule-reference>
            <amount>8.05</amount>
	  </price>
	  ...
        </dpmq>
        ...
      </reimbursement>
    </product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

For infusible prescribing rules this is known as the "Dispensed Price for Maximum Amount".

Therapeutic Group Manufacturer's Price to Pharmacist

ready-prepared/product-listing/lowest/to-pharmacist/price[default dispensing rule]/amount

Left blank for infusible prescribing rules.

Therapeutic Group Manufacturer's Dispensed Price for Maximum Quantity

ready-prepared/product-listing/lowest/dpmq/price[default dispensing rule]/amount

<prescribing-rule>
  <code>2709N</code>
  <ready-prepared>
    ...
    <product-listing>
      <lowest>
        <dpmq>
          <price>
	    <dispensing-rule-reference xlink:href="#d4387456">
	      <code>rp-s90-cp</code>
	    </dispensing-rule-reference>
            <amount>8.05</amount>
	  </price>
	</dpmq>
      </lowest>
      ...
    </product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

Manufacturer's Price to Pharmacist

*/product-listing/prices/to-pharmacist/price[default dispensing rule]/amount

Manufacturer's Dispensed Price for Maximum Quantity

*/product-listing/manufacturer/dpmq/price[default dispensing rule]/amount

Maximum Recordable Value for Safety Net

*/product-listing/maximum-safety-net-value/price[default dispensing rule]/amount

Bioequivalence Indicator

ready-prepared/product-listing/member-of-list/member-of[starts-with(@rdf:resource, "http://pbs.govau/brand-substitution")]

Infusible: a

All members of the same brand substitution group are given the same code ("a", "b", etc). Where an item has brands in different brand substitution groups, the different groups are given different codes ("a", "b", etc).

For infusible prescribing rules, all TPPs listed are considered to be brand-substitutable.

Brand Name

xpointer(*/product-listing/pbs:tpp-reference/@xlink:href)/drug-references-list/tp-reference/code

Drug Name

xpointer(xpointer(*/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/preferred-term

xpointer(infusible/mp-reference/@xlink:href)/preferred-term

The use of mp-reference in an infusible is a short-cut. Referencing the mpp-reference in an infusible in the same manner as a ready-prepared item is also valid.

Form and Strength

xpointer(ready-prepared/mpp-reference/@xlink:href)/preferred-term

self::prescribing-rule[infusible]/preferred-term

NoteExtract.txt File

The NoteExtract yyyymmdd.txt lists all Note ids and their descriptions. It is used for linking to values in the LinkExtract and PBS Item Table files below. The NoteExtract file is ASCII tab delimited.

In the PBS XML, notes are contained in foreword, prescriber-instruction, administrative-advice and definition elements. These may be referenced directly from the prescribing rule or may be components of a restriction. These elements may be embedded in a restriction or they may be listed independently and referenced. The mapping below has the prescribing-texts-list element as its context.

Field

XPath

Example

Comments

Notes Id

*[self::pbs:prescriber-instruction|self::pbs:administrative-advice|self::pbs:definition|self::pbs:foreword]/pbs:code

Notes Text

*[self::pbs:prescriber-instruction|self::pbs:administrative-advice|self::pbs:definition|self::pbs:foreword]/*[not(self::pbs:code)]

Notes are encoded as structured text, using the DocBook schema. All markup must be stripped for the equivalent text encoding.

Any SVG elements must be removed for the equivalent text encoding.

CautionExtract.txt File

The CautionExtract yyyymmdd.txt lists all Caution ids and their descriptions. It is used for linking to values in the LinkExtract and PBS Item Table files below. The CautionExtract file is ASCII tab delimited.

In the PBS XML, all cautions are contained in a caution element. These elements are child elements of prescribing-texts-list element. The mapping below has the caution element as its context.

Field

XPath

Comments

Caution Id

code

Caution Text

*[not(self::pbs:code)]

Cautions are encoded as structured text, using the DocBook schema. All markup must be stripped for the equivalent text encoding.

The caution may also contain SVG elements. These must be removed for the equivalent text encoding.

RestrictionExtract.txt File

A restriction is comprised of one or more Indications. The RestrictionExtract yyyymmdd.txt file lists the Indication Ids and the text of the Indications. This is the text that appears under the headings "Restricted benefit" and "Authority Required" in the Schedule of Pharmaceutical Benefits. The RestrictionExtract file is ASCII tab delimited.

In the PBS XML, all Restrictions are contained in a restriction element which is a child element of a prescribing-texts-list element. These are referenced from the prescribing rule to which it is attached. All mappings below assume a context of the restriction element.

Field

XPath

Example

Comments

Indication Id

code

Restriction Indication Text

*[not(self::pbs:code)]

Components of restrictions may be embedded in the restriction element or may be referenced. Dereferencing is required to complete the text of the restriction.

Restrictions are encoded as structured text, using the DocBook schema. All markup must be stripped for the equivalent text encoding.

Restriction components may contain SVG elements. These must be removed for the equivalent text encoding.

Miscellaneous Restriction Flag

.../pbs:treatment-parameter[@rdf:resource = "http://pbs.gov.au/parameter/treatment/lifetime1"]

The restriction must contain, either directly or by reference, a parameter linked to the given terminology concept. Use "1" if this concept is present, "0" otherwise.

Date Required Flag

concept(.../*/@rdf:resource)/p:finding

The restriction must contain, either directly or by reference, a parameter that is linked to a terminology concept that is related to a finding. Use "1" if this concept is present, "0" otherwise.

Text Required Flag

concept(.../*/@rdf:resource)/p:finding

The restriction must contain, either directly or by reference, a parameter that is linked to a terminology concept that is related to a finding. Use "1" if this element is present, "0" otherwise.

LinkExtract.txt File

A prescribing rule may be associated with one or more restrictions. The LinkExtract yyyymmdd.txt file links the restriction Id to the PBS item code. Where there are multiple restrictions for an item, there will be multiple records in this file for that PBS item code. The LinkExtract file is ASCII tab delimited.

The prescribing rule is the context in the following XPath expressions.

Field

XPath

Example

Comments

PBS Item Code

pbs:code

Indication Id

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:code

xpointer(pbs:increases-list/pbs:increase/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:code

Increased MQ/R Flag

pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference

pbs:increases-list/pbs:increase/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference

If the restriction is used in both a benefit-type and an increase then use the value "3".

If the restriction is only used in an increase then use the value "1".

If the restriction is only used in a benefit-type then use the value "2".

Start Date

pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/pbs:effective/pbs:date

pbs:increases-list/pbs:increase/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/pbs:effective/pbs:date

PBS XML uses XSD format YYYY-MM-DD. Text files use format DDMMYYYY.

End date

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:moved/@xlink:href)/pbs:restriction-reference[parent::pbs:previous]/pbs:non-effective/pbs:date

The "non-effective" date is the first day upon which the restriction ceases to be effective. If this element is not present, then the restriction is effective until further notice, ie. forever. The "end date" is one day before the non-effective date.

PBS XML uses XSD format YYYY-MM-DD. Text files use format DDMMYYYY.

Note Id

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/*[self::pbs:prescriber-instruction|self::pbs:definition][1]/pbs:code

The PBS XML may have multiple notes attached to a restriction, but the text file can only represent one attachment. Multiple rows are used for multiple notes. The definition or prescriber-instruction elements may be included by reference.

Caution Id

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/pbs:caution[1]/pbs:code

The PBS XML may have multiple cautions attached to a restriction, but the text file can only represent one attachment. Multiple rows are used for multiple cautions.

PBS Item Table.txt File

The PBS Item Table yyyymmdd.txt file provides information on the availability of items through the eAuthorities system, and also links Notes and Cautions to PBS item codes.

The prescribing rule is the context in the following XPath expressions.

Field

XPath

Example

Comments

PBS Item Code

pbs:code

Restriction Flag

pbs:benefit-types-list/pbs:benefit-type[default benefit type]/@rdf:resource

The http://pbs.gov.au/benefit-type/unrestricted value is represented by the code "U", the http://pbs.gov.au/benefit-type/restricted value is represented by the code "R", the http://pbs.gov.au/benefit-type/authority-required and http://pbs.gov.au/benefit-type/streamlined values are represented by the code "A".

eAuthorities quantity

Not in public data.

eAuthorities Repeats

Not in public data.

eAuthorities Flag

Not in public data.

Schedule Indicator

Not in public data.

Start Date

pbs:effective/pbs:date

PBS XML uses XSD format YYYY-MM-DD. Text files use format DDMMYYYY.

End date

xpointer(pbs:moved/@xlink:href)/pbs:non-effective/pbs:date

The "non-effective" date is the first day upon which the item ceases to be effective. If this element is not present, then the item is effective until further notice, ie. forever. The "end date" is one day before the non-effective date.

PBS XML uses XSD format YYYY-MM-DD. Text files use format DDMMYYYY.

Note Ids

xpointer(pbs:benefit-types-list/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/*[self::pbs:prescriber-instruction|self::pbs:definition]/pbs:code

xpointer(pbs:increases-list/pbs:increase/pbs:benefit-type/pbs:restriction-references-list/pbs:restriction-reference/@xlink:href)/*[self::pbs:prescriber-instruction|self::pbs:definition]/pbs:code

xpointer(pbs:prescribing-texts-list/*[self::pbs:foreword-reference|self::pbs:administrative-advice-reference])/pbs:code

The PBS XML has no limit on the number of notes that may be attached to a prescribing rule.

Caution Ids

xpointer(pbs:prescribing-texts-list/pbs:caution-reference)/pbs:code

The PBS XML has no limit on the number of cautions that may be attached to a prescribing rule.

amt.txt File

The amt_YYYMMDD.txt file gives information about the drug concepts in the PBS XML.

The product listing is the context in the following XPath expressions.

Field

XPath

Example

Comments

Program Code

ancestor::program/info/code

<program>
  <info>
    <dbk:title>Ready-prepared Pharmaceutical Benefits</dbk:title>
    <code>GE</code>
  </info>

  <dispensing-rules-list>...</dispensing-rules-list>

  <prescribing-rule>
    ...
    <ready-prepared>
      ...
      <product-listing>...</product-listing>
      ...
    </ready-prepared>
    ...
  </prescribing-rule>
</program>

PBS Code

ancestor::prescribing-rule/code

<prescribing-rule>
  ...
  <code rdf:resource="http://pbs.gov.au/code/item">10003L</code>
  <ready-prepared>
    ...
    <product-listing>...</product-listing>
    ...
  </ready-prepared>
  ...
</prescribing-rule>

Manufacturer Code

code[@rdf:resource = 'http://pbs.gov.au/code/manufacturer']

<product-listing>
  ...
  <code rdf:resource="http://pbs.gov.au/code/product-listing">20304</code>
  <code rdf:resource="http://pbs.gov.au/code/manufacturer">NV</code>
  ...
</product-listing>

Unit of Measure

concat('1 ', substring-after(../maximum-prescribable/@rdf:resource, 'http://pbs.gov.au/reference/unit-of-measure/'))

<prescribing-rule>
  ...
  <infusible>
    ...
    <maximum-prescribable rdf:resource="http://pbs.gov.au/reference/unit-of-measure/mg">1000</maximum-prescribable>
    ...
    <product-listing>...</product-listing>
    ...
  </ready-prepared>
</prescribing-rule>

If the prescribing rule is an infusible listing then the unit of measure is included. Otherwise this field is left blank.

MP Concept ID

xpointer(xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

xpointer(xpointer(xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

MP

xpointer(xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/preferred-term

xpointer(xpointer(xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/preferred-term

MP preferred term.

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

MPP Concept ID

xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

xpointer(xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

MPP

xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/preferred-term

xpointer(xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/drug-references-list/mpp-reference/@xlink:href)/preferred-term

MPP preferred term.

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

Brand Name

xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/tp-reference/@xlink:href)/preferred-term

xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tp-reference/@xlink:href)/preferred-term

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

TPP Concept ID

xpointer(tpp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/code[starts-with(@rdf:resource, 'http://snomed.info/sct/')]

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

TPP

xpointer(tpp-reference/@xlink:href)/preferred-term

xpointer(xpointer(tpuu-reference/@xlink:href)/drug-references-list/tpp-reference/@xlink:href)/preferred-term

TPP preferred term.

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

Pack content

xpointer(xpointer(tpp-reference/@xlink:href)/drug-references-list/tpuu-reference/@xlink:href)/content

xpointer(tpuu-reference/@xlink:href)/content

This value is actually the vial content.

Max Quantity

ancestor::prescribing-rule/*/maximum-prescribable[starts-with(@rdf:resource, 'http://pbs.gov.au/reference/unit-of-measure/')]

ancestor::prescribing-rule/*/maximum-prescribable[@rdf:resource = 'http://pbs.gov.au/reference/unit-of-use')]

ancestor::prescribing-rule/*/maximum-prescribable[1]

For an infusible prescribing rule the maximum prescribable in terms of unit-of-measure is used. For a ready-prepared prescribing rule the maximum prescribable in terms of unit-of-use is used, if it is given, otherwise the pack.

Commonwealth's Ex-Manufacturer Price

reimbursement/ex-manufacturer/amount

Manufacturer's Ex-Manufacturer Price

xpointer(tpp-reference/@xlink:href)/ex-manufacturer/amount

xpointer(tpuu-reference/@xlink:href)/ex-manufacturer/amount

A ready-prepared product listing has a TPP reference. An infusible product listing has a TPUU reference.

PFDI Amount

manufacturer/incentives-list/incentive[@rdf:resource = 'http://pbs.gov.au/incentive/dispensing']/price[default dispensing rule]/amount

sn20dr.txt File

The sn20dr_YYYMMDD.txt file gives information about the Safety Net 20 Day Rule in the PBS XML.

The prescribing rule is the context in the following XPath expressions.

Field

XPath

Example

Comments

Item Code

code

<prescribing-rule>
  ...
  <code rdf:resource="http://pbs.gov.au/code/item">10003L</code>
  <ready-prepared>
    ...
    <product-listing>...</product-listing>
    ...
  </ready-prepared>
  ...
</prescribing-rule>

Days

*/safety-net/duration

<prescribing-rule>
  ...
  <ready-prepared>
    ...
    <safety-net>
      <duration>P20D</duration>
    </safety-net>
    ...
    <product-listing>...</product-listing>
    ...
  </ready-prepared>
  ...
</prescribing-rule>

The duration is given in XSD duration format.

Counted

member-of-list/member-of[@rdf:resource = 'http://pbs.gov.au/safety-net/early-supply/no-penalty' or @rdf:resource = 'http://pbs.gov.au/safety-net/early-supply/penalty']

<prescribing-rule>
  ...
  <member-of-list>
    ...
    <member-of rdf:resource="http://pbs.gov.au/safety-net/early-supply/no-penalty">
      <code>Y</code>
    </member-of>
    ...
  </member-of-list>
  ...
</prescribing-rule>

streamlined.txt File

The streamlined_YYYMMDD.txt file gives information about Streamlined Authority Codes in the PBS XML.

The prescribing rule is the context in the following XPath expressions.

Field

XPath

Example

Comments

Drug Name

xpointer(xpointer(*/mpp-reference/@xlink:href)/drug-references-list/mp-reference/@xlink:href)/preferred-term

xpointer(*/mp-reference/@xlink:href)/preferred-term

A ready-prepared prescribing rule has a MPP reference. An infusible prescribing rule has a MP reference.

Item Code

code

<prescribing-rule>
  ...
  <code rdf:resource="http://pbs.gov.au/code/item">10003L</code>
  <ready-prepared>
    ...
    <product-listing>...</product-listing>
    ...
  </ready-prepared>
  ...
</prescribing-rule>

Streamlined Authority Code

benefit-types-list/benefit-type[@rdf:resource = "http://pbs.gov.au/benefit-type/streamlined"]/restriction-references-list/restriction-reference/code

<prescribing-rule>
  <benefit-types-list>
    <benefit-type rdf:resource="http://pbs.gov.au/benefit-type/streamlined">
      ...
      <restriction-references-list>
        <restriction-reference xlink:href="#r52204658157885">
          <code>49831</code>
          <effective>
            <date>2015-07-01</date>
          </effective>
	</restriction-reference>
	<restriction-reference xlink:href="#r530373852150791">
          <code>49911</code>
          <effective>
            <date>2015-07-01</date>
          </effective>
	</restriction-reference>
      </restriction-references-list>
      ...
    </benefit-type>
    ...
  </benefit-types-list>
  ...
</prescribing-rule>