Prostheses codes #
The prostheses_codes endpoint is a searchable list of the current codes used for online eligibility (OEC) requests where there is a need to check rebates for prostheses with the fund. The codes are used in the items.serviceCode element of the OEC. The response includes information about rebatable amounts.
GET
- Get prostheses list
#
A request to the prostheses_codes
endpoint without parameters will return the list in pages of 10. Additional pages can be requested with the limit
and offset
parameters. Be cautious requesting large blocks, the list is extensive and it will affect performance. If you require the full list it can be downloaded from the DoH Prostheses List page
{{base_url}}/{{version}}/prostheses_codes
Headers
Header | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Authorization | Bearer {{oauth_token}} |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/prostheses_codes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"total": 11807,
"records": 10,
"offset": 0,
"results": [
{
"billingCode": "QHV01",
"name": "Valve - Aortic",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 9211,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV02",
"name": "Valve - Pulmonary",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 9211,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV03",
"name": "Patch - Mitral",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 2432,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV04",
"name": "Patch - Tricuspid",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 2432,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV05",
"name": "Patch - Pericardium",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 2672,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV07",
"name": "Conduit - Pulmonary large",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 2672,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV08",
"name": "Conduit - Pulmonary + Valve",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 9211,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV09",
"name": "Conduit - Aortic + Valve",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 8791,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV10",
"name": "Valve - Mitral",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 8791,
"actionFlag": "No Change",
"cycleStartDate": "2009-02-01",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "QHV11",
"name": "Thoracic Aorta",
"itemType": "Human Tissue",
"supplier": {
"code": "MAB",
"name": "Queensland Tissue Bank"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"235366"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 2672,
"actionFlag": "No Change",
"cycleStartDate": "2009-02-01",
"cycleEndDate": "2021-03-01",
"description": null,
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
}
]
}
Headers:
Header | Value |
---|---|
Server | nginx/1.19.3 |
Date | Tue, 08 Jun 2021 04:49:28 GMT |
Content-Type | application/json |
Content-Length | 5839 |
Connection | keep-alive |
Access-Control-Allow-Origin | * |
Access-Control-Allow-Methods | GET, POST, OPTIONS |
GET
- Get prostheses by code
#
Where the prostheses code is known, search for it with the code
parameter.
{{base_url}}/{{version}}/prostheses_codes?code=BL005
Headers
Header | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Authorization | Bearer {{oauth_token}} |
Params
Param | value |
---|---|
code | BL005 |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/prostheses_codes?code=BL005' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"total": 1,
"records": 1,
"offset": 0,
"results": [
{
"billingCode": "BL005",
"name": "Storz (Coburn) Intraocular Lens 121UV; L122UV PMMA Anterior Chamber Lens",
"itemType": "Prosthesis",
"supplier": {
"code": "BL",
"name": "Bausch & Lomb (Australia) PTY LTD"
},
"category": "01 - Ophthalmic",
"subCategory": "01.01 - ANTERIOR CHAMBER INTRAOCULAR LENSES",
"group": "01.01.01 - Aphakic",
"subGroup": "01.01.01.01 - Rigid",
"artg": [
"97880"
],
"minimumBenefit": 126,
"maximumBenefit": 0,
"humanTissueAmount": 0,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": "PMMA Anterior Chamber Intraocular lens 1 piece",
"changeExplanation": null,
"size": "13.75mm length. 6.0mm optic size, diopter range 3-30d. L122UV: 6.0mm optic, 13.75mm length, power range; 5.0 to 30.0 Diopters",
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
}
]
}
Headers:
Header | Value |
---|---|
Server | nginx/1.19.3 |
Date | Tue, 08 Jun 2021 04:49:28 GMT |
Content-Type | application/json |
Content-Length | 942 |
Connection | keep-alive |
Access-Control-Allow-Origin | * |
Access-Control-Allow-Methods | GET, POST, OPTIONS |
GET
- Get prostheses by description
#
Where the prostheses code is not known, search for it with the description
parameter. This will return a paged response with matches on the name
field.
TIP: use ‘%20 to represent a space in the description parameter eg ‘?description=Valve%20-%20Aortic’
{{base_url}}/{{version}}/prostheses_codes?description=Valve
Headers
Header | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Authorization | Bearer {{oauth_token}} |
Params
Param | value |
---|---|
description | Valve |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/prostheses_codes?description=Valve' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"total": 2,
"records": 2,
"offset": 0,
"results": [
{
"billingCode": "SHV01",
"name": "Valve - Aortic",
"itemType": "Human Tissue",
"supplier": {
"code": "SHV",
"name": "Sydney Heart Valve Bank, St. Vincent's Hospital"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"246032"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 9333,
"actionFlag": "No Change",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": "Valve - Aortic",
"changeExplanation": null,
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": null
},
{
"billingCode": "TBV01",
"name": "Valve - Aortic",
"itemType": "Human Tissue",
"supplier": {
"code": "TBV",
"name": "Donor Tissue Bank of Victoria"
},
"category": "01 - Cardio-thoracic",
"subCategory": null,
"group": null,
"subGroup": null,
"artg": [
"236613"
],
"minimumBenefit": 0,
"maximumBenefit": 0,
"humanTissueAmount": 10104,
"actionFlag": "Update",
"cycleStartDate": "2005-10-31",
"cycleEndDate": "2021-03-01",
"description": "Valve - Aortic",
"changeExplanation": "Changed Benefit",
"size": null,
"suffix": null,
"priorBillingCodes": null,
"note": null,
"created": "2021-06-08",
"updated": "2021-06-08"
}
]
}
Headers:
Header | Value |
---|---|
Server | nginx/1.19.3 |
Date | Tue, 08 Jun 2021 04:49:28 GMT |
Content-Type | application/json |
Content-Length | 1288 |
Connection | keep-alive |
Access-Control-Allow-Origin | * |
Access-Control-Allow-Methods | GET, POST, OPTIONS |