...
| Code Block |
|---|
MSH|^~\&|ClinSpark|[CUSTOMER NAME]|[LAB NAME]FH|Lab|ST|202305231055202403131824||ORM|1684857334857bd1ea811710372276819cf57c38|P|2.3 PID|1|25945920||S25^P1001^|S^R^EGarcia^Dennis^||1976092119980823|MF||XC|83071ST GAULT LN^^CITY^STATE^78209STREET^^SOMEWHERE^WI^53090||^^^|C||||^^^C^^^|||| CSS|0000-0001|Fasting Export Testb Data Stu|| CTI|1REPEAT||Yes ORC|NW|200170716934^|200170716934^LAB|B00104277-C99^|B00104277-C99^LAB|Urine aliquot 10 ml||||||||^Bass^-^^^^^N123^Fredrickson^Francine^^^^^N||||^^ OBR|1|200170716934^LABB00104277-C99^LAB|^LAB|BGLU^GLUCOSE^L12206^CALCIUM URINE^L|||202303281554202403131816||^||N||^|||^Bass^-^^^^^N123^Fredrickson^Francine^^^^^N||||^^||||||^||| ORC|NW|| |
MSH Segment
...
Sequence
...
Name
...
Value
...
Comment
...
1
...
Field Separator
...
|
...
Hard Coded
...
2
...
Encoding Characters
...
^~\&
...
B00104277-C99^|B00104277-C99^LAB|Urine aliquot 10 ml||||||||123^Fredrickson^Francine^^^^^N||||^^
OBR|2|B00104277-C99^LAB|^LAB|12207^PHOSPHATE URINE^L|||202403131816||^||N||^|||123^Fredrickson^Francine^^^^^N||||^^||||||^|||
ORC|NW|B00104277-C99^|B00104277-C99^LAB|Urine aliquot 10 ml||||||||123^Fredrickson^Francine^^^^^N||||^^
OBR|3|B00104277-C99^LAB|^LAB|12201^POTASSIUM URINE^L|||202403131816||^||N||^|||123^Fredrickson^Francine^^^^^N||||^^||||||^|||
ORC|NW|B00104277-C99^|B00104277-C99^LAB|Urine aliquot 10 ml||||||||123^Fredrickson^Francine^^^^^N||||^^
OBR|4|B00104277-C99^LAB|^LAB|12200^SODIUM URINE^L|||202403131816||^||N||^|||123^Fredrickson^Francine^^^^^N||||^^||||||^||| |
MSH Segment
Sequence | Name | Value | Comment |
1 | Field Separator | | | Hard Coded |
2 | Encoding Characters | ^~\& | Hard Coded |
3 | Sending Application | [Sending Application] | Obtained from Lab Interface Config |
4 | Sending Facility | [Sending Facility] | Obtained from Lab Interface Config |
5 | Receiving Application | [Receiving Application] | Obtained from Lab Interface Config |
6 | Receiving Facility | ST | Hard Coded |
7 | Date/Time of Message | Time of order file creation | Format: yyyyMMddHHmm |
8 | Security | NULL | Not Required |
9 | Message Type | ORM | Hard Coded |
10 | Message Control ID | System current time and ID | ClinSpark generates for each file |
11 | Processing ID | Environment ID | If production = P |
12 | Version ID | 2.3 | Hard Coded |
...
Sequence | Name | Value | Comment |
1 | Set ID | 1 | Hard Coded |
2 | Patient ID | [Subject Volunteer ID] | Obtained from Volunteer Profile |
3 | Patient Identifier List | NULL | Not Required |
4 | Alternate Patient ID - PID | 4.1 [Subject Screening Number] 4.2 [Subject Randomization Number] | Each sub-field will be separated with “^” *Randomization number only present if subject is randomized |
5 | Patient Name | 5.1 [Subject Last Name Initial] 5.2 [Subject First Name Initial] 5.3 [Subject Middle Name Initial] | Initials will be the first character (alpha, numeric or character) of the Subject First, Last and Middle name within the Volunteer Database in ClinSpark If no middle initial = empty Each sub-field will be separated with “^” Example 1: 
|A^2^J^2^| Example 2:  .png?version=2&modificationDate=1710438790994&cacheVersion=1&api=v2&width=201) |A^J^MJ^J^J| |
6 | Mother's Maiden Name | NULL | Not Required |
7 | Date/Time of Birth | [Subject Birth Date] | Format: yyyyMMdd |
8 | Administrative Sex | [Subject Gender] | Male and Female which will be stored as ‘M' and 'F’ |
9 | Patient Alias | NULL | Not Required |
10 | Race | [Subject Race Code] | Race Codes: American Indian or Alaskan Native = I Asian = A Black or African American = B Native Hawaiian or Other Pacific Islander = O White = C Other Race = O Unknown = X |
11 | Patient Address | 11.1 [Site Address] 11.2 NULL 11.3 [Site City] 11.4 [Site State] 11.5 [Site Postal Code] | Each sub-field will be separated with “^” Obtained from Site Details |
12 | County Code | NULL | Not Required |
13 | Phone Number - Home | NULL | Not Required |
14 | Phone Number - Business | NULL | Not Required |
15 | Primary Language | NULL | Not Required |
16 | Marital Status | NULL | Not Required |
17 | Religion | NULL | Not Required |
18 | Patient Account Number | ^^^C^^^ | Hard Coded Not Required |
.png?version=1&modificationDate=1710438763657&cacheVersion=1&api=v2&width=201)
...
Sequence | Name | Value | Comment | ||
1 | Study Scheduled Time Point | [Visit Number] | Study Event Visit Number | ||
2 | Study Scheduled Patient Time Point | [Timepoint] | Format: hh:mm:ss (segment # ) | ||
3 | Fasting Status This has not been tested | [Subject Fasting Status] | Alias context of ‘fasting’, ‘Fasting’ or ‘FASTING’ to be assigned within the form and item group for the fasting status to be included with the associated blood collection item. *The name of the alias has no impact to the fasting status being included. Not requiredStudy Scheduled Time Point | Null | Not Required |
ORC Segment
Sequence | Name | Value | Comment |
1 | Order Control | NW | Hard Coded |
2 | Placer Order Number | [Barcode] | Must be returned to ClinSpark This field must contain the same value as OBR-2 |
3 | Filler Order Number | [Barcode]^LAB | ‘LAB’ is Hard Coded |
4 | Placer Group Number | NULL | Not Required |
5 | Order Status | NULL | Not Required |
6 | Response Flag | NULL | Not Required |
7 | Quantity/Timing | NULL | Not Required |
8 | Parent Order | NULL | Not Required |
9 | Date/Time of Transaction | NULL | Not Required |
10 | Entered By | NULL | Not Required |
11 | Verified By | NULL | Not Required |
12 | Ordering Provider | 12.1 [ Site Investigator ID] (Required for billing) 12.2 [Site Investigator Last Name] 12.3 [Site Investigator First Name] 12.4 NULL 12.5 NULL 12.6 NULL 12.7 NULL 12.8 [Site NPI Number] (N) | Each sub-field will be separated with “^” |
13 | Enterer’s Location | NULL | Not Required |
14 | Call Back Phone Number | NULL | Not Required |
15 | Order Effective Date/Time | NULL | Not Required |
16 | Order Control Code Reason | ^^ | Not Required |
...
Sequence | Name | Value | Comment |
1 | Set ID - OBR | [OBR Sequence] | For the first repeat of the OBR segment, the sequence number shall be one (1), for the second repeat, the sequence number shall be two (2), etc. |
2 | Placer Order Number | [Barcode]^LAB | ‘LAB’ is hardcoded |
3 | Filler Order Number | ^LAB | Hard Coded |
4 | Universal Service Identifier | 4.1 [Lab Test ID] 4.2 [Lab Test Name] 4.3 [L] | Identifier for the orderable tests Each sub-field will be separated with “^” 'L' is Hard Coded |
5 | Priority - OBR | NULL | Not Required |
6 | Request Date/Time | NULL | Not Required |
7 | Observation Date/Time | [Sample Collection Date/Time] | Format: yyyyMMddHHmm |
8 | Observation End Date/Time | NULL | Not Required |
9 | Collection Volume | NULL | Not Required |
10 | Collector Identifier | NULL | Not Required |
11 | Specimen Action Code | N (New Order) | Hard Coded |
12 | Danger Code | NULL | Not Required |
13 | Relevant Clinical Information | NULL | Not Required |
14 | Specimen Received Date/Time | NULL | Not Required |
15 | Specimen Source | NULL | Not Required |
16 | Ordering Provider | 16.1 [Investigator ID] (Required for billing) 16.2 [Investigator Last Name] 16.3 [Investigator First Name] 16.4 NULL 16.5 NULL 16.6 NULL 16.7 NULL 16.8 [NPI Number] (N) | This field will contain the same value as ORC.12 and each sub-field will be separated with “^” |
Result Message Segments
ClinSpark does not accept any embedded binary content, such as PDFs or images. We can consume textual results only.
ClinSpark looks only for result information, and ignores any information in the MSH or PID segments. This is because ClinSpark is already the source of truth for this information, and we do not update any of this core subject data based on results of the lab.
ClinSpark expects to find the original specimen barcode in ORC-2 and OBR-2, the same value which was passed for that same sample in the HL7 order file from us. This value is used on our end to look up that specimen so that the contained results can be applied properly.
Example Result Message
...
.6 NULL 16.7 NULL 16.8 [NPI Number] (N) | This field will contain the same value as ORC.12 and each sub-field will be separated with “^” |
Result Message Segments
ClinSpark does not accept any embedded binary content, such as PDFs or images. We can consume textual results only.
ClinSpark looks only for result information, and ignores any information in the MSH or PID segments. This is because ClinSpark is already the source of truth for this information, and we do not update any of this core subject data based on results of the lab.
ClinSpark expects to find the original specimen barcode in ORC-2 and OBR-2, the same value which was passed for that same sample in the HL7 order file from us. This value is used on our end to look up that specimen so that the contained results can be applied properly.
Example Result Message
| Code Block |
|---|
MSH|^~\&|CLINSPARKMOCK||||20240313181712||ORU^R01||T|2.4||||||||| PID|1|5920|5920||G^D||19980823|F||||||||||||||||||||| ORC|RE|B00104277-C99^CLINSPARK|1710371832440||CM||||20240313181712|||123^CPU^^^^Doctor||||^| OBR|1|B00104277-C99|1710371832440|112^24-Hour Urine Panel|||20240313181712|||||||20240313181712||123^CPU^^^^Doctor||||||||112|F||^^^^^R|||||||||| OBX|1|NM|12201^Potassium Urine||27.7|mmol/L|17.0 - 99.0||||F|||20240313181712||||| OBX|2|NM|12206^Calcium Urine||0.78|mmol/L|0.13 - 8.90||||F|||20240313181712||||| OBX|3|NM|12207^Phosphate Urine||37.23|mmol/L|1.60 - 61.00||||F|||20240313181712||||| OBX|14|NM|BGLU^Glucose|2345-7|155|mg/dL|70 - 105|HH12200^Sodium Urine||171.3|mmol/L|30.0 - 90.0|H|||F|||202303281554|||||20230411154920240313181712|||||| NTE|1||Clinic Notified of High Alert Value by RNL |
MSH Segment
Sequence | Name | Value | Comment |
1 | Field Separator | | | Received from ClinAxys |
2 | Encoding Characters | ^~\& | Received from ClinAxys |
3 | Sending Application | [Sending Application] | Received from ClinAxys |
4 | Sending Facility | [Sending Facility] | Received from ClinAxys |
5 | Receiving Application | [Receiving Application] | Received from ClinAxys |
6 | Receiving Facility | [Receiving Facility] | Received from ClinAxys |
7 | Date/Time of Message | Time of result file creation | Received from ClinAxys Format: yyyyMMddHHmmss |
8 | Security | NULL | Not Required |
9 | Message Type | ORU^R01 | Received from ClinAxys |
10 | Message Control ID | System generated | Received from ClinAxys |
11 | Processing ID | System generated | Received from ClinAxys |
12 | Version ID2 | .5.1HL7 Version ID | Received from ClinAxys |
PID Segment
...
Upon creating an order within ClinSpark a PDF requisition will download to accompany the samples to the laboratory for chain of custody purposes. This requisition is configurable upon request.
Example PDF Requisition
TBD
Name | Value | Comment |
Receiving Facility | [Receiving Facility] | Obtained from Lab Interface Config |
Account Number | [Sending Facility] | Obtained from Lab Interface Config |
Name | [Lab Interface Site Name] | Obtained from Lab Interface Config |
Creation Time | Time of order file creation | Format: ddMMMyyyy HH:mm:ss |
Bill Code | Client | Hard Coded |
Address | [Lab Interface Site Address] | Obtained from Lab Interface Config |
Total | Total samples in order | Each unique barcode increments this total |
Physician Name | [Lab Interface Site Investigator Name] | Obtained from Lab Interface Config |
City, State, Zip | [Lab Interface City, State, Zip] | Obtained from Lab Interface Config |
Initials | [Subject FirstMiddleLast Name Initial] | Obtained from Volunteer Profile |
Sex | [Subject Gender] | Male and Female which will be stored as ‘M' and 'F’ |
ID | [Subject Volunteer ID](Subject #; Study Name) | Obtained from Volunteer Profile and study details |
DOB | [Subject Birth Date] | Format: dd-MMM-yyyy |
Barcode | [Barcode] | Unique Identifier for Each Sample |
Container | [Specimen Container] | *If containers are assigned to a test/panel then present |
Lab Test Code | [Order ID] | Obtained from Test Compendium |
Test Name | [Test Name] | Obtained from Test Compendium |
Collection Date | [Sample Collection Date/Time] | Format: ddMMMyyyy hh:mm:ss |
Quantity / Units | NULL | Not Needed |
AOE | [Ask on Order Entry] | *If questions / answers are included in data collection those questions / answers are then present |