Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note
titlePlease Note

This is an example. Each configuration should be modified to match your workflow and requirements.Settings for Avian Influenza may be slightly different depending on which program you are reporting to.

You may wish to create separate profiles for USDA Wildlife Services, Live Market surveillance, and Domestic surveillance. 


Info
titleResource Files

...

Panel

API - Message Definition for Avian Influenza

Message Profile and Header (MSH)

Message Profile - NAHLN AI - USDA Wildlife Services

  • To report to the NAHLN: Username, Password, and Auth Token or Certificate are required.
  • The Schema Definition is not required, but if present the API will validate the message before posting it to the NAHLN website.
  • Failure Email should report to someone with VetView admin access who is able to monitor the messages.

Message Type: NAHLN OPU_R25 - HL7

  • MSH.3 Sending Application is your Laboratories OID. OID Registry
  • MSH.4 Sending Facility is your Laboratories Premise ID
  • MSH 5 & 6 are NAHLN's information.

Patient Visit - PV1

  • For Wildbird surveillance, include the VSLS referral number provided on the form with the standard convention of:  [2 letter state code][submitters initials][date]
  • For all other surveillance, create a referral number using the convention of : [2 letter state code] [date]
  • Multiple accessions on the same date accession should be listed using .a, .b, .c etc.
  • If the Accession Number for the lab is set up to follow these rules automatically, then the Accession No can be used instead.

Reference numbers are set on the Accession Header.

OBX Section

OBX is not used in this message and can be left as below.

Role and Next of Kin Section

ROL is used to define the clinic or other source of the specimen.  

NK1 is used as the name and address to be set as the Owner of the animal. 

PID Section

Patient Section is not used and can be set up as below.

Specimen Section

Specimen Identifier SPM.2 is the important part here, In this example I am using the Patient ID field to capture the Barcode from the the submission.

This is the Patient ID found under the Accession Details.

Allowed Specimen Types

Specimen Type is the other critical part. By NAHLN specifications,  only certain types are approved.

These SNOMED codes will need to be assigned under Common Setup Data > Specimen Setup for each of the specimen types.

Test Setup - Message Definition

Individual tests will need to have the message settings assigned under Laboratory Setup > Test Setup.

Message Profile Settings

Select the messaging profile you set up under the Job and Interface settings for this test, and the event that should trigger the message.

OBR.4 and OBX.3 are based on the test being performed (per NAHLN specifications.)  In this example the LOINC for the Type A or fluaA Matrix PCR is used. 

OBR.31 - Reason for Submission Setup


OBR.31 is the Reason for Submission.  In VetView, this can be included by adding a Question with a Value List to the test.  You can have a default value set to ensure this question and answer is always included in the message.

Step 1:  Create a Value List for the NALHN submission reasons under Value List Setup.  Include the allowed answers that your lab is tracking.

Step 2: Create a Question that can be added to the Catalog Item. Questions are created under Laboratory Setup > Question Setup.  

Create a Question with a type of Value List, and select the Value List you created in the previous step.

Step 3:  Add this as a required Question on the Catalog item associated with the test.

You can set a Default answer if only one reason will be used for a particular test.  Otherwise you can allow the submitter to select the Reason from the approved list of values.

ORC.4 Setting: This is based on the Reason and the Type of the submission.


OBX.5 and OBX.8 are results that come from the test. For PCR results you have to report both the numeric Cycle Threshold and the interpreted results.

These values are created during the test under Result Entry, either automatically as released by a PCR machine, or manually entered. 

OBX.17 Setting:  Observation Method is the OID that was related to the test SOP, as assigned by NVSL. 

...