REST API News šŸ“°


REST API 4.0.0

  • search all datasets by AMP/VMP/AMPP/VMPP
  • comma separated search terms
  • remove technical docs endpoint
  • remove GMC endpoint
  • primary care prescribing endpoints now return items (ITEMS) by default (along with quantity and cost).

deprecated pharmly code searching

REST API 2.7.2

Release date: 05-Nov-2024

Improvements

  • Allow for filtering via PCOs in the prescribing data šŸ”
  • Added PCN name equivalents for all nations of the UK


REST API 2.7.1

Release date: 26-May-2024

Improvement

  • Shortages data loading time improved āš”ļø


REST API 2.7

Release date: 14-Aug-2023

New features

  • Say goodbye to the hassle of specifying a week number in your queries. Weā€™ve added a touch of magic to the DMD endpoint. It now automatically defaults to the latest week, saving you time and making your queries smoother than ever before.
  • Searching for Pharmly Code? Now, you can supercharge your searches by opting to retrieve the full product range. This means youā€™ll get a broader, more comprehensive set of products in your results.


REST API 2.6.3

Release date: 15-Feb-2023

Improvements

  • Following version 2.6.2, there are some internal improvements with zero impact for users.


REST API 2.6.2

Release date: 07-Feb-2023

Improvements

  • Internal improvements with zero impact for users.


REST API 2.6.1

Release date: 29-Nov-2022

Bug fixes

  • The cometitor-intel endpoint incorrectly filtered out the last day of the month, this is fixed now.


Release date: 27-Sep-2022

New

  • We added the Scottish Drug tariff to our drug-tariff endpoint! This means there is a new argument called countries that you can use to specify which data you want to retrieve. The default is ENG_WLS: meaning the English & Welsh Drug Tariff. If only ENG or WLS is provided, it will be converted to ENG_WLS automatically. For those interested in the Scottish Drug Tariff: they can use SCT.


REST API 2.5.1 Patch

Release date: 01-Sep-2022

Improvements

  • We updated the mapping related to which practices are classed as dispensing practices


REST API 2.5

Release date: 26-Aug-2022

Improvements

  • The data in the opportunities endpoint now is divided into more columns. This makes it easier to analyse the data- and we love to analyse data šŸ˜
  • There is a new column in the prescribing-practice endpoint indicating whether or not this is a dispensing practice: it is called DISP and the value is either TRUE or FALSE. See technical documentation for more details.

Breaking changes

  • To reflect changes in the NHS structure, the STP and STP_C columns in the pca-england endpoint now changed to ICB and ICB_C.


REST API 2.4.1 patch

Release date: 11-Aug-2022

Bug fixes

  • The latest update for the opportunities data was not updated frequently enough. This is changed now.


REST API 2.4

Release date: 22-Jul-2022

New features

  • NEW: endpoint to retrieve the latest technical documentation technical-documentation. It will download or display (depending on the client) a PDF containing the latest version of the technical documentation.

Improvements

  • More Drug Tariff data added: besides part VIIIA, you can now retrieve part VIIIB, VIIID and IX as well.
  • Secondary Care Medicines data endpoint (/scmd) now comes with a history argument.

Breaking changes

  • Due to newly added parts in the Drug Tariff endpoint /drug-tariff, column names have changed. Please check to the technical documentation.


REST API 2.3

Release date: 12-Jul-2022

Improvements

  • In case you missed it: the NHS England restructuring took effect from the 1st of July and now Clinical Commissioning Groups (CCGs) are absorbed by Integrated Care Boards (ICBs). The organisations formerly known as CCGs are now called sub-ICBs šŸ’”. These changes are reflected in the output of the data. rx-pco and rx-practice now return additional columns for this: SUB_ICB and SUB_ICB_C.
  • We added the NHS regions to rx-pco and rx-practice a well: REGION and REGION_C.
  • And last but not least we added another two extra columns to rx-practice that contain information about the Primary Care Network a practice belongs to: PCN and PCN_C.
  • In total there are 4 columns added to rx-pco, and 6 to rx-practice. Please note that this may increase response size (especially JSON). We suggest to use other output formats like feather that are smaller in size.

Breaking changes

  • The hes-activity endpoint does not support ccg_code as parameter anymore. This has been changed to pco_code instead. This is to reflect the reorganisation changes at the NHS starting the 1st of July.


REST API 2.2

Release date: 29-Jun-2022

New features

  • The DM+Dā€¦ The place where you can find everything! To make searching for everything a bit easier we introduced searching by Pharmly Company Code. Simply add the code to your query string and you will get all the products active for that company šŸ‘.
  • Talking about Pharmly Company Codes- what if you donā€™t know which company code belongs to which company? No problem, we got you covered! Within the pharmly-codes endpoint you can now search by a companyā€™s name, with pharmly_company_name. You will get all the entries for a company returned, including the Pharmly Company Code.
  • Not only the dmd endpoint got an improved search mechanism: also the concessionary endpoint got an upgrade! You can now search by date or date range in this endpoint, making it easier to retrieve all shortages within a specific date range.
  • NEW ENDPOINT: competitor-intel. This endpoint helps you to keep track of company movements. Find out which companies merged or got acquired, which brands were acquired by companies and which companies just entered the market šŸš€.
  • NEW ENDPOINT: opportunities. Loved by many of our clients in Pharmly Analytics and now available in our API! šŸ˜ This endpoint helps you to scan the market for value adding opportunities. You can search by active ingredient, pharmly code, company and type!

Improvements

  • The Secondary Care Medicines Data (SCMD) endpoint now contains a new column: COST. This gives information about the indicative cost.


REST API 2.1

Release date: 06-Jun-2022

New features

  • We always make sure you have access to the latest data available. But how do you know? šŸ‘€ Our new endpoint /update-date can give you this information! When requesting information via this endpoint you will receive information about the latest update date, the latest month available and the next due date. This also helps you to avoid making calls to the API while there is no new data yet. As always, check the Technical Docs for more information.
  • We added another endpoint to retrieve details on registered UK members of the General Medical Council (GMC)- /gmc-location. Simply provide the GMC number and youā€™ll see at which practices and hospitals (aka locations) they are active. Again, the Technical Docs are your friend.

Improvements

  • We improved how we are logging requests and errors. Previously we wrote this information to a secure log file, but now we write it to an even more secure database. Thatā€™s nice if we want to use the data in a structured way. This makes sure we can spot errors early on! šŸ¦ø As a user you wonā€™t notice any difference though.


REST API 2.0

Release date: 06-May-2022

New features

  • We were all waiting for itā€¦ šŸ‘€ And now itā€™s finally here! We added Prescription Cost Analysis (PCA) data to the API. The endpoint can be accessed via /pca-england. The PCA data is available monthly for England. In the Technical Documentation you can see the full specification of the endpoint and all the information it contains. This data allows you to see dispensed quantities rather than prescribed quantities, which opens up analysis to see what percentage of prescriptions have been fulfilled and to understand dispensing behaviour throughout England. Happy analysing!


REST API 1.9.1 patch

Release date: 13-Apr-2022

Improvements

  • The Unassigned active ingredientā€¦ šŸ§ We have a lot of products with Unassigned active ingredient. Thatā€™s because they are either devices, bandages, or other products that donā€™t have a clear active ingredient. Because there are so many products that meet this condition, a request for an unassigned active ingredient is not going to be very useful. Therefore, we suggest to use a more specific Pharmly Code instead. The API will now give you a friendly reminder for that, and will return 400.


REST API 1.9

Release date: 17-Mar-2022

New features

  • Light as a feather. Thatā€™s how we want our data to be. But sometimes our data is very heavy and very far away from being a feather. To reduce file size and we added new serializers. This means that you can retrieve our data in csv, rds and feather besides the good old JSON. Just specify an additional argument in the URL called format and you can decrease size with as much as 40% using one of the other serializers. Donā€™t know how to get started? Check the technical docs or contact support to make your data light as a feather! šŸŖ¶


REST API 1.8

Release date: 02-Feb-2022

New features

  • We have lots of data. Sometimes a bit too much. Responses can become very big in size and it might be you donā€™t need everything in the response. Thatā€™s why we introduced a mechanism to subset columns. Simply pass your desired columns in the body of the request and youā€™ll get only that returned.


REST API 1.7.1 patch

Release date: 28-Jan-2022

Improvements

  • Finding and mapping products is the core of Pharmly Cloud Data. Behind the scenes, we upgraded our mapping files to include even more information. Donā€™t worry, the results returned by the API donā€™t change. And the same goes for the Pharmly Codes: everything still works as expected.


REST API 1.7

Release date: 22-Oct-2021

New features

  • In this release we added new columns to prescribing-pco and prescribing-practice. The columns are: BRAND, BNF_C, BNF_S, BNF_P, BNF_SP, PCO_C for prescribing-pco and additionally for prescribing-practice we added PCO and PRACTICE_C.


REST API 1.6.1 patch

Release date: 13-Oct-2021

New features

  • Updated oral liquid / liquid specials process


REST API 1.6

Release date: 08-Oct-2021

New features

  • Added more output columns to list-prices endpoint


REST API 1.5

Release date: 01-Oct-2021

New features

  • Added new parameter to prescribing-pco and prescribing-practice


REST API 1.4

Release date: 07-Sep-2021

New features

  • Added new endpoints for Hospital Episode Statistics: hes-totals, hes-treatment and hes-activity

Changes

  • Changed scmd column name PROVIDER to PROVIDER_NAME for consistency.


REST API 1.3

Release date: 16-Aug-2021

New features

  • Added new endpoint for practice level prescribing data: prescribing-practice
  • Enabled multiple countries in the prescribing-pco (previously: prescribing-england) endpoint.

Breaking changes

  • The name of the original prescribing endpoint has changed from prescribing-england to prescribing-pco
  • The prescribing endpoints require a countries argument


REST API 1.2

Release date: 13-Jun-2021

New features

  • Added new endpoint for Secondary Care Medicines Data


REST API 1.1

New features

  • Added new Pharmly Code mapping file (version 1.1)