HL7 Message Profile

Organization:  NAHLN
HL7 Version:  2.6
Color codes:
  • Segment Group
  • Segment
  • Fields
  • + Components
  • - Sub Components
Abbreviations:
  • seq - sequence
  • DT seq - datatype sequence
  • Vocab - vocabulary domain

Message


Segment - MSH

Description Opt Rep
Message Header R False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Field Separator   1
  R   False       |
Encoding Characters   2
  R   False       ^~\&
Sending Facility   4
  R   False        
     + namespace ID
  1   R         0031S8O
     + universal ID
  2   R         2.16.840.1.113883.3.5.6.1
     + universal ID type
  3   R        
Receiving Facility   6
  R   False        
     + namespace ID
  1   R         CAHFS Davis
     + universal ID
  2   R         2.16.840.1.113883.3.5.6.1
     + universal ID type
  3   R         ISO
Date/Time Of Message   7
  R   False        
     + time
  1   R         20031218193623-0500
Message Type   9
  R   False        
     + message code
  1   R         OPU
     + trigger event
  2   R         R25
     + message structure
  3   R         OPU_R25
Message Control ID   10
  R   False       34AE56D4B
Processing ID   11
  R   False        
     + processing ID
  1   R         P
Version ID   12
  R   False        
     + version ID
  1   R         2.6
Message Profile identifier   21
  RE   False        
     + entity identifier
  1   R       NAHLNResultBaseV2.0(or other current versions)[Historically: NAHLNOPU3.0]
     + universal ID
  3   R         2.16.840.1.113883.3.5.9
     + universal ID type
  4   R         ISO


Segment - PV1

Description Opt Rep
Patient visit R False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Patient Class   2
  R   False       C
Visit Number   19
  R   False        
     + ID
  1   R         123456
     + assigning authority
  4   R          
        - universal ID
  2   R         2.16.840.1.113883.3.5.6.1
        - universal ID type
  3   R         ISO


Segment - ROL

Description Opt Rep
Role R True
Field Name Seq DT Seq Opt Rep Vocab Example Value
Action Code   2
  RE   False      
Role-ROL   3
  R   False   PERSON_ROLE     
     + identifier
  1   R     PERSON_ROLE.CODE    SUB
     + text
  2   O     PERSON_ROLE.TEXT    Submitting Party
     + name of coding system
  3   R     PERSON_ROLE.CS    HL70443
Role Person   4
  R   True        
     + ID number (ST)
  1   RE         12377H87
     + family name
  2   C          
        - surname
  1   R         Smith
     + given name
  3   C         John
     + assigning authority
  9   RE          
        - universal ID
  2   R         2.16.840.1.113883.3.5.6.1
        - universal ID type
  3   R         ISO
Organization Unit Type - ROL   10
  C   False        
     + identifier
  1   R         TBD
     + text
  2   O         TBD
     + name of coding system
  3   R         TBD
Office/Home Address   11
  C   False        
     + street address (SAD)
  1   RE          
        - street or mailing address
  1   R         1234 Magnolia Lane, Ste. 231
     + city
  3   RE         Houston
     + state or province
  4   RE     STATE    TX
     + zip or postal code
  5   RE         33612
     + country
  6   RE     COUNTRY    USA
     + address type
  7   RE     ADDRESS_TYPE   
Phone   12
  C   True        
     + Email address
  4   RE         fred@nnnn.com
     + Country Code
  5   RE         111
     + Area/city code
  6   RE         813
     + Phone number
  7   RE         8853999
     + Extension
  8   RE         1234
Person's Location   13
  RE   False        
     + person location type
  6   RE     LOCATION_TYPE    F
     + location description
  9   RE         Second to the last farm on the road
     + comprehensive location identiifier
  10   RE          
        - entity identifier
  1   R         0031S8O
        - universal ID
  3   R         2.16.840.1.113883.3.5.6.1
        - universal ID type
  4   R         ISO

Segment Group - OPU_R25.ACCESSION

Description Opt Rep
OPU_R25.ACCESSION R True
Implementation Note:  This group contains all informationrelevant to the accession - information onthe Animal, Owner, Sample, Order, andResults.

Segment - NK1

Description Opt Rep
Next of kin / associated parties R True
Field Name Seq DT Seq Opt Rep Vocab Example Value
Set ID - NK1   1
  R   False       1
Name   2
  R   False        
     + family name
  1   R          
        - surname
  1   R         Smith
     + given name
  2   C         Jane
Address   4
  O   False        
     + street address (SAD)
  1   R          
        - street or mailing address
  1   R         1234 Magnolia Lane, Ste. 104
     + city
  3   R         Dallas
     + state or province
  4   R     STATE    TX
     + zip or postal code
  5   R         22323
     + country
  6   R     COUNTRY   
     + address type
  7   RE     ADDRESS_TYPE   
Phone Number   5
  O   False        
     + Email address
  4   RE         jeff@nnn.com
     + Country Code
  5   RE         111
     + Area/city code
  6   RE         813
     + Phone number
  7   RE         8853095
     + Extension
  8   RE         1141

Segment Group - PATIENT

Description Opt Rep
OPU_R25.ACCESSION.PATIENT RE False
Implementation Note:  Optional animal source information.

Segment - PID

Description Opt Rep
Patient identification R True
Field Name Seq DT Seq Opt Rep Vocab Example Value
Patient Identifier List   3
  R   True        
     + ID
  1   R         a-8747
     + assigning authority
  4   R          
        - universal ID
  2   R         2.16.840.1.113883.3.5.6.1
        - universal ID type
  3   R         ISO
     + identifier type code (ID)
  5   R     SUBJECT_ID_TYPE    E (for Ear Tag)
Patient Name   5
  RE   True        
Date/Time Of Birth   7
  RE   False        
     + Date/Time
  1   R         20040328134623.1234+0300
Administrative Sex   8
  R   False   GENDER   
Species Code   35
  R   False   SPECIES     
     + identifier
  1   R     SPECIES.CODE    34618005
     + text
  2   O     SPECIES.TEXT    Bos taurus
     + name of coding system
  3   R     SPECIES.CS    SCT
Breed Code   36
  O   False   BREED     
     + identifier
  1   R     BREED.CODE    26105007
     + text
  2   O     BREED.TEXT    Holstein-Friesian cattle breed
     + name of coding system
  3   R     BREED.CS    SCT
Strain   37
  RE   False      
Production Class Code   38
  R   False   PRODUCTION_CLASS     
     + identifier
  1   R     PRODUCTION_CLASS.CODE   
     + text
  2   O     PRODUCTION_CLASS.TEXT   
     + name of coding system
  3   R     PRODUCTION_CLASS.CS   


Segment Group - PATIENT_OBSERVATION

Description Opt Rep
OPU_R25.ACCESSION.PATIENT.PATIENT_OBSERVATION O True
Implementation Note:  Observations on the patient. If more than one, the entire PATIENT_OBSERVATION group repeats.

Segment - OBX

Description Opt Rep
Patient Observation O True
Field Name Seq DT Seq Opt Rep Vocab Example Value
Value Type   2
  R   False   OBSERVATION_VALUE_TYPE    NM
Observation Identifier   3
  R   False        
     + identifier
  1   R         11329-0
     + text
  2   O         Patient History, Narrative
     + name of coding system
  3   R         LN
Observation Value   5
  R   False   If reporting age groups: AGE_GROUPS    POSITIVE
Units   6
  C   False   UNITS     
     + identifier
  1   R     UNITS.CODE    O.D.
     + text
  2   O     UNITS.TEXT    Optical Density
     + name of coding system
  3   R     UNITS.CS    ISO+
Observation Result Status   11
  R   False OBSERVATION_RESULT_STATUS      F

Segment Group - SPECIMEN

Description Opt Rep
OPU_R25.ACCESSION.SPECIMEN R True
Implementation Note:  Order number assigned bylaboratory performing test.

Segment - SPM

Description Opt Rep
Specimen R False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Specimen ID   2
  R   False        
     + placer assigned identifier
  1   RE          
        - entity identifier
  1   R         234321444444
        - namespace ID
  2   RE         0031S8O
        - universal ID
  3   RE         2.16.840.1.113883.3.5.6.1
        - universal ID type
  4   RE         ISO
     + filler assigned identifier
  2   R          
        - entity identifier
  1   R         4235454324
        - universal ID
  3   R         2.16.840.1.113883.3.5.6.1
        - universal ID type
  4   R         ISO
Specimen Type   4
  R   False   SPECIMEN_TYPE     
     + identifier
  1   RE     SPECIMEN_TYPE.CODE    128157004
     + text
  2   R     SPECIMEN_TYPE.TEXT    Tissue specimen from brain
     + name of coding system
  3   RE     SPECIMEN_TYPE.CS    SCT
Specimen Additives   6
  RE   False   SPECIMEN_ADDITIVE     
     + identifier
  1   RE     SPECIMEN_ADDITIVE.CODE    F10
     + text
  2   R     SPECIMEN_ADDITIVE.TEXT    10% Formalin
     + name of coding system
  3   RE     SPECIMEN_ADDITIVE.CS    HL70371
Specimen Source Site   8
  RE   False   SPECIMEN_SOURCE_SITE     
     + identifier
  1   RE     SPECIMEN_SOURCE_SITE.CODE    741000009106
     + text
  2   R     SPECIMEN_SOURCE_SITE.TEXT    Brainstem at the obex
     + name of coding system
  3   RE     SPECIMEN_SOURCE_SITE.CS    SCT
Specimen Role   11
  R   False   SPECIMEN_ROLE     
     + identifier
  1   R     SPECIMEN_ROLE.CODE    P
     + text
  2   O     SPECIMEN_ROLE.TEXT    patient samples
     + name of coding system
  3   R     SPECIMEN_ROLE.CS    HL70369
Grouped Specimen Count   13
  C   False       5
Specimen Description   14
  O   False       Textual description of the specimen - up to 250 characters
Specimen Collection Date/Time   17
  RE   False        
     + range start date/time
  1   R          
        - time
  1   R         20040328134623.1234+0300
Specimen Received Date/Time   18
  R   False        
     + time
  1   R         20040328134623.1234+0300
Specimen Reject Reason   21
  RE   False   SPECIMEN_REJECT_REASON     
     + identifier
  1   R     SPECIMEN_REJECT_REASON.CODE    EX
     + text
  2   O     SPECIMEN_REJECT_REASON.TEXT    expired
     + name of coding system
  3   R     SPECIMEN_REJECT_REASON.CS    HL70490
Specimen Appropriateness   23
  R   False   SPECIMEN_APPROPRIATENESS     
     + identifier
  1   R     SPECIMEN_APPROPRIATENESS.CODE    I
     + text
  2   O     SPECIMEN_APPROPRIATENESS.TEXT    Inappropriate
     + name of coding system
  3   R     SPECIMEN_APPROPRIATENESS.CS    HL70492
Specimen Condition   24
  RE   False   SPECIMEN_CONDITION     
     + identifier
  1   R     SPECIMEN_CONDITION.CODE    CLOT
     + text
  2   O     SPECIMEN_CONDITION.TEXT    Clotted
     + name of coding system
  3   R     SPECIMEN_CONDITION.CS    HL70493




Segment Group - ORDER

Description Opt Rep
OPU_R25.ACCESSION.SPECIMEN.ORDER R True
Implementation Note:  The identifier type of the universal ID.This should be ISO (ISO OID)

Segment - OBR

Description Opt Rep
Observation Order R False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Placer Order Number   2
  RE   False        
     + entity identifier
  1   R         42134213423
     + universal ID
  3   R         2.16.840.1.113883.3.5.6.1
     + universal ID type
  4   R         ISO
Filler Order Number   3
  R   False        
     + entity identifier
  1   R         8689889599
     + universal ID
  3   R         2.16.840.1.113883.3.5.6.1
     + universal ID type
  4   R         ISO
Universal Service Identifier   4
  R   False   UNIVERSAL_SERVICE_ID     
     + identifier
  1   R     UNIVERSAL_SERVICE_ID.CODE    39021-1
     + text
  2   O     UNIVERSAL_SERVICE_ID.TEXT    Abnormal Prion Prot Tiss Ql EIA
     + name of coding system
  3   R     UNIVERSAL_SERVICE_ID.CS    LN
Relevant Clinical Info.   13
  O   False       BSE Surveillance
Results Rpt/Status Chng - Date/Time +   22
  R   False        
     + Date/Time
  1   R         20040328134623.1234+0300
Result Status +   25
  R   False      
Submission Reason   31
  R   False   REASON_SUBMISSION    F
     + identifier
  1   R     REASON_SUBMISSION    F
     + text
  2   O     REASON_SUBMISSION    FAD Diagnostics
     + name of coding system
  3   R     REASON_SUBMISSION    L

Segment - ORC

Description Opt Rep
Common Order Segment O False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Order Control   1
  R   False   SC = Status Change; NW = New Order   SC
     Placer Group Number   4
  RE          
     + entity identifier
  1   RE         234454
     + universal ID
  3   R         2.16.840.1.113883.3.5.8.1.2
     + universal ID type
  4   R         ISO
Order Status   5
  R   False   ORDER STATUS    CM
Date/Time of Transaction   9
  RE   False        
     + time
  1   R         200812061356-0800
Entered By   10
  RE   True        
     + ID number (ST)
  1   RE         CAS002
     + family name
  2   C          
        - surname
  1   R          
     + given name
  3   C          
     + assigning authority
  9   RE          
        - universal ID
  2   R         2.16.840.1.113883.3.5.1.2
        - universal ID type
  3   R         ISO
Verified By   11
  RE   True        
     + ID number (ST)
  1   RE         WIL012
     + family name
  2   C          
        - surname
  1   R          
     + given name
  3   C          
     + assigning authority
  9   RE          
        - universal ID
  2   R         2.16.840.1.113883.3.5.1.2.2
        - universal ID type
  3   R         ISO




Segment Group - RESULT

Description Opt Rep
OPU_R25.ACCESSION.SPECIMEN.ORDER.RESULT R True

Segment - OBX

Description Opt Rep
Observation/Result R False
Field Name Seq DT Seq Opt Rep Vocab Example Value
Value Type   2
  R   False   OBSERVATION_VALUE_TYPE    SN
Observation Identifier   3
  R   False   OBSERVATION_ID     
     + identifier
  1   R     OBSERVATION_ID.CODE    39021-1
     + text
  2   O     OBSERVATION_ID.TEXT    Abnormal Prion Prot Tiss Ql EIA
     + name of coding system
  3   R     OBSERVATION_ID.CS    LN
Observation Value   5
  R   False   TEST_RESULTS    POSITIVE
Units   6
  C   False   UNITS     
     + identifier
  1   R     UNITS.CODE    O.D.
     + text
  2   O     UNITS.TEXT    Optical Density
     + name of coding system
  3   R     UNITS.CS    ISO+
Abnormal Flags   8
  O   False   OBSERVATION_ABNORMAL_FLAG   
Observation Result Status   11
  R   False OBSERVATION_RESULT_STATUS      F
Observation Method   17
  RE   False   OBSERVATION_METHOD     
     + identifier
  1   O     OBSERVATION_METHOD.CODE    OMCode
     + text
  2   R     OBSERVATION_METHOD.TEXT    BIORAD ELISA
     + name of coding system
  3   O     OBSERVATION_METHOD.CS    LN
Date/Time of the Analysis   19
  RE   False        
     + time
  1   R         20040328134623.1234+0300