Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Please Note

This is an example. Each configuration should be modified to match your workflow and requirements.

API - Message Definition

Message Profile and Header (MSH)

    • To report to the NAHLN: Username, Password, and 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.
    • 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.

Role and Next of Kin Section

    • ROL.4 and NK1.2 are used for the name and address to be sent as the Owner of the animal.

Patient Section is not used and can be 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.

    • Specimen Type is the other critical part, by the specification only certain types are approved. The SNOMED code need to be added in the Specimen setup in the standard code field.

Test Setup - Message Definition

  • OBR.4 and OBX.3 are based on the test being performed, based on the specification.


  • OBR.31 - Reason for submission is controlled by put a question on the test, a default value can be set.




  • ORC.4 is based on the reason and type of the submission.
  • OBX.5 and OBX.8 are results that come from the test. For PCR results you have report both the numeric Cycle Threshold and the interpreted results.

OBX.17 - Observation Method is the OID that was related to the test SOP, assigned by NVSL, this appears have been remove form the documentation.





  • No labels