NAHLN - Foot & Mouth Disease Messaging
API - Message Setup for NAHLN FMD
Message Profile (MSH)
- To report to 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 go to a VetView user with admin privileges who is able to monitor the messages.
Message Type: NALHN 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 PV1
Role ROL1
ROL13/PL6 Person Location Type
If this will be used, set up a Test Question of type Value List, and restrict the value list only to valid Person Location Types
Step 1: Create a value list of the accepted location types under Value List Setup.
Step 2: Create a question using this value list under Question Setup.
Step 3: Add this question to the Catalog item to link it to the tests that will send this message to NAHLN.
Next of Kin NK1
Patient Identifier PID3
PID.38 Production Class Codes
Setup up a Question using a value list that is restricted to a value list of acceptable Production Class Codes, and link this to the tests under Catalog Setup.
OBX Patient Observations - Include Age Group
Setup up Question using a value list that is restricted to a value list of acceptable Age Group Codes, and link it to the test under Catalog Setup.
Specimen SPM
SPM.14 should be linked to the Question for Submission Reason, and this should be linked to the tests under Catalog Setup.
Specimen Setup
NALHN only allows six specimen types for FMD testing. Ensure that the appropriate SNOMED codes are in the Specimen Setup.
- Oral swab (specimen) 418932006
- Oral Epithelium 651000009103
- Vesicle fluid from sample (specimen) 258482009
- Swab from vesicle 472875007
- Epithelial tissue sample from vesicle (specimen) 791000009104
- Esophageal fluid obtained by probang cup (specimen) 360041000009104
Test Setup - Message Definition
In addition to the settings on the Job and Interface for NAHLN, you will need to add the Electronic Messaging Setup for each test that will report FMD to NAHLN.
Message Profile Name
Choose the profile name that you created under the Job and Interface Settings above.
OCR.4 Placer Group Number
When selecting Reference Number Authority, please note a reference number in the accession header
OBR.31 Reason For Submission
Set up up a test catalog question that is restricted to a value list of acceptable reasons for submission.
OBX.5 Observation Value
This value should be the result name that holds the CT value in test setup
OBX.8 Abnormal Flags Interpretation
This value should be the result name that holds the interpretation in test setup. This should be restricted to a value list with only the NAHLN approved interpretation results (NDET)