Medprax Api Help Page

Introduction

Provide a general description of your APIs here.

Scheme

Medprax Scheme

API	Description
GET api/schemes/scheme?code={code}&model={model}	Scheme Lookup
GET api/schemes/scheme/all	Scheme Lookup - Returns all the Schemes
POST api/schemes/scheme/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Scheme Search

Authentication

User Session

API	Description
POST api/authenticate	Medprax User Session
DELETE api/authenticate?sessionToken={sessionToken}	No documentation available.

Medicine

Medprax Product Medicine

API	Description
GET api/products/medicine?code={code}&model={model}	Product Lookup
POST api/products/medicine/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}&model={model}	Medprax Products (Medicine) Search
GET api/products/medicine/file_schedule	No documentation available.
GET api/products/medicine/file_get?token={token}	No documentation available.

ProductDrugExclusion

Medprax Drug Exclusion

API	Description
GET api/products/drugexclusion/list?productCode={productCode}&model={model}	Drug Exclusion Search using the Medprax Product Code

Material

Medprax Product Material

API	Description
GET api/products/material?code={code}&model={model}	Product Lookup
POST api/products/material/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}&model={model}	Medprax Products (Material) Search
GET api/products/material/file_schedule	No documentation available.
GET api/products/material/file_get?token={token}	No documentation available.

DrugExclusionDescription

Medprax Drug Exclusion

API	Description
GET api/products/drugexclusiondescription?code={code}&model={model}	Drug Exclusion Description Lookup
POST api/products/drugexclusiondescription/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Drug Exclusion Description Search

TariffFile

Medprax Tariff Files

API	Description
GET api/schemes/tarifffile/medical/contracts/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/dental/contracts/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Disciplineode
GET api/schemes/tarifffile/optometrist/contracts/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Discipline
GET api/schemes/tarifffile/alternative/contracts/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Discipline
GET api/schemes/tarifffile/orthotist/contracts/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/medical/insuredbenefits/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/dental/insuredbenefits/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Disciplineode
GET api/schemes/tarifffile/optometrist/insuredbenefits/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Discipline
GET api/schemes/tarifffile/orthotist/insuredbenefits/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/alternative/insuredbenefits/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Export using a List of Medprax Plan Option Codes and Tariff Codes for a Discipline
GET api/schemes/tarifffile/medical/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/dental/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/alternative/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/optometrist/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	Tariff File Search using the Medprax Plan Option Code
GET api/schemes/tarifffile/orthotist/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/medical/file_schedule?year={year}&tariffCodes={tariffCodes}&disciplineCode={disciplineCode}	Schedule to Get the Active Substances File
GET api/schemes/tarifffile/dental/file_schedule?year={year}&tariffCodes={tariffCodes}&disciplineCode={disciplineCode}	Schedule to Get the Active Substances File
GET api/schemes/tarifffile/alternative/file_schedule?year={year}&tariffCodes={tariffCodes}&disciplineCode={disciplineCode}	Schedule to Get the Active Substances File
GET api/schemes/tarifffile/optometrist/file_schedule?year={year}&tariffCodes={tariffCodes}&disciplineCode={disciplineCode}	Schedule to Get the Active Substances File
GET api/schemes/tarifffile/file_get?token={token}	Get the Active Substances File

PlanOption

Medprax Scheme Plan Option

API	Description
GET api/schemes/planoption?code={code}&model={model}	Plan Option Lookup
GET api/schemes/planoption/all	Scheme Plan Option Lookup - Returns all the Scheme Plan Options
POST api/schemes/planoption/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Plan Option Search

ActiveSubstance

Medprax Active Substances

API	Description
GET api/classifications/activesubstance/list?productCode={productCode}&model={model}	Get the Active Substances for a Product Code
GET api/classifications/activesubstance/file_schedule	Schedule to Get the Active Substances File
GET api/classifications/activesubstance/file_get?token={token}	Get the Active Substances File

TariffDiscipline

Medprax Tariff Disciplines

API	Description
GET api/schemes/tarifffile/discipline/medical?year={year}&code={code}&model={model}	Tariff Discipline Lookup - Medical Practitioners
GET api/schemes/tarifffile/discipline/dental?year={year}&code={code}&model={model}	Tariff Discipline Lookup - Dental Practitioners
GET api/schemes/tarifffile/discipline/alternative?year={year}&code={code}&model={model}	Tariff Discipline Lookup - Alternative Practitioners
GET api/schemes/tarifffile/discipline/optometrist?year={year}&code={code}&model={model}	Tariff Discipline Lookup - Optometrists
GET api/schemes/tarifffile/discipline/orthotist?year={year}&code={code}&model={model}	No documentation available.
POST api/schemes/tarifffile/discipline/medical/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Discipline Search - Medical Practitioners
POST api/schemes/tarifffile/discipline/dental/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Discipline Search - Dental Practitioners
POST api/schemes/tarifffile/discipline/alternative/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Discipline Search - Alternative Practitioners
POST api/schemes/tarifffile/discipline/optometrist/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Discipline Search - Alternative Practitioners
POST api/schemes/tarifffile/discipline/orthotist/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	No documentation available.

Formulary

Medprax Active Substances

API	Description
GET api/schemes/formulary/list?nappiCodeFirstSixDigits={nappiCodeFirstSixDigits}&model={model}	Get the Formularies for a Plan SubOption

DrugIndex

Drug Index

API	Description
GET api/drugindex/pregnancy?nappiCodes={nappiCodes}&region={region}	Pregnancy Search
GET api/drugindex/lactation?nappiCodes={nappiCodes}&region={region}	Lactation Search
GET api/drugindex/porphyria?nappiCodes={nappiCodes}&region={region}	Porphyria Search
GET api/drugindex/interactions?nappiCodes={nappiCodes}&region={region}	Interactions Search
GET api/drugindex/singledruglookup/provider?nappiCodes={nappiCodes}&region={region}	Provider Single Drug Lookup
GET api/drugindex/singledruglookup/patient?nappiCodes={nappiCodes}&region={region}	Patient Single Drug Lookup
GET api/drugindex/singledruglookup/patient/leaflet?nappiCodes={nappiCodes}&language={language}	No documentation available.

Icd10

Medprax Icd10

API	Description
GET api/icd10?code={code}&model={model}	Icd10 Lookup
POST api/icd10/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Icd10 Search

Maintenance

Medprax Maintenance Functions

API	Description
GET api/maintenance	Clears the Redis Cache for Tariff Files

PlanSubOption

Medprax Scheme Plan SubOption

API	Description
GET api/schemes/plansuboption?code={code}&model={model}	Plan SubOption Lookup
GET api/schemes/plansuboption/all	Scheme Plan Sub Option Lookup - Returns all the Scheme Plans Sub Options
POST api/schemes/plansuboption/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Plan SubOption Search
GET api/schemes/plansuboption/file_schedule	Schedule to Get the Active Substances File
GET api/schemes/plansuboption/file_get?token={token}	Get the Active Substances File

Atc

Medprax Active Substances

API	Description
GET api/classifications/atc?code={code}&model={model}	Atc Level 5 Code Lookup
POST api/classifications/atc/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Atc Level 5 Search
GET api/classifications/atc/file_schedule	Schedule to Get the Active Substances File
GET api/classifications/atc/file_get?token={token}	Get the Active Substances File

Checker

API	Description
GET api/checker/rpl?subOptionCode={subOptionCode}&nappiCode={nappiCode}&model={model}	No documentation available.
GET api/checker/cdl?subOptionCode={subOptionCode}&nappiCode={nappiCode}&model={model}	No documentation available.

TariffFileNetwork

Medprax Tariff Files

API	Description
GET api/schemes/tarifffile/medical/network?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&tariffTypeCode={tariffTypeCode}&dispensingCode={dispensingCode}&levelCode={levelCode}&model={model}	Tariff File Network Lookup
GET api/schemes/tarifffile/medical/network/list?year={year}&tariffCodes={tariffCodes}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}	Tariff File Network Search
GET api/schemes/tarifffile/medical/network/file_schedule?year={year}&disciplineCode={disciplineCode}	Schedule to Get the Active Substances File
GET api/schemes/tarifffile/network/file_get?token={token}	Get the Active Substances File

Statistics

Medprax Maintenance Functions

API	Description
GET api/statistics/medical?year={year}&disciplineCode={disciplineCode}	Tariff File Network Lookup
GET api/statistics/dental?year={year}&disciplineCode={disciplineCode}	Tariff File Network Lookup
GET api/statistics/optometrist?year={year}&disciplineCode={disciplineCode}	Tariff File Network Lookup
GET api/statistics/alternative?year={year}&disciplineCode={disciplineCode}	Tariff File Network Lookup

TariffPriceGroup

Medprax Tariff Codes

API	Description
GET api/schemes/tarifffile/pricegroup/medical/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Medical Practitioners
GET api/schemes/tarifffile/pricegroup/dental/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Dental Practitioners
GET api/schemes/tarifffile/pricegroup/orthotist/list?year={year}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/alternative/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Alternative Practitioners
GET api/schemes/tarifffile/pricegroup/optometrist/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Optometrists
GET api/schemes/tarifffile/pricegroup/medical/contracts/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Medical Practitioners
GET api/schemes/tarifffile/pricegroup/dental/contracts/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Dental Practitioners
GET api/schemes/tarifffile/pricegroup/alternative/contracts/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Alternative Practitioners
GET api/schemes/tarifffile/pricegroup/orthotist/contracts/list?year={year}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/optometrist/contracts/list?year={year}&disciplineCode={disciplineCode}&model={model}	Tariff Price Group Lookup - Optometrists
GET api/schemes/tarifffile/pricegroup/medical/options/list?year={year}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/dental/options/list?year={year}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/alternative/options/list?year={year}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/orthotist/options/list?year={year}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.
GET api/schemes/tarifffile/pricegroup/optometrist/options/list?year={year}&planOptionCode={planOptionCode}&disciplineCode={disciplineCode}&model={model}	No documentation available.

Plan

Medprax Scheme Plan

API	Description
GET api/schemes/plan?code={code}&model={model}	Plan Lookup
GET api/schemes/plan/all	Scheme Plan Lookup - Returns all the Scheme Plans
POST api/schemes/plan/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Plan Option Search

Radiology

Medprax Product Material

API	Description
GET api/products/radiology?code={code}&model={model}	Radiology Lookup
POST api/products/radiology/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}&model={model}	No documentation available.

SchemeAdministrator

Medprax Scheme Administrator

API	Description
GET api/schemes/administrator?code={code}&model={model}	Scheme Administrator Lookup
GET api/schemes/administrator/all	Scheme Administrator Lookup - Returns all the Scheme Administrators
POST api/schemes/administrator/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Scheme Administrator Search
GET api/schemes/administrator/file_schedule	No documentation available.
GET api/schemes/administrator/file_get?token={token}	No documentation available.

ActiveSubstanceDescription

Medprax Active Substances

API	Description
GET api/classifications/activesubstancedescription?code={code}&model={model}	Active Substance Description Lookup
POST api/classifications/activesubstancedescription/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Active Substance Description Search
GET api/classifications/activesubstancedescription/file_schedule	Schedule to Get the Active Substances File
GET api/classifications/activesubstancedescription/file_get?token={token}	Get the Active Substances File

LaymansIndications

API	Description
POST api/products/laymansindications/list?filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	No documentation available.

MimsCode

Medprax Mims Codes

API	Description
GET api/classifications/mimscode/list?productCode={productCode}&model={model}	Mims Code Search using the Medprax Product Code

PlanSubOptionDrugExclusion

Medprax Drug Exclusion

API	Description
GET api/schemes/drugexclusion/list?planSubOptionCode={planSubOptionCode}&model={model}	Drug Exclusion Search using the Medprax Plan SubOption Code

TariffCode

Medprax Tariff Codes

API	Description
GET api/schemes/tarifffile/code/medical?year={year}&code={code}&model={model}	Tariff Code Lookup - Medical Practitioners
GET api/schemes/tarifffile/code/dental?year={year}&code={code}&model={model}	Tariff Code Lookup - Dental Practitioners
GET api/schemes/tarifffile/code/alternative?year={year}&code={code}&model={model}&disciplineCode={disciplineCode}	No documentation available.
GET api/schemes/tarifffile/code/orthotist?year={year}&code={code}&model={model}&disciplineCode={disciplineCode}	No documentation available.
GET api/schemes/tarifffile/code/optometrist?year={year}&code={code}&model={model}	Tariff Code Lookup - Optometrists
POST api/schemes/tarifffile/code/medical/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Code Search - Medical Practitioners
POST api/schemes/tarifffile/code/dental/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Code Search - Dental Practitioners
POST api/schemes/tarifffile/code/alternative/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Code Search - Alternative Practitioners
POST api/schemes/tarifffile/code/orthotist/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	No documentation available.
POST api/schemes/tarifffile/code/optometrist/list?year={year}&filterJoin={filterJoin}&asc={asc}&orderPropertyName={orderPropertyName}&pageIndex={pageIndex}&pageSize={pageSize}	Tariff Code Search - Optometrists
GET api/schemes/tarifffile/code/file_schedule?year={year}	No documentation available.
GET api/schemes/tarifffile/code/file_get?token={token}	No documentation available.