Search the OSCAR Documentation
< All Topics
Print

National Vaccine Catalogue

UpdatedSeptember 15, 2024
By Peter Hutten-CzapskiPeter Hutten-Czapski

Preface

The Canadian National Vaccine Catalogue (NVC-CNV) is a database of all vaccine products available.  OSCAR 19 has custom integration with the NVC so that the immunization lists and lot numbers in OSCAR can be regularly updated.

Document Version History

  • v0.1 – Initial instructions – August 29, 2024

Documentation Copyright © 2024 by Peter Hutten-Czapski MD under the Creative Commons Attribution-Share Alike 3.0 Unported License

Prerequisites

Check that:

  • You have a recent OSCAR-19 build number 4615 or greater installed and configured.
  • The assumption here is that you have a production server running according to the instructions for tomcat9 on Ubuntu 22.04  or similar
  • There are significant disadvantages of trying ANY other version of OSCAR specified herein

Installation of NVC

TL;DR

Navigate to Administration > Integration > Configure/Update CVC

This screen allows you to set an override for the CVC url property set in oscar.properties.  Set the base url as https://nvc-cnv.canada.ca/v1 as shown and hit the blue [Save] button.

Then click the grey button [Update Now] A grey throbber will result.  When that clears a blue done message will indicate that OSCARs vaccine catalog will have been synchronized with the National (Canadian) Vaccine Catalog.

That’s it.

Update Prevention Display (optional)

Navigate to Administration > System Management > Prevention List Manager Pick the preventions you want to display in the left column for quick access.  Of course any immunisation can be quickly searched by any term with the Search search box in preventions.

TIPS:

  • The search box in preventions searches everything in the catalog, so you can search dialysis and get the Hepatitis B vaccine type used for dialysis patients
  • The Search box is especially handy in picking the correct shot for a given lot number.
  • Bolded preventions are brand name entities.
  • If the box provides many choices under the same input as there are often multiple options and likely only one or a few will be correct try a more specific search rather than just picking one of them, they may represent different medications and din numbers.

You should pick a short list of preventative actions and immunizations that you might want to have single click access to. 

The following preventions are often provided in primary care in Canada PAP, HPV-CERVIX, MAM, PSA, FIT/FOBT, COLONOSCOPY, BMD, HIV, HepB screen, HepC screen, VDRL, chlamydia, gonorrhea PCR, PHV, Smoking, OtherB, Tuberculosis (Mantoux)

The following immunizations are often used in primary care in Canada DTaP-IPV-Hib, Pneu-C-13, Rota-1, MMR, MMR-Var, Tdap-IPV, HPV-9, Tdap, Pneu-C-15, Pneu-C-20

OSCAR Properties (optional)

The following properties for the NVC are often set

Open /var/lib/tomcat/oscar.properties or similar with your favorite text editor and adjust as follows.

## for the Canadian National Vaccine Catalogue
# set the base url of the NVC server here
cvc.url=https://nvc-cnv.canada.ca/v1
# override classic prevention sidebar options
PREVENTION_ITEMS=classpath:oscar/oscarPrevention/NVCpreventionItems.xml

With any change to oscar.properties you need to restart tomcat

sudo service tomcat9 restart
 

Update Preventions (optional)

If you have existing preventions data you will need to update it so that your previous preventions show for each patient.  This is handled by the DEB so you don’t have to do this.  However if you have built OSCAR from source you will need to run the update file.

Obtain https://bitbucket.org/oscaremr/oscar/src/stable/database/mysql/updates/update-2024-09-14.sql

Non run the update-2024-09-14.sql

mysql -uroot -p******** oscar_15 < update-2024-09-14.sql

Set an Update Job (optional)

While there is something to be said for doing the updates manually as you did above, it can get boring and its a job that is easy to forget.  Solution? set up an OSCAR Job to run it for you on a scheduled basis.

Administration > System Management > Jobs Management Enable CanadianVaccineCatalogueUpdater

TIP: the NVC is currently updated weekly by the Pubic Health Agency of Canada, there is no advantage to run the job more frequently

Troubleshooting

A) The NVC once setup is usually trouble free, however if a new vaccine is not populating OSCAR properly you can determine what is in the bundle of information that OSCAR downloads if you set the following property. CVC_BUNDLE_LOCAL_FILE=/usr/share/oscar-emr/OscarDocument/oscar/eform/images/bundle.json Then you can open the file and search for the term you are looking for.

B) If lot numbers are not available for a particular shot despite updating the catalog, you can manually add (and remove) them through Administration > Integration > Add Prevention Lot Number. 

TIP: Note that subsequent updating the CVC will replace any manually entered lot numbers with theirs.

Tags:
Table of Contents