Outbound ######## HL7 messages - General Clinical Order Message (OMG^O19) (implemented for `Eye Care Transactions - Procedure Status Update [EYECARE-22] `_) - Imaging Order Message (OMI^O23) (implemented for `AI Workflow for Imaging (AIW-I) - Procedure Update [RAD-13] `_) are sent to other HL7 applications/receivers if HL7 receivers are to be `notified about procedure status updates `_ or `on receive of studies with(-out) any MWL items associated to it `_. This notification can be triggered for : 1. Updates to MWL items in archive, on : - Receive of MPPS : Study referenced in MPPS is also associated with an existing MWL item in archive - Receive of studies : Study is associated with an existing MWL item in archive 2. Receive of studies either by : - DICOM Studies stored conforming to `Storage AE Specification `_ - DICOM Studies / Bulkdata stored using `STOW-RS Services `_ - `Reports stored by HL7 ORU `_ .. _omg_out_messages: Outbound Messages ================= .. _omg_out_omg_o19: OMG - General Clinical Order Message (Event O19) ------------------------------------------------ Supported HL7 version: 2.5.1 (EYECARE-22) .. _omg_o19_event: Trigger Event ^^^^^^^^^^^^^ This message is sent out by the archive : - when study received by the archive has modality worklist entries referencing it in the archive - on receive of MPPS (Modality Performed Procedure Step). Supported Segments ^^^^^^^^^^^^^^^^^^ The following segments are sent in an outgoing OMG^O19^OMG_O19 message: .. csv-table:: Supported segments of OMG^O19^OMG_O19 (HL7 v2.5.1) :header: Segment, Meaning, Usage, Card., HL7 chapter :widths: 15, 40, 15, 15, 15 MSH - :ref:`tab_msh_251`, Message Header, R, [1..1], 2 PID - :ref:`tab_pid_251_out`, Patient Identification, O, [0..1], 3 NTE - :ref:`tab_nte_251_out`, Notes and Comments (for PID), O, [0..1], 2 PV1 - :ref:`tab_pv1_omg_251`, Patient Visit, O, [0..1], 3 ORC - :ref:`tab_orc_omg_251`, Common Order, R, [1..1], 4 TQ1 - :ref:`tab_tq1_omg_251`, Timing and Quantity, R, [1..1], 4 OBR - :ref:`tab_obr_omg_251`, Observation Request, R, [1..1], 7 OBX - :ref:`tab_obx_omg_251`, Observation Detail, O, [1..1], 7 .. _omg_o19_actions: Expected Actions ^^^^^^^^^^^^^^^^ The DSS/Order Filler shall process the order status based upon the internal application (such as the procedure is completed and is ready for interpretation). The DSS/Order Filler is recommended to convey the order status to the user of the system. .. _omi_out_omi_o23: OMI - Imaging Order Message (Event O23) --------------------------------------- Supported HL7 version: 2.5.1 Trigger Event ^^^^^^^^^^^^^ Same as specified in :numref:`omg_o19_event`. Supported Segments ^^^^^^^^^^^^^^^^^^ The following segments are sent in an outgoing OMI^O23^OMI_O23 message: .. csv-table:: Supported segments of OMI^O23^OMI_O23 (HL7 v2.5.1) :header: Segment, Meaning, Usage, Card., HL7 chapter :widths: 15, 40, 15, 15, 15 MSH - :ref:`tab_msh_251`, Message Header, R, [1..1], 2 PID - :ref:`tab_pid_251_out`, Patient Identification, O, [0..1], 3 NTE - :ref:`tab_nte_251_out`, Notes and Comments (for PID), O, [0..1], 2 PV1 - :ref:`tab_pv1_omg_251`, Patient Visit, O, [0..1], 3 ORC - :ref:`tab_orc_omg_251`, Common Order, R, [1..1], 4 TQ1 - :ref:`tab_tq1_omg_251`, Timing and Quantity, R, [1..1], 4 OBR - :ref:`tab_obr_omg_251`, Observation Request, R, [1..1], 7 IPC - :ref:`tab_ipc_omi_251`, Imaging Procedure Control, O, [1..1], 7 Expected Actions ^^^^^^^^^^^^^^^^ Same as specified in :numref:`omg_o19_actions`. .. _omg_out_segments: Outbound Message Segments ========================= .. _omg_out_msh: MSH - Message Header segment ---------------------------- Same as specified in :ref:`tab_msh_251` .. _omg_out_pid: PID - Patient Identification segment ------------------------------------ Same as specified in :ref:`tab_pid_251_out` .. _omg_out_nte: NTE - Notes and Comments segment for (PID) ------------------------------------------ Same as specified in :ref:`tab_nte_251_out` .. _omg_out_pv1: PV1 - Patient Visit segment --------------------------- .. csv-table:: PV1 - Patient Visit segment (HL7 v2.5.1) :name: tab_pv1_omg_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 4, SI, O, , 01627, Set ID - PV1 2, 1, IS, R, , 00132, **Patient Class** 3, 80, PL, C, , 00133, Assigned Patient Location 4, 2, IS, O, 0007, 00134, Admission Type 5, 20, CX, O, , 00135, Preadmit Number 6, 80, PL, O, , 00136, Prior Patient Location 7, 60, XCN, C, 0010, 00137, Attending Doctor 8, 60, XCN, C, 0010, 00138, Referring Doctor 9, 60, XCN, R2, 0010, 00139, Consulting Doctor 10, 3, IS, C, 0069, 00140, Hospital Service 11, 80, PL, O, , 00141, Temporary Location 12, 2, IS, O, 0087, 00142, Preadmit Test Indicator 13, 2, IS, O, 0092, 00143, Readmission Indicator 14, 3, IS, O, 0023, 00144, Admit Source 15, 2, IS, C, 0009, 00145, Ambulatory Status 16, 2 , IS, O, 0099, 00146, VIP Indicator 17, 60, XCN, C, 0010, 00147, Admitting Doctor 18, 2, IS, O, 0018, 00148, Patient Type 19, 20, CX, C, , 00149, Visit Number 20, 50, FC, O, 0064, 00150, Financial Class 21, 2, IS, O, 0032, 00151, Charge Price Indicator 22, 2, IS, O, 0045, 00152, Courtesy Code 23, 2, IS, O, 0046, 00153, Credit Rating 24, 2, IS, O, 0044, 00154, Contract Code 25, 8, DT, O, , 00155, Contract Effective Date 26, 12, NM, O, , 00156, Contract Amount 27, 3, NM, O, , 00157, Contract Period 28, 2, IS, O, 0073, 00158, Interest Code 29, 1, IS, O, 0110, 00159, Transfer to Bad Debt Code 30, 8, DT, O, , 00160, Transfer to Bad Debt Date 31, 10, IS, O, 0021, 00161, Bad Debt Agency Code 32, 12, NM, O, , 00162, Bad Debt Transfer Amount 33, 12, NM, O, , 00163, Bad Debt Recovery Amount 34, 1, IS, O, 0111, 00164, Delete Account Indicator 35, 8, DT, O, , 00165, Delete Account Date 36, 3, IS, O, 0112, 00166, Discharge Disposition 37, 25, CM, O, 0113, 00167, Discharge to Location 38, 80, CE, O, 0114, 00168, Diet Type 39, 2, IS, O, 0115, 00169, Servicing Facility 40, 1, IS, O, 0116, 00170, Bed Status 41, 2, IS, O, 0117, 00171, Account Status 42, 80, PL, O, , 00172, Pending Location 43, 80, PL, O, , 00173, Prior Temporary Location 44, 26, TS, O, , 00174, Admit Date/Time 45, 26, TS, O, , 00175, Discharge Date/Time 46, 12, NM, O, , 00176, Current Patient Balance 47, 12, NM, O, , 00177, Total Charges 48, 12, NM, O, , 00178, Total Adjustments 49, 12, NM, O, , 00179, Total Payments 50, 20, CX, O, 0203, 00180, Alternate Visit ID 51, 1, IS, C, 0326, 01226, Visit Indicator 52, 60, XCN, O, 0010, 01224, Other Healthcare Provider .. _omg_out_orc: ORC - Order Control segment --------------------------- .. csv-table:: ORC - Order Control segment (HL7 v2.5.1) :name: tab_orc_omg_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 2, ID, R, 0119, 00215, **Order Control** 2, 22, EI, R, , 00216, **Placer Order Number** 3, 22, EI, X, , 00217, **Filler Order Number** 4, 22, EI, C, , 00218, Placer Group Number 5, 2, ID, O, 0038, 00219, **Order Status** 6, 1, ID, O, 0121, 00220, Response Flag 7, 200, TQ, X, , 00221, Quantity/Timing 8, 200, EIP, C, , 00222, Parent 9, 26, TS, O, , 00223, Date/Time of Transaction 10, 250, XCN, O, , 00224, Entered By 11, 250, XCN, O, , 00225, Verified By 12, 250, XCN, O, , 00226, Ordering Provider 13, 80, PL, O, , 00227, Enterer's Location 14, 250, XTN, O, , 00228, Callback Phone Number 15, 26, TS, O, , 00229, Order Effective Date/Time 16, 250, CE, O, , 00230, Order Control Code Reason 17, 250, CE, O, , 00231, Entering Organization 18, 250, CE, O, , 00232, Entering Device 19, 250, XCN, O, , 00233, Action By 20, 250, CE, O, 0339, 01310, Advanced Beneficiary Notice Code 21, 250, XON, O, , 01311, Ordering Facility Name 22, 250, XAD, O, , 01312, Ordering Facility Address 23, 250, XTN, O, , 01313, Ordering Facility Phone Number 24, 250, XAD, O, , 01314, Ordering Provider Address 25, 250, CWE, O, , 01473, Order Status Modifier 26, 60, CWE, C, 0552, 01641, Advanced Beneficiary Notice Override Reason 27, 26, TS, O, , 01642, Filler's Expected Availability Date/Time 28, 250, CWE, O, 0177, 00615, Confidentiality Code 29, 250, CWE, O, 0482, 01643, Order Type 30, 250, CNE, O, 0483, 01644, Enterer Authorization Mode 31, 250, CWE, O, , 02286, Parent Universal Service Identifier .. _omg_out_tq1: TQ1 - Timing/Quantity segment ----------------------------- .. csv-table:: TQ1 - Timing/Quantity segment (HL7 v2.5.1) :name: tab_tq1_omg_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 4, SI, O, , 01627, Set ID - TQ1 2, 20, CQ, O, , 01628, Quantity 3, 540, RPT, O, 0335, 01629, Repeat Pattern 4, 20, TM, O, , 01630, Explicit Time 5, 20, CQ, O, , 01631, Relative Time and Units 6, 20, CQ, O, , 01632, Service Duration 7, 26, TS, R, , 01633, **Start Date/Time** 8, 26, TS, O, , 01634, End Date/Time 9, 250, CWE, O, 0485, 01635, Priority 10, 250, TX, O, , 01636, Condition Text 11, 250, TX, O, 0065, 01637, Text Instruction 12, 10, ID, C, 0472, 01638, Conjunction 13, 20, CQ, O, , 01639, Occurrence Duration 14, 10, NM, O, , 01640, Total Occurrences .. _omg_out_obr: OBR - Observation Request segment --------------------------------- .. csv-table:: OBR - Observation Request segment (HL7 v2.5.1) :name: tab_obr_omg_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 4, SI, O, , 00237, SetID - OBR 2, 22, EI, R, , 00216, **Placer Order Number** 3, 22, EI, O, , 00217, **Filler Order Number** 4, 250, CE, O, , 00238, Universal Service ID 5, 2, ID, O, , 00239, Priority 6, 26, TS, O, , 00240, Requested Date/Time 7, 26, TS, O, , 00241, Observation Date/Time 8, 26, TS, O, , 00242, Observation End Date/Time 9, 20, CQ, O, , 00243, Collection Volume 10, 250, XCN, O, , 00244, Collection Identifier 11, 1, ID, O, 0065, 00245, Specimen Action Code 12, 250, CE, O, , 00246, Danger Code 13, 300, ST, C, , 00247, Relevant Clinical Info 14, 26, TS, X, , 00248, Specimen Received Date/Time 15, 300, SPS, X, 0070, 00249, Specimen Source 16, 250, XCN, O, , 00226, Ordering Provider 17, 250, XTN, O, , 00250, Order Callback Phone Number 18, 60, ST, O, , 00251, **Placer Field 1** 19, 60, ST, O, , 00252, **Placer Field 2** 20, 60, ST, O, , 00253, Filler Field 1 21, 60, ST, O, , 00254, Filler Field 2 22, 26, TS, O, , 00255, Results Rpt/Status Chng - Date/Time 23, 40, MOC, O, , 00256, Charge to Practice 24, 10, ID, O, 0074, 00257, Diagnostic Service Sect ID 25, 1, ID, O, 0123, 00258, Result Status 26, 400, PRL, O, , 00259, Parent Result 27, 200, TQ, X, , 00221, Quantity/Timing 28, 250, XCN, O, , 00260, Result Copies To 29, 200, EIP, C, , 00261, Parent 30, 20, ID, O, 0124, 00262, Transportation Mode 31, 250, CE, O, , 00263, Reason For Study 32, 200, NDL, O, , 00264, Principal Result Interpreter 33, 200, NDL, O, , 00265, Assistant Result Interpreter 34, 200, NDL, O, , 00266, Technician 35, 200, NDL, O, , 00267, Transcriptionist 36, 26, TS, O, , 00268, Scheduled Date/Time 37, 4, NM, O, , 01028, Number of Sample Containers 38, 250, CE, O, , 01029, Transport Logistics of Collected Sample 39, 250, CE, O, , 01030, Collector's Comment 40, 250, CE, O, , 01031, Transport Arrangement Responsibility 41, 30, ID, O, 0224, 01032, Transport Arranged 42, 1, ID, O, 0225, 01033, Escort Required 43, 250, CE, O, , 01034, Planned Patient Transport Comment 44, 250, CE, O, 0088, 00393, Procedure Code 45, 250, CE, O, 0340, 01036, Procedure Code Modifier 46, 250, CE, O, 0411, 01474, Placer Supplemental Service Information 47, 250, CE, O, 0411, 01475, Filler Supplemental Service Information 48, 250, CWE, O, 0476, 01646, Medically Necessary Duplicate Procedure Reason 49, 2, IS, O, 0507, 01647, Result Handling 50, 250, CWE, O, , 02286, Parent Universal Service Identifier .. _omg_out_obx: OBX - Observation / Result segment ---------------------------------- .. csv-table:: OBX - Observation Result segment (HL7 v2.5.1) :name: tab_obx_omg_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 4, SI, O, , 00569, SetID - OBX 2, 2, ID, C, , 00570, **Value Type** 3, 250, CE, R, , 00571, **Observation Identifier** 4, 20, ST, C, , 00572, Observation Sub-ID 5, 99999, VARIES, C, , 00573, **Observation Value** .. _omi_out_ipc: IPC - Imaging Procedure Control segment --------------------------------------- .. csv-table:: IPC - Imaging Procedure Control segment (HL7 v2.5.1) :name: tab_ipc_omi_251 :header: SEQ, LEN, DT, OPT, TBL#, ITEM #, Element Name :widths: 8, 8, 8, 8, 8, 12, 48 1, 80, EI, R, , 01330, **Accession Identifier** 2, 22, EI, R, , 01658, Requested Procedure ID 3, 70, EI, R, , 01659, **Study Instance UID** 4, 22, EI, R, , 01660, Scheduled Procedure Step ID 5, 16, CE, O, , 01661, **Modality** 6, 250, CE, O, , 01662, Protocol Code 7, 22, EI, O, , 01663, Scheduled Station Name 8, 250, CE, O, , 01664, Scheduled Procedure Step Location 9, 16, ST, O, , 01665, **Scheduled AE Title** Element names in **bold** indicates that the field is used by |product|. .. _order_out_dicom: DICOM to HL7 Order Mapping ========================== Mappings between HL7 and DICOM are illustrated in the following manner: - Element Name (HL7 item_number.component.sub-component #/ DICOM (group, element)) - The component/sub-component value is not listed if the HL7 element should not contain multiple components/sub-components. .. _order_out_omg_o19_dicom_mwl: OMG - DICOM Modality Worklist Attributes to HL7 order mapping ------------------------------------------------------------- Applicable on : - Outgoing notification is OMG^O19 - Study stored to archive is associated with a MWL .. csv-table:: DICOM Modality Worklist Attributes to HL7 order OMG^O19 mapping :name: dicom_to_omg_mwl :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Scheduled Procedure Step Start DateTime, "(0040, 4005)", Start Date/Time, 01633, TQ1:7, [#Note6]_ Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Accession Number, "(0008, 0050)", Placer Field 1, 00251, OBR:18 Issuer of Accession Number Sequence, "(0008, 0051)" >Local Namespace Entity ID, "(0040, 0031)", Placer Field 1 #, 00251.2, OBR:18.2 >Universal Entity ID, "(0040, 0032)", Placer Field 1 #, 00251.3, OBR:18.3 >Universal Entity ID Type, "(0040, 0033)", Placer Field 1 #, 00251.4, OBR:18.4 Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1 Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2 >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3 >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4 Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1 Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2 >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3 >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4 , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) Study Instance UID, "(0020, 000D)", Observation Value, 00573, OBX:5, [#Note5]_ .. _order_out_omi_o23_dicom_mwl: OMI - DICOM Modality Worklist Attributes to HL7 order mapping ------------------------------------------------------------- Applicable on : - Outgoing notification is OMI^O23 - Study stored to archive is associated with a MWL .. csv-table:: DICOM Modality Worklist Attributes to HL7 order OMI^O23 mapping :name: dicom_to_omi_mwl :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Modality, "(0008, 0060)", Modality, 01661, IPC:5, Scheduled Procedure Step Start DateTime, "(0040, 4005)", Start Date/Time, 01633, TQ1:7, [#Note6]_ Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Accession Number, "(0008, 0050)", Accession Identifier, 01330, IPC:1 Issuer of Accession Number Sequence, "(0008, 0051)" >Local Namespace Entity ID, "(0040, 0031)", Accession Identifier, 01330.2, IPC:1.2 >Universal Entity ID, "(0040, 0032)", Accession Identifier, 01330.3, IPC:1.3 >Universal Entity ID Type, "(0040, 0033)", Accession Identifier, 01330.4, IPC:1.4 Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1 Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2 >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3 >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4 Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1 Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2 >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3 >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4 , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) Study Instance UID, "(0020, 000D)", Study Instance UID, 01659, IPC:3, .. _order_out_omg_o19_dicom_study: OMG - DICOM Composite Object Attributes to HL7 order mapping ------------------------------------------------------------ Applicable on : - Outgoing notification is OMG^O19 - Study stored to archive is NOT associated with any MWL .. csv-table:: DICOM Composite Object Attributes to HL7 order OMG^O19 mapping :name: dicom_to_omg_study :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Scheduled Procedure Step Start DateTime, "(0040, 4005)", Start Date/Time, 01633, TQ1:7, [#Note6]_ Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Accession Number, "(0008, 0050)", Placer Field 1, 00251, OBR:18 Issuer of Accession Number Sequence, "(0008, 0051)" >Local Namespace Entity ID, "(0040, 0031)", Placer Field 1 #, 00251.2, OBR:18.2 >Universal Entity ID, "(0040, 0032)", Placer Field 1 #, 00251.3, OBR:18.3 >Universal Entity ID Type, "(0040, 0033)", Placer Field 1 #, 00251.4, OBR:18.4 Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1, [#Note7]_ Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4, [#Note7]_ Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1, [#Note7]_ Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4, [#Note7]_ , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) Study Instance UID, "(0020, 000D)", Observation Value, 00573, OBX:5, [#Note5]_ .. _order_out_omi_o23_dicom_study: OMI - DICOM Study Attributes to HL7 order mapping ------------------------------------------------- Applicable on : - Outgoing notification is OMI^O23 - Study stored to archive is NOT associated with any MWL .. csv-table:: DICOM Composite Object Attributes to HL7 order OMI^O23 mapping :name: dicom_to_omi_study :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Modality, "(0008, 0060)", Modality, 01661, IPC:5, Scheduled Procedure Step Start DateTime, "(0040, 4005)", Start Date/Time, 01633, TQ1:7, [#Note6]_ Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Accession Number, "(0008, 0050)", Accession Identifier, 01330, IPC:1 Issuer of Accession Number Sequence, "(0008, 0051)" >Local Namespace Entity ID, "(0040, 0031)", Accession Identifier, 01330.2, IPC:1.2 >Universal Entity ID, "(0040, 0032)", Accession Identifier, 01330.3, IPC:1.3 >Universal Entity ID Type, "(0040, 0033)", Accession Identifier, 01330.4, IPC:1.4 Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1, [#Note7]_ Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4, [#Note7]_ Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1, [#Note7]_ Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4, [#Note7]_ , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) Study Instance UID, "(0020, 000D)", Study Instance UID, 01659, IPC:3, .. _order_out_omg_o19_dicom_mpps: OMG - DICOM Modality Performed Procedure Step Attributes to HL7 order mapping ----------------------------------------------------------------------------- Applicable on : - Outgoing notification is OMG^O19 - MPPS sent to archive .. csv-table:: DICOM Modality Performed Procedure Step Attributes to HL7 order OMG^O19 mapping :name: dicom_to_omg_mpps :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM Performed Procedure Step Start DateTime, "(0040, 4050)", Start Date/Time, 01633, TQ1:7 **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Scheduled Step Attributes Sequence, "(0040,0270)", >Accession Number, "(0008, 0050)", Placer Field 1, 00251, OBR:18 >Issuer of Accession Number Sequence, "(0008, 0051)" >>Local Namespace Entity ID, "(0040, 0031)", Placer Field 1 #, 00251.2, OBR:18.2 >>Universal Entity ID, "(0040, 0032)", Placer Field 1 #, 00251.3, OBR:18.3 >>Universal Entity ID Type, "(0040, 0033)", Placer Field 1 #, 00251.4, OBR:18.4 >Study Instance UID, "(0020, 000D)", Observation Value, 00573, OBX:5, [#Note5]_ Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1, [#Note7]_ Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4, [#Note7]_ Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1, [#Note7]_ Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4, [#Note7]_ , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) .. _order_out_omi_o23_dicom_mpps: OMI - DICOM Modality Performed Procedure Step Attributes to HL7 order mapping ----------------------------------------------------------------------------- Applicable on : - Outgoing notification is OMI^O23 - MPPS sent to archive .. csv-table:: DICOM Modality Performed Procedure Step Attributes to HL7 order OMI^O23 mapping :name: dicom_to_omi_mpps :header: DICOM Attribute, DICOM Tag, HL7 Field, HL7 Item #, HL7 Segment, Note **SOP Common** Specific Character Set, "(0008, 0005)", Character Set, 00692, MSH:18, :ref:`tab_hl7_dicom_charset` **Patient Identification** Patient's Name, "(0010, 0010)", Patient Name, 00108, PID:5 Patient ID, "(0010, 0020)", Patient Identifier List, 00106.1, PID:3.1 Issuer of Patient ID, "(0010, 0021)", Patient Identifier List, 00106.4.1, PID:3.4.1 Issuer of Patient ID Qualifiers Sequence, "(0010, 0024)" >Item, "(FFFE, E000)" >Universal Entity ID, "(0040, 0032)", Patient Identifier List, 00106.4.2, PID:3.4.2 >Universal Entity ID Type, "(0040, 0033)", Patient Identifier List, 00106.4.3, PID:3.4.3 Other Patient IDs Sequence, "(0010,1002)", Patient Identifier List, 00106, PID:3, [#Note4]_ **Patient Demographic** Patient's Birth Date, "(0010, 0030)", Date/Time of Birth, 00110, PID:7 Patient's Sex, "(0010, 0040)", Administrative Sex, 00111.1, PID:8.1 Patient Comments, "(0010, 4000)", Comment, 00098, NTE:3 **Visit Identification** Route of Admissions, "(0038, 0016)", Patient Class, 00132, PV1:2, [#Note3]_ Admission ID, "(0038, 0010)", Visit Number, 00149.1, PV1:19.1 Issuer of Admission ID Sequence, "(0038, 0014)" >Item, "(FFFE, E000)" >Local Namespace Entity ID, "(0040, 0031)", Visit Number, 00149.4.1, PV1:19.4.1 >Universal Entity ID, "(0040, 0032)", Visit Number, 00149.4.2, PV1:19.4.2 >Universal Entity ID Type, "(0040, 0033)", Visit Number, 00149.4.3, PV1:19.4.3 **Scheduled Procedure Step** Scheduled Procedure Step Status, "(0040, 0020)", Order Control, 00215, ORC:1, Set to SC , , Order Status, 00219, ORC:5, Set to CM Performed Procedure Step Start DateTime, "(0040, 4050)", Start Date/Time, 01633, TQ1:7 Modality, "(0008, 0060)", Modality, 01661, IPC:5 Performed Station AE Title, "(0040, 0241)", Scheduled AE Title, 01665, IPC:9 **Requested Procedure** Requested Procedure ID, "(0040, 1001)", Placer field 2, 00252, OBR:19 **Imaging Request** Scheduled Step Attributes Sequence, "(0040,0270)", >Accession Number, "(0008, 0050)", Accession Identifier, 01330, IPC:1 >Issuer of Accession Number Sequence, "(0008, 0051)" >>Local Namespace Entity ID, "(0040, 0031)", Accession Identifier, 01330.2, IPC:1.2 >>Universal Entity ID, "(0040, 0032)", Accession Identifier, 01330.3, IPC:1.3 >>Universal Entity ID Type, "(0040, 0033)", Accession Identifier, 01330.4, IPC:1.4 >Study Instance UID, "(0020, 000D)", Study Instance UID, 01659, IPC:3, Placer Issuer and Number, "(0040, 2016)", Placer Order #, 00216.1, ORC:2.1, [#Note7]_ Order Placer Identifier Sequence, "(0040, 0026)" >Local Namespace Entity ID, "(0040, 0031)", Placer Order #, 00216.2, ORC:2.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Placer Order #, 00216.3, ORC:2.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Placer Order #, 00216.4, ORC:2.4, [#Note7]_ Filler Issuer and Number, "(0040, 2017)", Filler Order #, 00217.1, ORC:3.1, [#Note7]_ Order Filler Identifier Sequence, "(0040, 0027)" >Local Namespace Entity ID, "(0040, 0031)", Filler Order #, 00217.2, ORC:3.2, [#Note7]_ >Universal Entity ID, "(0040, 0032)", Filler Order #, 00217.3, ORC:3.3, [#Note7]_ >Universal Entity ID Type, "(0040, 0033)", Filler Order #, 00217.4, ORC:3.4, [#Note7]_ , , Observation Result Status, 00579, OBX:11, Set to O (= Order detail description only) .. [#Note1] If the Procedure Status Update is triggered by MPPS, and the MPPS was received with status DISCONTINUED or IN_PROGRESS, then the value set is DC or IP respectively. If the Procedure Status Update is triggered by MPPS, and the MPPS was received with status COMPLETED or if the Procedure Status Update is triggered by a Study then the value set is CM. .. [#Note2] If the Procedure Status Update is triggered by MPPS, this value is populated from the `Performed Procedure Step Start Date and Time` of MPPS attributes. Alternatively, if the Procedure Status Update is triggered when a Study (which has MWL entries referencing it) is completely received, then this value is populated from the created time of the task. (The `task` here refers to a task created in database for sending out the HL7 notification.) Refer `Synchronize external HL7 receivers on updates of Requested Procedures `_ .. [#Note3] Route of Admissions (0038, 0016) DICOM attribute, if present, shall be mapped to PV1:2. If this DICOM attribute is absent, default "U" (denoting Patient Class as Unknown) shall be used. .. [#Note4] Each **Other Patient IDs Sequence (0010,1002)** item is populated in patient identifiers list in the specified segment field separated using **Repetition Separator ~** .. [#Note5] If outgoing notification message is OMG^O19, Study Instance UID is sent in OBX segment field 5, else for OMI^O23 notification, IPC segment field 3 is used. .. [#Note6] Set to current date time when notification is sent out. .. [#Note7] Populated with a value only if configured in `HL7 Procedure Status Update Template Parameters(s) `_