Terminology Access

Terminology resources

Provides services to download the content of simple type reference sets contained in SNOMED CT-AU and AMT versions. These downloads are a convenient form of reference set content, containing precomputed values such as preferred terms for codes.

Full release file bundle including additional reference sets and associated documentation can be found at the Agency Clinical Terminology.

The Royal College of Pathologists of Australasia (RCPA) resources previously available here have been deprecated. These have been replaced by the RCPA Pathology Terminology and Information Models v1.0 which can be downloaded, along with a release note and terms of use, from the Agency website.

The reference sets listed for SNOMED CT-AU and AMT are the active reference sets for the selected version of that terminology. This defaults to the latest version of each terminology on loading.

Each of the reference sets listed on this page are clickable links that will start a file download in the selected preferred format:

  • TSV - Tab Separated Values,
  • CSV - Comma Separated Values,
  • JSON - JavaScript Object Notation.

The downloaded file will contain all active members of the reference set. Inactive historical members of the set are omitted. Fields returned for the reference sets are detailed on the Field Definitions tab.

When opening the delimited files in Microsoft® Excel® the identifiers and some text may be displayed incorrectly unless some settings are changed. If you have configured Excel to automatically open CSV and TSV files, it will assume the field to be General, and truncation and text errors will happen. To avoid this, users should first open Excel, and import the file (not simply open) from within to have the opportunity to change the settings. The settings should specify that the file be comma delimited or tab delimited (for CSV and TSV files respectively), with the file origin of ‘unicode (UTF-8)’ and the ID column is set to Text (not general). These issues are specific to Excel, and will result in ID digit errors and strange characters for words with accents (e.g. Ménière's Diseases).

The links on this page delegate to a terminology server with a RESTful API. The URLs have a predictable form and may be accessed programmatically to automate download of this content. Details of the structure of these URLs, options and parameters are included on the Services Help tab.

This material includes SNOMED Clinical Terms® (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT® was originally created by The College of American Pathologists. SNOMED® and SNOMED CT® are registered trademarks of the IHTSDO.

Terminology resources services help

Here are details of the REST interface used to provide the reference set downloads on the Terminology resources page.

URLs used to provide these services have a predictable structure which is described on this page, followed by some provided examples. Links on the Terminology resources page may be right clicked and the link URL copied for further examples. These URLs may be accessed programmatically using HTTP Basic Access Authentication over SSL.

Details of the exposed parts of the RESTful API are provided below, including parameters and field options.

REST URL

The provided URL is to be used in conjunction with the query parameters, defined below.
https://terminologies.digitalhealth.gov.au/ontoserver/resources/ontology/findConceptsByQuery

Query Parameters

ParameterType
query
The SCT Query string, to query reference set members (eg. "MemberOf(12310001682)").

string
rows
Maximum number of results to return.
int
start
Index of the first result returned.
int
versionedId
The ontology version you wish to query.

string
format
The data format for the returned results. Options:
  • tsv
  • csv
  • json
string
field
Zero or more field names to return in the response. The omissions of any field parameters implies ALL fields.

List[string]
fieldOrder
An ordered, comma-separated, list of fields. The order of returned columns will reflect the order of provided fields.
string
filename
If provided, the server will return the following response header:

"Content-Disposition: attachment; filename=<PROVIDED_FILENAME>"
string

Error Status Codes

HTTP Status CodeReason
401 Unauthorised. Log in to the NEHTA portal.
404 If the specified ontology version or the filter id is unknown to this server.
500 An internal error occured.

Examples

Medicinal product reference set (AMT) - TSV:
https://terminologies.digitalhealth.gov.au/ontoserver/resources/ontology/findConceptsByQuery?rows=1000000000&start=0&field=shortId&field=fullySpecifiedName&field=label&field=synonyms&fieldOrder=shortId,fullySpecifiedName,label,synonyms&format=tsv&versionedId=http://snomed.info/sct/900062011000036108/version/20150430&query=MembersOf(929360061000036106)&filename=mp.tsv

Trade product pack reference set (AMT) - JSON:
https://terminologies.digitalhealth.gov.au/ontoserver/resources/ontology/findConceptsByQuery?rows=1000000000&start=0&field=shortId&field=fullySpecifiedName&field=label&field=synonyms&fieldOrder=shortId,fullySpecifiedName,label,synonyms&format=json&versionedId=http://snomed.info/sct/900062011000036108/version/20150430&query=MembersOf(929360041000036105)&filename=tpp.json

Adverse reaction reference set (SCTAU) - TSV:
https://terminologies.digitalhealth.gov.au/ontoserver/resources/ontology/findConceptsByQuery?rows=1000000000&start=0&field=shortId&field=fullySpecifiedName&field=label&field=synonyms&fieldOrder=shortId,fullySpecifiedName,label,synonyms&format=tsv&versionedId=http://snomed.info/sct/32506021000036107/version/20150531&query=MembersOf(11000036103)&filename=adverse-reactions.tsv

Change Type reference set (SCTAU) - TSV:
https://terminologies.digitalhealth.gov.au/ontoserver/resources/ontology/findConceptsByQuery?rows=1000000000&start=0&field=shortId&field=fullySpecifiedName&field=label&field=synonyms&fieldOrder=shortId,fullySpecifiedName,label,synonyms&format=tsv&versionedId=http://snomed.info/sct/32506021000036107/version/20150531&query=MembersOf(15071000036100)&filename=changeType.tsv

Terminology resources field definitions

Here are details of the fields returned in downloads linked on the Terminology resources page. These fields are documented below.

Reference set fields

Field nameDescription
shortId SNOMED CT concept identifier of the reference set member. Note this includes both AMT and SNOMED CT-AU concepts
fullySpecifiedName The Fully Specified Name of the reference set member
label The Preferred Term of the reference set member
synonyms Comma separated list of synonyms for the reference set member. In the TSV and CSV formats, commas contained within an individual synonym's text are escaped with a backslash (\). For example given the following synonyms
  • Monophasic choriocarcinoma
  • Choriocarcinoma, monophasic
the comma separated synonyms field will contain "Monophasic choriocarcinoma,Choriocarcinoma\, monophasic" where the comma between "Choriocarcinoma" and "monophasic" is escaped with a backslash an represented as "\,"