Documentation
¶
Overview ¶
Package h260 contains the data structures for HL7 v2.6.
Index ¶
- Variables
- type ABS
- type ACC
- type ACK
- type AD
- type ADD
- type ADJ
- type ADR_A19
- type ADR_A19_Insurance
- type ADR_A19_Procedure
- type ADR_A19_QueryResponse
- type ADT_A01
- type ADT_A01_Insurance
- type ADT_A01_Procedure
- type ADT_A02
- type ADT_A03
- type ADT_A03_Insurance
- type ADT_A03_Procedure
- type ADT_A04
- type ADT_A04_Insurance
- type ADT_A04_Procedure
- type ADT_A05
- type ADT_A05_Insurance
- type ADT_A05_Procedure
- type ADT_A06
- type ADT_A06_Insurance
- type ADT_A06_Procedure
- type ADT_A07
- type ADT_A07_Insurance
- type ADT_A07_Procedure
- type ADT_A08
- type ADT_A08_Insurance
- type ADT_A08_Procedure
- type ADT_A09
- type ADT_A10
- type ADT_A11
- type ADT_A12
- type ADT_A13
- type ADT_A13_Insurance
- type ADT_A13_Procedure
- type ADT_A14
- type ADT_A14_Insurance
- type ADT_A14_Procedure
- type ADT_A15
- type ADT_A16
- type ADT_A16_Insurance
- type ADT_A16_Procedure
- type ADT_A17
- type ADT_A18
- type ADT_A20
- type ADT_A21
- type ADT_A22
- type ADT_A23
- type ADT_A24
- type ADT_A25
- type ADT_A26
- type ADT_A27
- type ADT_A28
- type ADT_A28_Insurance
- type ADT_A28_Procedure
- type ADT_A29
- type ADT_A30
- type ADT_A31
- type ADT_A31_Insurance
- type ADT_A31_Procedure
- type ADT_A32
- type ADT_A33
- type ADT_A34
- type ADT_A35
- type ADT_A36
- type ADT_A37
- type ADT_A38
- type ADT_A39
- type ADT_A39_Patient
- type ADT_A40
- type ADT_A40_Patient
- type ADT_A41
- type ADT_A41_Patient
- type ADT_A42
- type ADT_A42_Patient
- type ADT_A43
- type ADT_A43_Patient
- type ADT_A44
- type ADT_A44_Patient
- type ADT_A45
- type ADT_A45_MergeInfo
- type ADT_A46
- type ADT_A47
- type ADT_A48
- type ADT_A49
- type ADT_A50
- type ADT_A51
- type ADT_A52
- type ADT_A53
- type ADT_A54
- type ADT_A55
- type ADT_A60
- type ADT_A61
- type ADT_A62
- type AFF
- type AIG
- type AIL
- type AIP
- type AIS
- type AL1
- type APR
- type ARQ
- type ARV
- type AUI
- type AUT
- type BAR_P01
- type BAR_P01_Insurance
- type BAR_P01_Procedure
- type BAR_P01_Visit
- type BAR_P02
- type BAR_P02_Patient
- type BAR_P05
- type BAR_P05_Insurance
- type BAR_P05_Procedure
- type BAR_P05_Visit
- type BAR_P06
- type BAR_P06_Patient
- type BAR_P10
- type BAR_P10_Procedure
- type BAR_P12
- type BAR_P12_Procedure
- type BHS
- type BLC
- type BLG
- type BPO
- type BPS_O29
- type BPS_O29_Order
- type BPS_O29_Patient
- type BPS_O29_PatientVisit
- type BPS_O29_Product
- type BPS_O29_Timing
- type BPX
- type BRP_O30
- type BRP_O30_Order
- type BRP_O30_Patient
- type BRP_O30_Response
- type BRP_O30_Timing
- type BRT_O32
- type BRT_O32_Order
- type BRT_O32_Response
- type BRT_O32_Timing
- type BTS
- type BTS_O31
- type BTS_O31_Order
- type BTS_O31_Patient
- type BTS_O31_PatientVisit
- type BTS_O31_ProductStatus
- type BTS_O31_Timing
- type BTX
- type CCD
- type CDM
- type CE
- type CER
- type CM0
- type CM1
- type CM2
- type CNE
- type CNN
- type CNS
- type CP
- type CQ
- type CRM_C01
- type CRM_C01_Patient
- type CRM_C02
- type CRM_C02_Patient
- type CRM_C03
- type CRM_C03_Patient
- type CRM_C04
- type CRM_C04_Patient
- type CRM_C05
- type CRM_C05_Patient
- type CRM_C06
- type CRM_C06_Patient
- type CRM_C07
- type CRM_C07_Patient
- type CRM_C08
- type CRM_C08_Patient
- type CSP
- type CSR
- type CSS
- type CSU_C09
- type CSU_C09_Patient
- type CSU_C09_RxAdmin
- type CSU_C09_StudyObservation
- type CSU_C09_StudyPharm
- type CSU_C09_StudyPhase
- type CSU_C09_StudySchedule
- type CSU_C09_TimingQty
- type CSU_C09_Visit
- type CSU_C10
- type CSU_C10_Patient
- type CSU_C10_RxAdmin
- type CSU_C10_StudyObservation
- type CSU_C10_StudyPharm
- type CSU_C10_StudyPhase
- type CSU_C10_StudySchedule
- type CSU_C10_TimingQty
- type CSU_C10_Visit
- type CSU_C11
- type CSU_C11_Patient
- type CSU_C11_RxAdmin
- type CSU_C11_StudyObservation
- type CSU_C11_StudyPharm
- type CSU_C11_StudyPhase
- type CSU_C11_StudySchedule
- type CSU_C11_TimingQty
- type CSU_C11_Visit
- type CSU_C12
- type CSU_C12_Patient
- type CSU_C12_RxAdmin
- type CSU_C12_StudyObservation
- type CSU_C12_StudyPharm
- type CSU_C12_StudyPhase
- type CSU_C12_StudySchedule
- type CSU_C12_TimingQty
- type CSU_C12_Visit
- type CTD
- type CTI
- type CWE
- type CX
- type DB1
- type DDI
- type DFT_P03
- type DFT_P03_CommonOrder
- type DFT_P03_Financial
- type DFT_P03_FinancialCommonOrder
- type DFT_P03_FinancialObservation
- type DFT_P03_FinancialOrder
- type DFT_P03_FinancialProcedure
- type DFT_P03_FinancialTimingQuantity
- type DFT_P03_Insurance
- type DFT_P03_Observation
- type DFT_P03_Order
- type DFT_P03_TimingQuantity
- type DFT_P11
- type DFT_P11_CommonOrder
- type DFT_P11_Financial
- type DFT_P11_FinancialCommonOrder
- type DFT_P11_FinancialInsurance
- type DFT_P11_FinancialObservation
- type DFT_P11_FinancialOrder
- type DFT_P11_FinancialProcedure
- type DFT_P11_FinancialTimingQuantity
- type DFT_P11_Insurance
- type DFT_P11_Observation
- type DFT_P11_Order
- type DFT_P11_TimingQuantity
- type DG1
- type DIN
- type DLD
- type DLN
- type DLT
- type DMI
- type DOC_T12
- type DOC_T12_Result
- type DR
- type DRG
- type DSC
- type DSP
- type DSR_Q01
- type DSR_Q03
- type DT
- type DTM
- type DTN
- type EAC_U07
- type EAC_U07_Command
- type EAC_U07_SpecimenContainer
- type EAN_U09
- type EAN_U09_Notification
- type EAR_U08
- type EAR_U08_CommandResponse
- type EAR_U08_SpecimenContainer
- type ECD
- type ECR
- type ED
- type EDR_R07
- type EDU
- type EHC_E01
- type EHC_E01_Diagnosis
- type EHC_E01_Insurance
- type EHC_E01_InvoiceInformation
- type EHC_E01_InvoiceProcessing
- type EHC_E01_PatientInfo
- type EHC_E01_Procedure
- type EHC_E01_ProductServiceGroup
- type EHC_E01_ProductServiceLineItem
- type EHC_E01_ProductServiceSection
- type EHC_E02
- type EHC_E02_InvoiceInformation
- type EHC_E02_ProductServiceSection
- type EHC_E02_Psg
- type EHC_E04
- type EHC_E04_ProductServiceGroup
- type EHC_E04_ProductServiceSection
- type EHC_E04_ReassessmentRequestInfo
- type EHC_E10
- type EHC_E10_InvoiceProcessingResultsInfo
- type EHC_E10_ProductServiceGroup
- type EHC_E10_ProductServiceLineInfo
- type EHC_E10_ProductServiceSection
- type EHC_E12
- type EHC_E12_Request
- type EHC_E13
- type EHC_E13_Request
- type EHC_E13_Response
- type EHC_E15
- type EHC_E15_AdjustmentPayee
- type EHC_E15_PaymentRemittanceDetailInfo
- type EHC_E15_PaymentRemittanceHeaderInfo
- type EHC_E15_ProductServiceGroup
- type EHC_E15_ProductServiceSection
- type EHC_E15_PslItemInfo
- type EHC_E20
- type EHC_E20_AuthorizationRequest
- type EHC_E20_Diagnosis
- type EHC_E20_Insurance
- type EHC_E20_PatInfo
- type EHC_E20_PslItemInfo
- type EHC_E21
- type EHC_E21_AuthorizationRequest
- type EHC_E21_PslItemInfo
- type EHC_E24
- type EHC_E24_AuthorizationResponseInfo
- type EHC_E24_PayerAdjustment
- type EHC_E24_PslItemInfo
- type EI
- type EIP
- type ELD
- type EQL
- type EQP
- type EQQ_Q04
- type EQU
- type ERL
- type ERP_R09
- type ERQ
- type ERR
- type ESR_U02
- type ESU_U01
- type EVN
- type FAC
- type FC
- type FHS
- type FN
- type FT
- type FT1
- type FTS
- type GOL
- type GP1
- type GP2
- type GT1
- type GTS
- type HD
- type HL7Name
- type IAM
- type ICD
- type ID
- type IIM
- type ILT
- type IN1
- type IN2
- type IN3
- type INR_U06
- type INU_U05
- type INV
- type IPC
- type IPR
- type IS
- type ISD
- type ITM
- type IVC
- type IVT
- type JCC
- type LA1
- type LA2
- type LAN
- type LCC
- type LCH
- type LDP
- type LOC
- type LRL
- type LSR_U13
- type LSU_U12
- type MDM_T01
- type MDM_T01_CommonOrder
- type MDM_T01_Timing
- type MDM_T02
- type MDM_T02_CommonOrder
- type MDM_T02_Obxnte
- type MDM_T02_Timing
- type MDM_T03
- type MDM_T03_CommonOrder
- type MDM_T03_Timing
- type MDM_T04
- type MDM_T04_CommonOrder
- type MDM_T04_Obxnte
- type MDM_T04_Timing
- type MDM_T05
- type MDM_T05_CommonOrder
- type MDM_T05_Timing
- type MDM_T06
- type MDM_T06_CommonOrder
- type MDM_T06_Obxnte
- type MDM_T06_Timing
- type MDM_T07
- type MDM_T07_CommonOrder
- type MDM_T07_Timing
- type MDM_T08
- type MDM_T08_CommonOrder
- type MDM_T08_Obxnte
- type MDM_T08_Timing
- type MDM_T09
- type MDM_T09_CommonOrder
- type MDM_T09_Timing
- type MDM_T10
- type MDM_T10_CommonOrder
- type MDM_T10_Obxnte
- type MDM_T10_Timing
- type MDM_T11
- type MDM_T11_CommonOrder
- type MDM_T11_Timing
- type MFA
- type MFE
- type MFI
- type MFK_M01
- type MFK_M02
- type MFK_M03
- type MFK_M04
- type MFK_M05
- type MFK_M06
- type MFK_M07
- type MFK_M08
- type MFK_M09
- type MFK_M10
- type MFK_M11
- type MFK_M12
- type MFK_M13
- type MFK_M14
- type MFK_M15
- type MFK_M16
- type MFK_M17
- type MFN_M01
- type MFN_M01_Mf
- type MFN_M02
- type MFN_M02_MfStaff
- type MFN_M03
- type MFN_M03_MfTest
- type MFN_M04
- type MFN_M04_MfCdm
- type MFN_M05
- type MFN_M05_MfLocDept
- type MFN_M05_MfLocation
- type MFN_M06
- type MFN_M06_MfClinStudy
- type MFN_M06_MfPhaseSchedDetail
- type MFN_M07
- type MFN_M07_MfClinStudySched
- type MFN_M08
- type MFN_M08_MfTestNumeric
- type MFN_M09
- type MFN_M09_MfTestCatDetail
- type MFN_M09_MfTestCategorical
- type MFN_M10
- type MFN_M10_MfTestBattDetail
- type MFN_M10_MfTestBatteries
- type MFN_M11
- type MFN_M11_MfTestCalcDetail
- type MFN_M11_MfTestCalculated
- type MFN_M12
- type MFN_M12_MfObsAttributes
- type MFN_M13
- type MFN_M14
- type MFN_M14_MfSiteDefined
- type MFN_M15
- type MFN_M15_MfInvItem
- type MFN_M16
- type MFN_M16_MaterialItemRecord
- type MFN_M16_MaterialLocation
- type MFN_M16_Packaging
- type MFN_M16_PurchasingVendor
- type MFN_M16_Sterilization
- type MFN_M17
- type MFN_M17_MfDrg
- type MFQ_M01
- type MFR_M01
- type MFR_M01_MfQuery
- type MFR_M04
- type MFR_M04_MfQuery
- type MFR_M05
- type MFR_M05_MfLocation
- type MFR_M05_MfQuery
- type MFR_M06
- type MFR_M06_MfClinicalStudy
- type MFR_M06_MfQuery
- type MFR_M07
- type MFR_M07_MfQuery
- type MO
- type MOC
- type MOP
- type MRG
- type MSA
- type MSG
- type MSH
- type NA
- type NCK
- type NDL
- type NDS
- type NK1
- type NM
- type NMD_N02
- type NMD_N02_AppStats
- type NMD_N02_AppStatus
- type NMD_N02_Clock
- type NMD_N02_ClockAndStatsWithNotes
- type NMQ_N01
- type NMQ_N01_ClockAndStatistics
- type NMQ_N01_QryWithDetail
- type NMR_N01
- type NMR_N01_ClockAndStatsWithNotesAlt
- type NPU
- type NR
- type NSC
- type NST
- type NTE
- type OBR
- type OBX
- type OCD
- type ODS
- type ODT
- type OM1
- type OM2
- type OM3
- type OM4
- type OM5
- type OM6
- type OM7
- type OMB_O27
- type OMB_O27_Insurance
- type OMB_O27_Observation
- type OMB_O27_Order
- type OMB_O27_Patient
- type OMB_O27_PatientVisit
- type OMB_O27_Timing
- type OMD_O03
- type OMD_O03_Diet
- type OMD_O03_Insurance
- type OMD_O03_Observation
- type OMD_O03_OrderDiet
- type OMD_O03_OrderTray
- type OMD_O03_Patient
- type OMD_O03_PatientVisit
- type OMD_O03_TimingDiet
- type OMD_O03_TimingTray
- type OMG_O19
- type OMG_O19_Container
- type OMG_O19_Insurance
- type OMG_O19_Observation
- type OMG_O19_ObservationPrior
- type OMG_O19_Order
- type OMG_O19_OrderPrior
- type OMG_O19_Patient
- type OMG_O19_PatientPrior
- type OMG_O19_PatientVisit
- type OMG_O19_PatientVisitPrior
- type OMG_O19_PriorResult
- type OMG_O19_Specimen
- type OMG_O19_Timing
- type OMG_O19_TimingPrior
- type OMI_O23
- type OMI_O23_Insurance
- type OMI_O23_Observation
- type OMI_O23_Order
- type OMI_O23_Patient
- type OMI_O23_PatientVisit
- type OMI_O23_Timing
- type OML_O21
- type OML_O21_Container
- type OML_O21_Insurance
- type OML_O21_Observation
- type OML_O21_ObservationPrior
- type OML_O21_ObservationRequest
- type OML_O21_Order
- type OML_O21_OrderPrior
- type OML_O21_Patient
- type OML_O21_PatientPrior
- type OML_O21_PatientVisit
- type OML_O21_PatientVisitPrior
- type OML_O21_PriorResult
- type OML_O21_Specimen
- type OML_O21_Timing
- type OML_O21_TimingPrior
- type OML_O33
- type OML_O33_Insurance
- type OML_O33_Observation
- type OML_O33_ObservationPrior
- type OML_O33_ObservationRequest
- type OML_O33_Order
- type OML_O33_OrderPrior
- type OML_O33_Patient
- type OML_O33_PatientPrior
- type OML_O33_PatientVisit
- type OML_O33_PatientVisitPrior
- type OML_O33_PriorResult
- type OML_O33_Specimen
- type OML_O33_Timing
- type OML_O33_TimingPrior
- type OML_O35
- type OML_O35_Insurance
- type OML_O35_Observation
- type OML_O35_ObservationPrior
- type OML_O35_ObservationRequest
- type OML_O35_Order
- type OML_O35_OrderPrior
- type OML_O35_Patient
- type OML_O35_PatientPrior
- type OML_O35_PatientVisit
- type OML_O35_PatientVisitPrior
- type OML_O35_PriorResult
- type OML_O35_Specimen
- type OML_O35_SpecimenContainer
- type OML_O35_Timing
- type OML_O35_TimingPrior
- type OMN_O07
- type OMN_O07_Insurance
- type OMN_O07_Observation
- type OMN_O07_Order
- type OMN_O07_Patient
- type OMN_O07_PatientVisit
- type OMN_O07_Timing
- type OMP_O09
- type OMP_O09_Component
- type OMP_O09_Insurance
- type OMP_O09_Observation
- type OMP_O09_Order
- type OMP_O09_Patient
- type OMP_O09_PatientVisit
- type OMP_O09_Timing
- type OMS_O05
- type OMS_O05_Insurance
- type OMS_O05_Observation
- type OMS_O05_Order
- type OMS_O05_Patient
- type OMS_O05_PatientVisit
- type OMS_O05_Timing
- type OPL_O37
- type OPL_O37_Container
- type OPL_O37_Guarantor
- type OPL_O37_Insurance
- type OPL_O37_ObservationRequest
- type OPL_O37_Order
- type OPL_O37_OrderPrior
- type OPL_O37_Patient
- type OPL_O37_PatientPrior
- type OPL_O37_PatientVisitPrior
- type OPL_O37_PriorResult
- type OPL_O37_Specimen
- type OPL_O37_Timing
- type OPL_O37_Timing2
- type OPR_O38
- type OPR_O38_ObservationRequest
- type OPR_O38_Order
- type OPR_O38_Response
- type OPR_O38_Specimen
- type OPR_O38_Timing
- type OPU_R25
- type OPU_R25_AccessionDetail
- type OPU_R25_Container
- type OPU_R25_Order
- type OPU_R25_Patient
- type OPU_R25_PatientObservation
- type OPU_R25_Result
- type OPU_R25_Specimen
- type OPU_R25_SpecimenObservation
- type OPU_R25_TimingQty
- type ORB_O28
- type ORB_O28_Order
- type ORB_O28_Patient
- type ORB_O28_Response
- type ORB_O28_Timing
- type ORC
- type ORD_O04
- type ORD_O04_OrderDiet
- type ORD_O04_OrderTray
- type ORD_O04_Patient
- type ORD_O04_Response
- type ORD_O04_TimingDiet
- type ORD_O04_TimingTray
- type ORF_R04
- type ORF_R04_Observation
- type ORF_R04_Order
- type ORF_R04_Patient
- type ORF_R04_QueryResponse
- type ORF_R04_TimingQty
- type ORF_W02
- type ORF_W02_Observation
- type ORF_W02_Order
- type ORF_W02_Patient
- type ORF_W02_QueryResponse
- type ORF_W02_TimingQty
- type ORG
- type ORG_O20
- type ORG_O20_ObservationGroup
- type ORG_O20_Order
- type ORG_O20_Patient
- type ORG_O20_Response
- type ORG_O20_Specimen
- type ORG_O20_Timing
- type ORI_O24
- type ORI_O24_Order
- type ORI_O24_Patient
- type ORI_O24_Response
- type ORI_O24_Timing
- type ORL_O22
- type ORL_O22_ObservationRequest
- type ORL_O22_Order
- type ORL_O22_Response
- type ORL_O22_Specimen
- type ORL_O22_Timing
- type ORL_O34
- type ORL_O34_ObservationRequest
- type ORL_O34_Order
- type ORL_O34_Response
- type ORL_O34_Specimen
- type ORL_O34_Timing
- type ORL_O36
- type ORL_O36_ObservationRequest
- type ORL_O36_Order
- type ORL_O36_Response
- type ORL_O36_Specimen
- type ORL_O36_SpecimenContainer
- type ORL_O36_Timing
- type ORM_O01
- type ORM_O01_Insurance
- type ORM_O01_Observation
- type ORM_O01_Order
- type ORM_O01_OrderDetail
- type ORM_O01_OrderDetailSegment
- type ORM_O01_Patient
- type ORM_O01_PatientVisit
- type ORN_O08
- type ORN_O08_Order
- type ORN_O08_Patient
- type ORN_O08_Response
- type ORN_O08_Timing
- type ORP_O10
- type ORP_O10_Component
- type ORP_O10_Order
- type ORP_O10_OrderDetail
- type ORP_O10_Patient
- type ORP_O10_Response
- type ORP_O10_Timing
- type ORR_O02
- type ORR_O02_Order
- type ORR_O02_OrderDetailSegment
- type ORR_O02_Patient
- type ORR_O02_Response
- type ORS_O06
- type ORS_O06_Order
- type ORS_O06_Patient
- type ORS_O06_Response
- type ORS_O06_Timing
- type ORU_R01
- type ORU_R01_Observation
- type ORU_R01_OrderObservation
- type ORU_R01_Patient
- type ORU_R01_PatientResult
- type ORU_R01_Specimen
- type ORU_R01_TimingQty
- type ORU_R01_Visit
- type ORU_R30
- type ORU_R30_Observation
- type ORU_R30_TimingQty
- type ORU_R30_Visit
- type ORU_R31
- type ORU_R31_Observation
- type ORU_R31_TimingQty
- type ORU_R31_Visit
- type ORU_R32
- type ORU_R32_Observation
- type ORU_R32_TimingQty
- type ORU_R32_Visit
- type ORU_W01
- type ORU_W01_Observation
- type ORU_W01_OrderObservation
- type ORU_W01_Patient
- type ORU_W01_PatientResult
- type ORU_W01_Specimen
- type ORU_W01_TimingQty
- type ORU_W01_Visit
- type OSD
- type OSP
- type OSQ_Q06
- type OSR_Q06
- type OSR_Q06_Order
- type OSR_Q06_OrderDetailSegment
- type OSR_Q06_Patient
- type OSR_Q06_Response
- type OSR_Q06_Timing
- type OUL_R21
- type OUL_R21_Container
- type OUL_R21_Observation
- type OUL_R21_OrderObservation
- type OUL_R21_Patient
- type OUL_R21_TimingQty
- type OUL_R21_Visit
- type OUL_R22
- type OUL_R22_Container
- type OUL_R22_Order
- type OUL_R22_Patient
- type OUL_R22_Result
- type OUL_R22_Specimen
- type OUL_R22_TimingQty
- type OUL_R22_Visit
- type OUL_R23
- type OUL_R23_Container
- type OUL_R23_Order
- type OUL_R23_Patient
- type OUL_R23_Result
- type OUL_R23_Specimen
- type OUL_R23_TimingQty
- type OUL_R23_Visit
- type OUL_R24
- type OUL_R24_Container
- type OUL_R24_Order
- type OUL_R24_Patient
- type OUL_R24_Result
- type OUL_R24_Specimen
- type OUL_R24_TimingQty
- type OUL_R24_Visit
- type OVR
- type PCE
- type PCR
- type PD1
- type PDA
- type PDC
- type PEO
- type PES
- type PEX_P07
- type PEX_P07_AssociatedPerson
- type PEX_P07_AssociatedRxAdmin
- type PEX_P07_AssociatedRxOrder
- type PEX_P07_Experience
- type PEX_P07_Nk1TimingQty
- type PEX_P07_PexCause
- type PEX_P07_PexObservation
- type PEX_P07_RxAdministration
- type PEX_P07_RxOrder
- type PEX_P07_Study
- type PEX_P07_TimingQty
- type PEX_P07_Visit
- type PEX_P08
- type PEX_P08_AssociatedPerson
- type PEX_P08_AssociatedRxAdmin
- type PEX_P08_AssociatedRxOrder
- type PEX_P08_Experience
- type PEX_P08_Nk1TimingQty
- type PEX_P08_PexCause
- type PEX_P08_PexObservation
- type PEX_P08_RxAdministration
- type PEX_P08_RxOrder
- type PEX_P08_Study
- type PEX_P08_TimingQty
- type PEX_P08_Visit
- type PGL_PC6
- type PGL_PC6_Goal
- type PGL_PC6_GoalRole
- type PGL_PC6_Observation
- type PGL_PC6_Order
- type PGL_PC6_OrderDetail
- type PGL_PC6_OrderDetailSegment
- type PGL_PC6_OrderObservation
- type PGL_PC6_Pathway
- type PGL_PC6_PatientVisit
- type PGL_PC6_Problem
- type PGL_PC6_ProblemObservation
- type PGL_PC6_ProblemRole
- type PGL_PC7
- type PGL_PC7_Goal
- type PGL_PC7_GoalRole
- type PGL_PC7_Observation
- type PGL_PC7_Order
- type PGL_PC7_OrderDetail
- type PGL_PC7_OrderDetailSegment
- type PGL_PC7_OrderObservation
- type PGL_PC7_Pathway
- type PGL_PC7_PatientVisit
- type PGL_PC7_Problem
- type PGL_PC7_ProblemObservation
- type PGL_PC7_ProblemRole
- type PGL_PC8
- type PGL_PC8_Goal
- type PGL_PC8_GoalRole
- type PGL_PC8_Observation
- type PGL_PC8_Order
- type PGL_PC8_OrderDetail
- type PGL_PC8_OrderDetailSegment
- type PGL_PC8_OrderObservation
- type PGL_PC8_Pathway
- type PGL_PC8_PatientVisit
- type PGL_PC8_Problem
- type PGL_PC8_ProblemObservation
- type PGL_PC8_ProblemRole
- type PID
- type PIN_I07
- type PIN_I07_GuarantorInsurance
- type PIN_I07_Insurance
- type PIN_I07_Provider
- type PIP
- type PKG
- type PL
- type PLN
- type PMT
- type PMU_B01
- type PMU_B02
- type PMU_B03
- type PMU_B04
- type PMU_B05
- type PMU_B06
- type PMU_B07
- type PMU_B07_Certificate
- type PMU_B08
- type PPG_PCG
- type PPG_PCG_Goal
- type PPG_PCG_GoalObservation
- type PPG_PCG_GoalRole
- type PPG_PCG_Order
- type PPG_PCG_OrderDetail
- type PPG_PCG_OrderDetailSegment
- type PPG_PCG_OrderObservation
- type PPG_PCG_Pathway
- type PPG_PCG_PathwayRole
- type PPG_PCG_PatientVisit
- type PPG_PCG_Problem
- type PPG_PCG_ProblemObservation
- type PPG_PCG_ProblemRole
- type PPG_PCH
- type PPG_PCH_Goal
- type PPG_PCH_GoalObservation
- type PPG_PCH_GoalRole
- type PPG_PCH_Order
- type PPG_PCH_OrderDetail
- type PPG_PCH_OrderDetailSegment
- type PPG_PCH_OrderObservation
- type PPG_PCH_Pathway
- type PPG_PCH_PathwayRole
- type PPG_PCH_PatientVisit
- type PPG_PCH_Problem
- type PPG_PCH_ProblemObservation
- type PPG_PCH_ProblemRole
- type PPG_PCJ
- type PPG_PCJ_Goal
- type PPG_PCJ_GoalObservation
- type PPG_PCJ_GoalRole
- type PPG_PCJ_Order
- type PPG_PCJ_OrderDetail
- type PPG_PCJ_OrderDetailSegment
- type PPG_PCJ_OrderObservation
- type PPG_PCJ_Pathway
- type PPG_PCJ_PathwayRole
- type PPG_PCJ_PatientVisit
- type PPG_PCJ_Problem
- type PPG_PCJ_ProblemObservation
- type PPG_PCJ_ProblemRole
- type PPN
- type PPP_PCB
- type PPP_PCB_Goal
- type PPP_PCB_GoalObservation
- type PPP_PCB_GoalRole
- type PPP_PCB_Order
- type PPP_PCB_OrderDetail
- type PPP_PCB_OrderDetailSegment
- type PPP_PCB_OrderObservation
- type PPP_PCB_Pathway
- type PPP_PCB_PathwayRole
- type PPP_PCB_PatientVisit
- type PPP_PCB_Problem
- type PPP_PCB_ProblemObservation
- type PPP_PCB_ProblemRole
- type PPP_PCC
- type PPP_PCC_Goal
- type PPP_PCC_GoalObservation
- type PPP_PCC_GoalRole
- type PPP_PCC_Order
- type PPP_PCC_OrderDetail
- type PPP_PCC_OrderDetailSegment
- type PPP_PCC_OrderObservation
- type PPP_PCC_Pathway
- type PPP_PCC_PathwayRole
- type PPP_PCC_PatientVisit
- type PPP_PCC_Problem
- type PPP_PCC_ProblemObservation
- type PPP_PCC_ProblemRole
- type PPP_PCD
- type PPP_PCD_Goal
- type PPP_PCD_GoalObservation
- type PPP_PCD_GoalRole
- type PPP_PCD_Order
- type PPP_PCD_OrderDetail
- type PPP_PCD_OrderDetailSegment
- type PPP_PCD_OrderObservation
- type PPP_PCD_Pathway
- type PPP_PCD_PathwayRole
- type PPP_PCD_PatientVisit
- type PPP_PCD_Problem
- type PPP_PCD_ProblemObservation
- type PPP_PCD_ProblemRole
- type PPR_PC1
- type PPR_PC1_Goal
- type PPR_PC1_GoalObservation
- type PPR_PC1_GoalRole
- type PPR_PC1_Order
- type PPR_PC1_OrderDetail
- type PPR_PC1_OrderDetailSegment
- type PPR_PC1_OrderObservation
- type PPR_PC1_Pathway
- type PPR_PC1_PatientVisit
- type PPR_PC1_Problem
- type PPR_PC1_ProblemObservation
- type PPR_PC1_ProblemRole
- type PPR_PC2
- type PPR_PC2_Goal
- type PPR_PC2_GoalObservation
- type PPR_PC2_GoalRole
- type PPR_PC2_Order
- type PPR_PC2_OrderDetail
- type PPR_PC2_OrderDetailSegment
- type PPR_PC2_OrderObservation
- type PPR_PC2_Pathway
- type PPR_PC2_PatientVisit
- type PPR_PC2_Problem
- type PPR_PC2_ProblemObservation
- type PPR_PC2_ProblemRole
- type PPR_PC3
- type PPR_PC3_Goal
- type PPR_PC3_GoalObservation
- type PPR_PC3_GoalRole
- type PPR_PC3_Order
- type PPR_PC3_OrderDetail
- type PPR_PC3_OrderDetailSegment
- type PPR_PC3_OrderObservation
- type PPR_PC3_Pathway
- type PPR_PC3_PatientVisit
- type PPR_PC3_Problem
- type PPR_PC3_ProblemObservation
- type PPR_PC3_ProblemRole
- type PPT_PCL
- type PPT_PCL_Goal
- type PPT_PCL_GoalObservation
- type PPT_PCL_GoalRole
- type PPT_PCL_Order
- type PPT_PCL_OrderDetail
- type PPT_PCL_OrderDetailSegment
- type PPT_PCL_OrderObservation
- type PPT_PCL_Pathway
- type PPT_PCL_PathwayRole
- type PPT_PCL_Patient
- type PPT_PCL_PatientVisit
- type PPT_PCL_Problem
- type PPT_PCL_ProblemObservation
- type PPT_PCL_ProblemRole
- type PPV_PCA
- type PPV_PCA_Goal
- type PPV_PCA_GoalObservation
- type PPV_PCA_GoalPathway
- type PPV_PCA_GoalRole
- type PPV_PCA_Order
- type PPV_PCA_OrderDetail
- type PPV_PCA_OrderDetailSegment
- type PPV_PCA_OrderObservation
- type PPV_PCA_Patient
- type PPV_PCA_PatientVisit
- type PPV_PCA_Problem
- type PPV_PCA_ProblemObservation
- type PPV_PCA_ProblemRole
- type PR1
- type PRA
- type PRB
- type PRC
- type PRD
- type PRL
- type PRR_PC5
- type PRR_PC5_Goal
- type PRR_PC5_GoalObservation
- type PRR_PC5_GoalRole
- type PRR_PC5_Order
- type PRR_PC5_OrderDetail
- type PRR_PC5_OrderDetailSegment
- type PRR_PC5_OrderObservation
- type PRR_PC5_Patient
- type PRR_PC5_PatientVisit
- type PRR_PC5_Problem
- type PRR_PC5_ProblemObservation
- type PRR_PC5_ProblemPathway
- type PRR_PC5_ProblemRole
- type PSG
- type PSH
- type PSL
- type PSS
- type PT
- type PTA
- type PTH
- type PTR_PCF
- type PTR_PCF_Goal
- type PTR_PCF_GoalObservation
- type PTR_PCF_GoalRole
- type PTR_PCF_Order
- type PTR_PCF_OrderDetail
- type PTR_PCF_OrderDetailSegment
- type PTR_PCF_OrderObservation
- type PTR_PCF_Pathway
- type PTR_PCF_PathwayRole
- type PTR_PCF_Patient
- type PTR_PCF_PatientVisit
- type PTR_PCF_Problem
- type PTR_PCF_ProblemObservation
- type PTR_PCF_ProblemRole
- type PV1
- type PV2
- type PYE
- type QAK
- type QBP_E03
- type QBP_E03_QueryInformation
- type QBP_E22
- type QBP_E22_Query
- type QBP_K13
- type QBP_K13_RowDefinition
- type QBP_Q11
- type QBP_Q13
- type QBP_Q15
- type QBP_Q21
- type QBP_Q22
- type QBP_Q23
- type QBP_Q24
- type QBP_Q25
- type QBP_Q31
- type QBP_Z73
- type QBP_Z75
- type QBP_Z79
- type QBP_Z81
- type QBP_Z85
- type QBP_Z87
- type QBP_Z89
- type QBP_Z91
- type QBP_Z93
- type QBP_Z95
- type QBP_Z97
- type QBP_Z99
- type QCK_Q02
- type QCN_J01
- type QID
- type QIP
- type QPD
- type QRD
- type QRF
- type QRI
- type QRY_A19
- type QRY_PC4
- type QRY_PC9
- type QRY_PCE
- type QRY_PCK
- type QRY_Q01
- type QRY_Q02
- type QRY_Q26
- type QRY_Q27
- type QRY_Q28
- type QRY_Q29
- type QRY_Q30
- type QRY_R02
- type QRY_T12
- type QSB_Q16
- type QSB_Z83
- type QSC
- type QSX_J02
- type QVR_Q17
- type RAR_RAR
- type RAR_RAR_Definition
- type RAR_RAR_Encoding
- type RAR_RAR_Order
- type RAR_RAR_Patient
- type RAS_O17
- type RAS_O17_Administration
- type RAS_O17_Components
- type RAS_O17_Encoding
- type RAS_O17_Observation
- type RAS_O17_Order
- type RAS_O17_OrderDetail
- type RAS_O17_OrderDetailSupplement
- type RAS_O17_Patient
- type RAS_O17_PatientVisit
- type RAS_O17_Timing
- type RAS_O17_TimingEncoded
- type RCD
- type RCI_I05
- type RCI_I05_Observation
- type RCI_I05_Provider
- type RCI_I05_Results
- type RCL_I06
- type RCL_I06_Provider
- type RCP
- type RDE_O11
- type RDE_O11_Component
- type RDE_O11_Insurance
- type RDE_O11_Observation
- type RDE_O11_Order
- type RDE_O11_OrderDetail
- type RDE_O11_Patient
- type RDE_O11_PatientVisit
- type RDE_O11_Timing
- type RDE_O11_TimingEncoded
- type RDE_O25
- type RDE_O25_Components
- type RDE_O25_Insurance
- type RDE_O25_Observation
- type RDE_O25_Order
- type RDE_O25_OrderDetail
- type RDE_O25_Patient
- type RDE_O25_PatientVisit
- type RDE_O25_Timing
- type RDE_O25_TimingEncoded
- type RDF
- type RDR_RDR
- type RDR_RDR_Definition
- type RDR_RDR_Dispense
- type RDR_RDR_Encoding
- type RDR_RDR_Order
- type RDR_RDR_Patient
- type RDS_O13
- type RDS_O13_Component
- type RDS_O13_Encoding
- type RDS_O13_Observation
- type RDS_O13_Order
- type RDS_O13_OrderDetail
- type RDS_O13_OrderDetailSupplement
- type RDS_O13_Patient
- type RDS_O13_PatientVisit
- type RDS_O13_Timing
- type RDS_O13_TimingEncoded
- type RDT
- type RDY_K15
- type RDY_Z80
- type RDY_Z98
- type REF_I12
- type REF_I12_AuthorizationContact
- type REF_I12_AuthorizationContact2
- type REF_I12_Insurance
- type REF_I12_Observation
- type REF_I12_PatientVisit
- type REF_I12_Procedure
- type REF_I12_ProviderContact
- type REF_I12_ResultsNotes
- type REF_I13
- type REF_I13_AuthorizationContact
- type REF_I13_AuthorizationContact2
- type REF_I13_Insurance
- type REF_I13_Observation
- type REF_I13_PatientVisit
- type REF_I13_Procedure
- type REF_I13_ProviderContact
- type REF_I13_ResultsNotes
- type REF_I14
- type REF_I14_AuthorizationContact
- type REF_I14_AuthorizationContact2
- type REF_I14_Insurance
- type REF_I14_Observation
- type REF_I14_PatientVisit
- type REF_I14_Procedure
- type REF_I14_ProviderContact
- type REF_I14_ResultsNotes
- type REF_I15
- type REF_I15_AuthorizationContact
- type REF_I15_AuthorizationContact2
- type REF_I15_Insurance
- type REF_I15_Observation
- type REF_I15_PatientVisit
- type REF_I15_Procedure
- type REF_I15_ProviderContact
- type REF_I15_ResultsNotes
- type RER_RER
- type RER_RER_Definition
- type RER_RER_Order
- type RER_RER_Patient
- type RF1
- type RFI
- type RFR
- type RGR_RGR
- type RGR_RGR_Definition
- type RGR_RGR_Encoding
- type RGR_RGR_Order
- type RGR_RGR_Patient
- type RGS
- type RGV_O15
- type RGV_O15_Components
- type RGV_O15_Encoding
- type RGV_O15_Give
- type RGV_O15_Observation
- type RGV_O15_Order
- type RGV_O15_OrderDetail
- type RGV_O15_OrderDetailSupplement
- type RGV_O15_Patient
- type RGV_O15_PatientVisit
- type RGV_O15_Timing
- type RGV_O15_TimingEncoded
- type RGV_O15_TimingGive
- type RI
- type RMC
- type RMI
- type ROL
- type ROR_ROR
- type ROR_ROR_Definition
- type ROR_ROR_Order
- type ROR_ROR_Patient
- type RPA_I08
- type RPA_I08_Authorization1
- type RPA_I08_Authorization2
- type RPA_I08_Insurance
- type RPA_I08_Observation
- type RPA_I08_Procedure
- type RPA_I08_Provider
- type RPA_I08_Results
- type RPA_I08_Visit
- type RPA_I09
- type RPA_I09_Authorization1
- type RPA_I09_Authorization2
- type RPA_I09_Insurance
- type RPA_I09_Observation
- type RPA_I09_Procedure
- type RPA_I09_Provider
- type RPA_I09_Results
- type RPA_I09_Visit
- type RPA_I10
- type RPA_I10_Authorization1
- type RPA_I10_Authorization2
- type RPA_I10_Insurance
- type RPA_I10_Observation
- type RPA_I10_Procedure
- type RPA_I10_Provider
- type RPA_I10_Results
- type RPA_I10_Visit
- type RPA_I11
- type RPA_I11_Authorization1
- type RPA_I11_Authorization2
- type RPA_I11_Insurance
- type RPA_I11_Observation
- type RPA_I11_Procedure
- type RPA_I11_Provider
- type RPA_I11_Results
- type RPA_I11_Visit
- type RPI_I01
- type RPI_I01_GuarantorInsurance
- type RPI_I01_Insurance
- type RPI_I01_Provider
- type RPI_I04
- type RPI_I04_GuarantorInsurance
- type RPI_I04_Insurance
- type RPI_I04_Provider
- type RPL_I02
- type RPL_I02_Provider
- type RPR_I03
- type RPR_I03_Provider
- type RPT
- type RQ1
- type RQA_I08
- type RQA_I08_Authorization
- type RQA_I08_Authorization2
- type RQA_I08_GuarantorInsurance
- type RQA_I08_Insurance
- type RQA_I08_Observation
- type RQA_I08_Procedure
- type RQA_I08_Provider
- type RQA_I08_Results
- type RQA_I08_Visit
- type RQA_I09
- type RQA_I09_Authorization
- type RQA_I09_Authorization2
- type RQA_I09_GuarantorInsurance
- type RQA_I09_Insurance
- type RQA_I09_Observation
- type RQA_I09_Procedure
- type RQA_I09_Provider
- type RQA_I09_Results
- type RQA_I09_Visit
- type RQA_I10
- type RQA_I10_Authorization
- type RQA_I10_Authorization2
- type RQA_I10_GuarantorInsurance
- type RQA_I10_Insurance
- type RQA_I10_Observation
- type RQA_I10_Procedure
- type RQA_I10_Provider
- type RQA_I10_Results
- type RQA_I10_Visit
- type RQA_I11
- type RQA_I11_Authorization
- type RQA_I11_Authorization2
- type RQA_I11_GuarantorInsurance
- type RQA_I11_Insurance
- type RQA_I11_Observation
- type RQA_I11_Procedure
- type RQA_I11_Provider
- type RQA_I11_Results
- type RQA_I11_Visit
- type RQC_I05
- type RQC_I05_Provider
- type RQC_I06
- type RQC_I06_Provider
- type RQD
- type RQI_I01
- type RQI_I01_GuarantorInsurance
- type RQI_I01_Insurance
- type RQI_I01_Provider
- type RQI_I02
- type RQI_I02_GuarantorInsurance
- type RQI_I02_Insurance
- type RQI_I02_Provider
- type RQI_I03
- type RQI_I03_GuarantorInsurance
- type RQI_I03_Insurance
- type RQI_I03_Provider
- type RQP_I04
- type RQP_I04_Provider
- type RQQ_Q09
- type RRA_O18
- type RRA_O18_Administration
- type RRA_O18_Order
- type RRA_O18_Patient
- type RRA_O18_Response
- type RRA_O18_Timing
- type RRD_O14
- type RRD_O14_Dispense
- type RRD_O14_Order
- type RRD_O14_Patient
- type RRD_O14_Response
- type RRD_O14_Timing
- type RRE_O12
- type RRE_O12_Encoding
- type RRE_O12_Order
- type RRE_O12_Patient
- type RRE_O12_Response
- type RRE_O12_Timing
- type RRE_O12_TimingEncoded
- type RRE_O26
- type RRE_O26_Encoding
- type RRE_O26_Order
- type RRE_O26_Patient
- type RRE_O26_Response
- type RRE_O26_Timing
- type RRE_O26_TimingEncoded
- type RRG_O16
- type RRG_O16_Give
- type RRG_O16_Order
- type RRG_O16_Patient
- type RRG_O16_Response
- type RRG_O16_Timing
- type RRG_O16_TimingGive
- type RRI_I12
- type RRI_I12_AuthorizationContact
- type RRI_I12_AuthorizationContact2
- type RRI_I12_Observation
- type RRI_I12_PatientVisit
- type RRI_I12_Procedure
- type RRI_I12_ProviderContact
- type RRI_I12_ResultsNotes
- type RRI_I13
- type RRI_I13_AuthorizationContact
- type RRI_I13_AuthorizationContact2
- type RRI_I13_Observation
- type RRI_I13_PatientVisit
- type RRI_I13_Procedure
- type RRI_I13_ProviderContact
- type RRI_I13_ResultsNotes
- type RRI_I14
- type RRI_I14_AuthorizationContact
- type RRI_I14_AuthorizationContact2
- type RRI_I14_Observation
- type RRI_I14_PatientVisit
- type RRI_I14_Procedure
- type RRI_I14_ProviderContact
- type RRI_I14_ResultsNotes
- type RRI_I15
- type RRI_I15_AuthorizationContact
- type RRI_I15_AuthorizationContact2
- type RRI_I15_Observation
- type RRI_I15_PatientVisit
- type RRI_I15_Procedure
- type RRI_I15_ProviderContact
- type RRI_I15_ResultsNotes
- type RSP_E03
- type RSP_E03_InvoiceProcessingResultsInfo
- type RSP_E03_QueryAck
- type RSP_E22
- type RSP_E22_AuthorizationInfo
- type RSP_E22_PslItemInfo
- type RSP_E22_QueryAck
- type RSP_K11
- type RSP_K21
- type RSP_K21_QueryResponse
- type RSP_K22
- type RSP_K22_QueryResponse
- type RSP_K23
- type RSP_K23_QueryResponse
- type RSP_K24
- type RSP_K24_QueryResponse
- type RSP_K25
- type RSP_K25_Staff
- type RSP_K31
- type RSP_K31_Components
- type RSP_K31_Encoding
- type RSP_K31_Observation
- type RSP_K31_Order
- type RSP_K31_OrderDetail
- type RSP_K31_Patient
- type RSP_K31_PatientVisit
- type RSP_K31_Response
- type RSP_K31_Timing
- type RSP_K31_TimingEncoded
- type RSP_Z82
- type RSP_Z82_CommonOrder
- type RSP_Z82_EncodedOrder
- type RSP_Z82_Observation
- type RSP_Z82_OrderDetail
- type RSP_Z82_Patient
- type RSP_Z82_QueryResponse
- type RSP_Z82_Timing
- type RSP_Z82_TimingEncoded
- type RSP_Z82_Treatment
- type RSP_Z82_Visit
- type RSP_Z84
- type RSP_Z84_RowDefinition
- type RSP_Z86
- type RSP_Z86_Administration
- type RSP_Z86_CommonOrder
- type RSP_Z86_Dispense
- type RSP_Z86_EncodedOrder
- type RSP_Z86_Give
- type RSP_Z86_Observation
- type RSP_Z86_OrderDetail
- type RSP_Z86_Patient
- type RSP_Z86_QueryResponse
- type RSP_Z86_Timing
- type RSP_Z86_TimingEncoded
- type RSP_Z88
- type RSP_Z88_Allergy
- type RSP_Z88_CommonOrder
- type RSP_Z88_Component
- type RSP_Z88_Observation
- type RSP_Z88_OrderDetail
- type RSP_Z88_OrderEncoded
- type RSP_Z88_Patient
- type RSP_Z88_QueryResponse
- type RSP_Z88_Timing
- type RSP_Z88_TimingEncoded
- type RSP_Z88_Visit
- type RSP_Z90
- type RSP_Z90_CommonOrder
- type RSP_Z90_Observation
- type RSP_Z90_Patient
- type RSP_Z90_QueryResponse
- type RSP_Z90_Specimen
- type RSP_Z90_Timing
- type RSP_Z90_Visit
- type RTB_K13
- type RTB_K13_RowDefinition
- type RTB_Z74
- type RTB_Z74_RowDefinition
- type RTB_Z76
- type RTB_Z76_RowDefinition
- type RTB_Z92
- type RTB_Z92_RowDefinition
- type RTB_Z94
- type RTB_Z94_RowDefinition
- type RTB_Z96
- type RTB_Z96_RowDefinition
- type RXA
- type RXC
- type RXD
- type RXE
- type RXG
- type RXO
- type RXR
- type Row
- type SAC
- type SAD
- type SCD
- type SCH
- type SCN_S37
- type SCN_S37_AntiMicrobialDeviceCycleData
- type SCP
- type SCV
- type SDD
- type SDN_S36
- type SDN_S36_AntiMicrobialDeviceData
- type SDR_S31
- type SDR_S31_AntiMicrobialDeviceData
- type SFT
- type SI
- type SID
- type SIU_S12
- type SIU_S12_GeneralResource
- type SIU_S12_LocationResource
- type SIU_S12_Patient
- type SIU_S12_PersonnelResource
- type SIU_S12_Resources
- type SIU_S12_Service
- type SIU_S13
- type SIU_S13_GeneralResource
- type SIU_S13_LocationResource
- type SIU_S13_Patient
- type SIU_S13_PersonnelResource
- type SIU_S13_Resources
- type SIU_S13_Service
- type SIU_S14
- type SIU_S14_GeneralResource
- type SIU_S14_LocationResource
- type SIU_S14_Patient
- type SIU_S14_PersonnelResource
- type SIU_S14_Resources
- type SIU_S14_Service
- type SIU_S15
- type SIU_S15_GeneralResource
- type SIU_S15_LocationResource
- type SIU_S15_Patient
- type SIU_S15_PersonnelResource
- type SIU_S15_Resources
- type SIU_S15_Service
- type SIU_S16
- type SIU_S16_GeneralResource
- type SIU_S16_LocationResource
- type SIU_S16_Patient
- type SIU_S16_PersonnelResource
- type SIU_S16_Resources
- type SIU_S16_Service
- type SIU_S17
- type SIU_S17_GeneralResource
- type SIU_S17_LocationResource
- type SIU_S17_Patient
- type SIU_S17_PersonnelResource
- type SIU_S17_Resources
- type SIU_S17_Service
- type SIU_S18
- type SIU_S18_GeneralResource
- type SIU_S18_LocationResource
- type SIU_S18_Patient
- type SIU_S18_PersonnelResource
- type SIU_S18_Resources
- type SIU_S18_Service
- type SIU_S19
- type SIU_S19_GeneralResource
- type SIU_S19_LocationResource
- type SIU_S19_Patient
- type SIU_S19_PersonnelResource
- type SIU_S19_Resources
- type SIU_S19_Service
- type SIU_S20
- type SIU_S20_GeneralResource
- type SIU_S20_LocationResource
- type SIU_S20_Patient
- type SIU_S20_PersonnelResource
- type SIU_S20_Resources
- type SIU_S20_Service
- type SIU_S21
- type SIU_S21_GeneralResource
- type SIU_S21_LocationResource
- type SIU_S21_Patient
- type SIU_S21_PersonnelResource
- type SIU_S21_Resources
- type SIU_S21_Service
- type SIU_S22
- type SIU_S22_GeneralResource
- type SIU_S22_LocationResource
- type SIU_S22_Patient
- type SIU_S22_PersonnelResource
- type SIU_S22_Resources
- type SIU_S22_Service
- type SIU_S23
- type SIU_S23_GeneralResource
- type SIU_S23_LocationResource
- type SIU_S23_Patient
- type SIU_S23_PersonnelResource
- type SIU_S23_Resources
- type SIU_S23_Service
- type SIU_S24
- type SIU_S24_GeneralResource
- type SIU_S24_LocationResource
- type SIU_S24_Patient
- type SIU_S24_PersonnelResource
- type SIU_S24_Resources
- type SIU_S24_Service
- type SIU_S26
- type SIU_S26_GeneralResource
- type SIU_S26_LocationResource
- type SIU_S26_Patient
- type SIU_S26_PersonnelResource
- type SIU_S26_Resources
- type SIU_S26_Service
- type SLN_S34
- type SLN_S35
- type SLR_S28
- type SLR_S29
- type SLT
- type SMD_S32
- type SMD_S32_AntiMicrobialDeviceCycleData
- type SN
- type SPD
- type SPM
- type SPQ_Q08
- type SPR
- type SPS
- type SQM_S25
- type SQM_S25_GeneralResource
- type SQM_S25_LocationResource
- type SQM_S25_PersonnelResource
- type SQM_S25_Request
- type SQM_S25_Resources
- type SQM_S25_Service
- type SQR_S25
- type SQR_S25_GeneralResource
- type SQR_S25_LocationResource
- type SQR_S25_Patient
- type SQR_S25_PersonnelResource
- type SQR_S25_Resources
- type SQR_S25_Schedule
- type SQR_S25_Service
- type SRM_S01
- type SRM_S01_GeneralResource
- type SRM_S01_LocationResource
- type SRM_S01_Patient
- type SRM_S01_PersonnelResource
- type SRM_S01_Resources
- type SRM_S01_Service
- type SRM_S02
- type SRM_S02_GeneralResource
- type SRM_S02_LocationResource
- type SRM_S02_Patient
- type SRM_S02_PersonnelResource
- type SRM_S02_Resources
- type SRM_S02_Service
- type SRM_S03
- type SRM_S03_GeneralResource
- type SRM_S03_LocationResource
- type SRM_S03_Patient
- type SRM_S03_PersonnelResource
- type SRM_S03_Resources
- type SRM_S03_Service
- type SRM_S04
- type SRM_S04_GeneralResource
- type SRM_S04_LocationResource
- type SRM_S04_Patient
- type SRM_S04_PersonnelResource
- type SRM_S04_Resources
- type SRM_S04_Service
- type SRM_S05
- type SRM_S05_GeneralResource
- type SRM_S05_LocationResource
- type SRM_S05_Patient
- type SRM_S05_PersonnelResource
- type SRM_S05_Resources
- type SRM_S05_Service
- type SRM_S06
- type SRM_S06_GeneralResource
- type SRM_S06_LocationResource
- type SRM_S06_Patient
- type SRM_S06_PersonnelResource
- type SRM_S06_Resources
- type SRM_S06_Service
- type SRM_S07
- type SRM_S07_GeneralResource
- type SRM_S07_LocationResource
- type SRM_S07_Patient
- type SRM_S07_PersonnelResource
- type SRM_S07_Resources
- type SRM_S07_Service
- type SRM_S08
- type SRM_S08_GeneralResource
- type SRM_S08_LocationResource
- type SRM_S08_Patient
- type SRM_S08_PersonnelResource
- type SRM_S08_Resources
- type SRM_S08_Service
- type SRM_S09
- type SRM_S09_GeneralResource
- type SRM_S09_LocationResource
- type SRM_S09_Patient
- type SRM_S09_PersonnelResource
- type SRM_S09_Resources
- type SRM_S09_Service
- type SRM_S10
- type SRM_S10_GeneralResource
- type SRM_S10_LocationResource
- type SRM_S10_Patient
- type SRM_S10_PersonnelResource
- type SRM_S10_Resources
- type SRM_S10_Service
- type SRM_S11
- type SRM_S11_GeneralResource
- type SRM_S11_LocationResource
- type SRM_S11_Patient
- type SRM_S11_PersonnelResource
- type SRM_S11_Resources
- type SRM_S11_Service
- type SRR_S01
- type SRR_S01_GeneralResource
- type SRR_S01_LocationResource
- type SRR_S01_Patient
- type SRR_S01_PersonnelResource
- type SRR_S01_Resources
- type SRR_S01_Schedule
- type SRR_S01_Service
- type SRR_S02
- type SRR_S02_GeneralResource
- type SRR_S02_LocationResource
- type SRR_S02_Patient
- type SRR_S02_PersonnelResource
- type SRR_S02_Resources
- type SRR_S02_Schedule
- type SRR_S02_Service
- type SRR_S03
- type SRR_S03_GeneralResource
- type SRR_S03_LocationResource
- type SRR_S03_Patient
- type SRR_S03_PersonnelResource
- type SRR_S03_Resources
- type SRR_S03_Schedule
- type SRR_S03_Service
- type SRR_S04
- type SRR_S04_GeneralResource
- type SRR_S04_LocationResource
- type SRR_S04_Patient
- type SRR_S04_PersonnelResource
- type SRR_S04_Resources
- type SRR_S04_Schedule
- type SRR_S04_Service
- type SRR_S05
- type SRR_S05_GeneralResource
- type SRR_S05_LocationResource
- type SRR_S05_Patient
- type SRR_S05_PersonnelResource
- type SRR_S05_Resources
- type SRR_S05_Schedule
- type SRR_S05_Service
- type SRR_S06
- type SRR_S06_GeneralResource
- type SRR_S06_LocationResource
- type SRR_S06_Patient
- type SRR_S06_PersonnelResource
- type SRR_S06_Resources
- type SRR_S06_Schedule
- type SRR_S06_Service
- type SRR_S07
- type SRR_S07_GeneralResource
- type SRR_S07_LocationResource
- type SRR_S07_Patient
- type SRR_S07_PersonnelResource
- type SRR_S07_Resources
- type SRR_S07_Schedule
- type SRR_S07_Service
- type SRR_S08
- type SRR_S08_GeneralResource
- type SRR_S08_LocationResource
- type SRR_S08_Patient
- type SRR_S08_PersonnelResource
- type SRR_S08_Resources
- type SRR_S08_Schedule
- type SRR_S08_Service
- type SRR_S09
- type SRR_S09_GeneralResource
- type SRR_S09_LocationResource
- type SRR_S09_Patient
- type SRR_S09_PersonnelResource
- type SRR_S09_Resources
- type SRR_S09_Schedule
- type SRR_S09_Service
- type SRR_S10
- type SRR_S10_GeneralResource
- type SRR_S10_LocationResource
- type SRR_S10_Patient
- type SRR_S10_PersonnelResource
- type SRR_S10_Resources
- type SRR_S10_Schedule
- type SRR_S10_Service
- type SRR_S11
- type SRR_S11_GeneralResource
- type SRR_S11_LocationResource
- type SRR_S11_Patient
- type SRR_S11_PersonnelResource
- type SRR_S11_Resources
- type SRR_S11_Schedule
- type SRR_S11_Service
- type SRT
- type SSR_U04
- type SSR_U04_SpecimenContainer
- type SSU_U03
- type SSU_U03_Specimen
- type SSU_U03_SpecimenContainer
- type ST
- type STC_S33
- type STF
- type STI_S30
- type STZ
- type SUR_P09
- type SUR_P09_Facility
- type SUR_P09_FacilityDetail
- type SUR_P09_Product
- type TBR_R08
- type TCC
- type TCD
- type TCR_U11
- type TCR_U11_TestConfiguration
- type TCU_U10
- type TCU_U10_TestConfiguration
- type TM
- type TQ
- type TQ1
- type TQ2
- type TX
- type TXA
- type Table
- type UAC
- type UB1
- type UB2
- type UDM_Q05
- type URD
- type URS
- type UVC
- type VAR
- type VARIES
- type VH
- type VID
- type VND
- type VQQ_Q07
- type VR
- type VTQ
- type VXQ_V01
- type VXR_V03
- type VXR_V03_Insurance
- type VXR_V03_Observation
- type VXR_V03_Order
- type VXR_V03_PatientVisit
- type VXR_V03_Timing
- type VXU_V04
- type VXU_V04_Insurance
- type VXU_V04_Observation
- type VXU_V04_Order
- type VXU_V04_Patient
- type VXU_V04_Timing
- type VXX_V02
- type VXX_V02_Patient
- type XAD
- type XCN
- type XON
- type XPN
- type XTN
Constants ¶
This section is empty.
Variables ¶
var ControlSegmentRegistry = map[string]any{ "BHS": BHS{}, "BTS": BTS{}, "FHS": FHS{}, "FTS": FTS{}, "DSC": DSC{}, "OVR": OVR{}, "ADD": ADD{}, "SFT": SFT{}, "ARV": ARV{}, "UAC": UAC{}, }
Segments specific to file and batch control.
var DataTypeRegistry = map[string]any{ "AD": *(new(AD)), "AUI": *(new(AUI)), "CCD": *(new(CCD)), "CE": *(new(CE)), "CNE": *(new(CNE)), "CNN": *(new(CNN)), "CP": *(new(CP)), "CQ": *(new(CQ)), "CWE": *(new(CWE)), "CX": *(new(CX)), "DDI": *(new(DDI)), "DIN": *(new(DIN)), "DLD": *(new(DLD)), "DLN": *(new(DLN)), "DLT": *(new(DLT)), "DR": *(new(DR)), "DT": *(new(DT)), "DTM": *(new(DTM)), "DTN": *(new(DTN)), "ED": *(new(ED)), "EI": *(new(EI)), "EIP": *(new(EIP)), "ELD": *(new(ELD)), "ERL": *(new(ERL)), "FC": *(new(FC)), "FN": *(new(FN)), "FT": *(new(FT)), "GTS": *(new(GTS)), "HD": *(new(HD)), "ICD": *(new(ICD)), "ID": *(new(ID)), "IS": *(new(IS)), "JCC": *(new(JCC)), "LA1": *(new(LA1)), "LA2": *(new(LA2)), "MO": *(new(MO)), "MOC": *(new(MOC)), "MOP": *(new(MOP)), "MSG": *(new(MSG)), "NA": *(new(NA)), "NDL": *(new(NDL)), "NM": *(new(NM)), "NR": *(new(NR)), "OCD": *(new(OCD)), "OSD": *(new(OSD)), "OSP": *(new(OSP)), "PIP": *(new(PIP)), "PL": *(new(PL)), "PLN": *(new(PLN)), "PPN": *(new(PPN)), "PRL": *(new(PRL)), "PT": *(new(PT)), "PTA": *(new(PTA)), "QIP": *(new(QIP)), "QSC": *(new(QSC)), "RCD": *(new(RCD)), "RFR": *(new(RFR)), "RI": *(new(RI)), "RMC": *(new(RMC)), "RPT": *(new(RPT)), "SAD": *(new(SAD)), "SCV": *(new(SCV)), "SI": *(new(SI)), "SN": *(new(SN)), "SPD": *(new(SPD)), "SPS": *(new(SPS)), "SRT": *(new(SRT)), "ST": *(new(ST)), "TM": *(new(TM)), "TQ": *(new(TQ)), "TX": *(new(TX)), "UVC": *(new(UVC)), "VARIES": *(new(VARIES)), "VH": *(new(VH)), "VID": *(new(VID)), "VR": *(new(VR)), "XAD": *(new(XAD)), "XCN": *(new(XCN)), "XON": *(new(XON)), "XPN": *(new(XPN)), "XTN": *(new(XTN)), }
Data Type lookup by ID.
var Registry = registry{}
Registry implements the required interface for unmarshalling data.
var SegmentRegistry = map[string]any{}/* 172 elements not displayed */
Segment lookup by ID.
var TableLookup = map[string]Table{}/* 526 elements not displayed */
TableLookup provides valid values for field types.
var TableValueLookup = map[string]map[string]bool{}/* 526 elements not displayed */
TableValueLookup may be used to validate a specific value.
var TriggerRegistry = map[string]any{}/* 399 elements not displayed */
Trigger lookup by ID.
var Version = `2.6`
Version of this HL7 package.
Functions ¶
This section is empty.
Types ¶
type ABS ¶
type ABS struct {
HL7 HL7Name `hl7:",name=ABS,type=s"`
DischargeCareProvider *XCN `hl7:"1,len=250,table=0010,display=Discharge Care Provider"`
TransferMedicalServiceCode *CWE `hl7:"2,len=250,table=0069,display=Transfer Medical Service Code"`
SeverityOfIllnessCode *CWE `hl7:"3,len=250,table=0421,display=Severity of Illness Code"`
DateTimeOfAttestation DTM `hl7:"4,len=24,format=YMDHM,display=Date/Time of Attestation"`
AttestedBy *XCN `hl7:"5,len=250,display=Attested By"`
TriageCode *CWE `hl7:"6,len=250,table=0422,display=Triage Code"`
AbstractCompletionDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Abstract Completion Date/Time"`
AbstractedBy *XCN `hl7:"8,len=250,display=Abstracted By"`
CaseCategoryCode *CWE `hl7:"9,len=250,table=0423,display=Case Category Code"`
CaesarianSectionIndicator ID `hl7:"10,len=1,table=0136,display=Caesarian Section Indicator"`
GestationCategoryCode *CWE `hl7:"11,len=250,table=0424,display=Gestation Category Code"`
GestationPeriodWeeks NM `hl7:"12,len=3,display=Gestation Period - Weeks"`
NewbornCode *CWE `hl7:"13,len=250,table=0425,display=Newborn Code"`
StillbornIndicator ID `hl7:"14,len=1,table=0136,display=Stillborn Indicator"`
}
Abstract
This segment was created to communicate patient abstract information used for billing and reimbursement purposes. Abstract is a condensed form of medical history created for analysis, care planning, etc.
type ACC ¶
type ACC struct {
HL7 HL7Name `hl7:",name=ACC,type=s"`
AccidentDateTime DTM `hl7:"1,len=24,format=YMDHM,display=Accident Date/Time"`
AccidentCode *CWE `hl7:"2,len=250,table=0050,display=Accident Code"`
AccidentLocation ST `hl7:"3,len=25,display=Accident Location"`
AutoAccidentState CWE `hl7:"4,len=250,table=0347,display=Auto Accident State"`
AccidentJobRelatedIndicator ID `hl7:"5,len=1,table=0136,display=Accident Job Related Indicator"`
AccidentDeathIndicator ID `hl7:"6,len=12,table=0136,display=Accident Death Indicator"`
EnteredBy *XCN `hl7:"7,len=3220,display=Entered By"`
AccidentDescription ST `hl7:"8,len=25,display=Accident Description"`
BroughtInBy ST `hl7:"9,len=80,display=Brought In By"`
PoliceNotifiedIndicator ID `hl7:"10,len=1,table=0136,display=Police Notified Indicator"`
AccidentAddress *XAD `hl7:"11,len=250,display=Accident Address"`
}
Accident
The ACC segment contains patient information relative to an accident in which the patient has been involved.
type ACK ¶
type ACK struct {
HL7 HL7Name `hl7:",name=ACK,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
}
General Acknowledgment Message
The simple general acknowledgment (ACK) can be used where the application does not define a special application level acknowledgment message or where there has been an error that precludes application processing. It is also used for accept level acknowledgments.
type AD ¶
type AD struct {
HL7 HL7Name `hl7:",name=AD,len=415,type=d"`
StreetAddress ST `` /* 296-byte string literal not displayed */
OtherDesignation ST `` /* 225-byte string literal not displayed */
City ST `` /* 188-byte string literal not displayed */
StateOrProvince ST `` /* 196-byte string literal not displayed */
ZipOrPostalCode ST `` /* 339-byte string literal not displayed */
Country ID `` /* 274-byte string literal not displayed */
AddressType ID `` /* 143-byte string literal not displayed */
OtherGeographicDesignation ST `` /* 145-byte string literal not displayed */
}
Address
This data type specifies the address of a person, place or organization.
Note: Used only in the LA1 data type. Retained for backward compatibility as of v2.6. Replaced elsewhere by the XAD data type as of v 2.3.
type ADD ¶
type ADD struct {
HL7 HL7Name `hl7:",name=ADD,type=s"`
AddendumContinuationPointer ST `hl7:"1,len=65536,display=Addendum Continuation Pointer"`
}
Addendum
The ADD segment is used to define the continuation of the prior segment in a continuation message. See Section 2.10.2, " Continuation messages and segments ," for details.
type ADJ ¶
type ADJ struct {
HL7 HL7Name `hl7:",name=ADJ,type=s"`
ProviderAdjustmentNumber EI `hl7:"1,required,len=73,display=Provider Adjustment Number"`
PayerAdjustmentNumber EI `hl7:"2,required,len=73,display=Payer Adjustment Number"`
AdjustmentSequenceNumber SI `hl7:"3,required,len=4,display=Adjustment Sequence Number"`
AdjustmentCategory IS `hl7:"4,required,len=4,table=0564,display=Adjustment Category"`
AdjustmentAmount []CP `hl7:"5,max=5,len=254,display=Adjustment Amount"`
AdjustmentQuantity *CQ `hl7:"6,len=222,display=Adjustment Quantity"`
AdjustmentReasonPA *CWE `hl7:"7,conditional,len=211,table=0565,display=Adjustment Reason PA"`
AdjustmentDescription ST `hl7:"8,len=250,display=Adjustment Description"`
OriginalValue NM `hl7:"9,len=250,display=Original Value"`
SubstituteValue NM `hl7:"10,len=250,display=Substitute Value"`
AdjustmentAction IS `hl7:"11,len=4,table=0569,display=Adjustment Action"`
ProviderAdjustmentNumberCrossReference *EI `hl7:"12,len=73,display=Provider Adjustment Number Cross Reference"`
ProviderProductServiceLineItemNumberCrossReference *EI `hl7:"13,len=73,display=Provider Product/Service Line Item Number Cross Reference"`
AdjustmentDate DTM `hl7:"14,required,len=26,format=YMDHM,display=Adjustment Date"`
ResponsibleOrganization *XON `hl7:"15,len=183,display=Responsible Organization"`
}
Adjustment
This segment describes Provider and/or Payer adjustments to a Product/Service Line Item or Response Summary. These include surcharges such as tax, dispensing fees and mark ups.
type ADR_A19 ¶
type ADR_A19 struct {
HL7 HL7Name `hl7:",name=ADR_A19,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
QueryResponse []ADR_A19_QueryResponse `hl7:",required,display=Query Response"`
DSC *DSC `hl7:"34,display=Continuation Pointer"`
}
Patient Response
The Original Mode Query was retained for backward compatibility only as of version 2.4.
Another application determines a need for Patient Administration data about a patient and sends a query to the Patient Administration system. The Who Filter in the QRD can identify the patient or account number upon which the query is defined and can contain a format code of "R" (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue. The ADT event-type segment, if included in the response, describes the last event for which the Patient Administration system initiated an unsolicited update.
type ADR_A19_Insurance ¶
type ADR_A19_Insurance struct {
HL7 HL7Name `hl7:",name=ADR_A19_Insurance,type=tg"`
IN1 *IN1 `hl7:"27,required,display=Insurance"`
IN2 *IN2 `hl7:"28,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"29,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"30,display=Role"`
}
Insurance
type ADR_A19_Procedure ¶
type ADR_A19_Procedure struct {
HL7 HL7Name `hl7:",name=ADR_A19_Procedure,type=tg"`
PR1 *PR1 `hl7:"24,required,display=Procedures"`
ROL []ROL `hl7:"25,display=Role"`
}
Procedure
type ADR_A19_QueryResponse ¶
type ADR_A19_QueryResponse struct {
HL7 HL7Name `hl7:",name=ADR_A19_QueryResponse,type=tg"`
EVN *EVN `hl7:"9,display=Event Type"`
PID *PID `hl7:"10,required,display=Patient Identification"`
PD1 *PD1 `hl7:"11,display=Patient Additional Demographic"`
ARV []ARV `hl7:"12,display=Access Restrictions"`
ROL []ROL `hl7:"13,display=Role"`
NK1 []NK1 `hl7:"14,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"15,required,display=Patient Visit"`
PV2 *PV2 `hl7:"16,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"17,display=Access Restrictions"`
ROL2 []ROL `hl7:"18,display=Role"`
DB1 []DB1 `hl7:"19,display=Disability"`
OBX []OBX `hl7:"20,display=Observation/Result"`
AL1 []AL1 `hl7:"21,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"22,display=Diagnosis"`
DRG *DRG `hl7:"23,display=Diagnosis Related Group"`
Procedure []ADR_A19_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"26,display=Guarantor"`
Insurance []ADR_A19_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"31,display=Accident"`
UB1 *UB1 `hl7:"32,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"33,display=UB92 Data"`
}
QueryResponse
type ADT_A01 ¶
type ADT_A01 struct {
HL7 HL7Name `hl7:",name=ADT_A01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A01_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A01_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
PDA *PDA `hl7:"29,display=Patient Death and Autopsy"`
}
Admit/Visit Notification
An A01 event is intended to be used for "Admitted" patients only. An A01 event is sent as a result of a patient undergoing the admission process which assigns the patient to a bed. It signals the beginning of a patient's stay in a healthcare facility. Normally, this information is entered in the primary Patient Administration system and broadcast to the nursing units and ancillary systems. It includes short stay and "Adam Everyman" (e.g., patient name is unknown) admissions. For example, an A01 event can be used to notify: the pharmacy system that a patient has been admitted and may be legitimately prescribed drugs; the nursing system that the patient has been admitted and needs a care plan prepared; the finance system of the start of the billing period; the dietary system that a new patient has been installed and requires dietary services; the laboratory, pathology, and radiology systems that a patient has been admitted and is entitled to receive services; the clinical repository that an admission has taken place for the EMR (electronic medical record).
type ADT_A01_Insurance ¶
type ADT_A01_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A01_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A01_Procedure ¶
type ADT_A01_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A01_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A02 ¶
type ADT_A02 struct {
HL7 HL7Name `hl7:",name=ADT_A02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"11,display=Access Restrictions"`
ROL2 []ROL `hl7:"12,display=Role"`
DB1 []DB1 `hl7:"13,display=Disability"`
OBX []OBX `hl7:"14,display=Observation/Result"`
PDA *PDA `hl7:"15,display=Patient Death and Autopsy"`
}
Transfer a Patient
An A02 event is issued as a result of the patient changing his or her assigned physical location.
type ADT_A03 ¶
type ADT_A03 struct {
HL7 HL7Name `hl7:",name=ADT_A03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG *DRG `hl7:"17,display=Diagnosis Related Group"`
Procedure []ADT_A03_Procedure `hl7:",display=Procedure"`
OBX []OBX `hl7:"20,display=Observation/Result"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A03_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
PDA *PDA `hl7:"27,display=Patient Death and Autopsy"`
}
Discharge/End Visit
An A03 event signals the end of a patient's stay in a healthcare facility. It signals that the patient's status has changed to "discharged" and that a discharge date has been recorded. The patient is no longer in the facility. The patient's location prior to discharge should be entered in PV1-3 - Assigned Patient Location.
type ADT_A03_Insurance ¶
type ADT_A03_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A03_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A03_Procedure ¶
type ADT_A03_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A03_Procedure,type=tg"`
PR1 *PR1 `hl7:"18,required,display=Procedures"`
ROL []ROL `hl7:"19,display=Role"`
}
Procedure
type ADT_A04 ¶
type ADT_A04 struct {
HL7 HL7Name `hl7:",name=ADT_A04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A04_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A04_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
PDA *PDA `hl7:"29,display=Patient Death and Autopsy"`
}
Register a Patient
An A04 event signals that the patient has arrived or checked in as a one-time, or recurring outpatient, and is not assigned to a bed. One example might be its use to signal the beginning of a visit to the Emergency Room (= Casualty, etc.). Note that some systems refer to these events as outpatient registrations or emergency admissions. PV1-44 - Admit Date/Time is used for the visit start date/time.
type ADT_A04_Insurance ¶
type ADT_A04_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A04_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A04_Procedure ¶
type ADT_A04_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A04_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A05 ¶
type ADT_A05 struct {
HL7 HL7Name `hl7:",name=ADT_A05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A05_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A05_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
}
Pre-Admit a Patient
An A05 event is sent when a patient undergoes the pre-admission process. During this process, episode-related data is collected in preparation for a patient's visit or stay in a healthcare facility. For example, a pre-admit may be performed prior to inpatient or outpatient surgery so that lab tests can be performed prior to the surgery. This event can also be used to pre-register a non-admitted patient.
type ADT_A05_Insurance ¶
type ADT_A05_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A05_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A05_Procedure ¶
type ADT_A05_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A05_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A06 ¶
type ADT_A06 struct {
HL7 HL7Name `hl7:",name=ADT_A06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
MRG *MRG `hl7:"9,display=Merge Patient Information"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"11,required,display=Patient Visit"`
PV2 *PV2 `hl7:"12,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"13,display=Access Restrictions"`
ROL2 []ROL `hl7:"14,display=Role"`
DB1 []DB1 `hl7:"15,display=Disability"`
OBX []OBX `hl7:"16,display=Observation/Result"`
AL1 []AL1 `hl7:"17,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"18,display=Diagnosis"`
DRG *DRG `hl7:"19,display=Diagnosis Related Group"`
Procedure []ADT_A06_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"22,display=Guarantor"`
Insurance []ADT_A06_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"27,display=Accident"`
UB1 *UB1 `hl7:"28,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"29,display=UB92 Data"`
}
Change an Outpatient to an Inpatient
An A06 event is sent when a patient who was present for a non-admitted visit is being admitted after an evaluation of the seriousness of the patient's condition. This event changes a patient's status from non-admitted to admitted. The new patient location should appear in PV1-3 - Assigned Patient Location, while the old patient location (if different) should appear in PV1-6 - Prior Patient Location. The new patient class should appear in PV1-2 - Patient Class.
type ADT_A06_Insurance ¶
type ADT_A06_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A06_Insurance,type=tg"`
IN1 *IN1 `hl7:"23,required,display=Insurance"`
IN2 *IN2 `hl7:"24,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"25,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"26,display=Role"`
}
Insurance
type ADT_A06_Procedure ¶
type ADT_A06_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A06_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
ROL []ROL `hl7:"21,display=Role"`
}
Procedure
type ADT_A07 ¶
type ADT_A07 struct {
HL7 HL7Name `hl7:",name=ADT_A07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
MRG *MRG `hl7:"9,display=Merge Patient Information"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"11,required,display=Patient Visit"`
PV2 *PV2 `hl7:"12,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"13,display=Access Restrictions"`
ROL2 []ROL `hl7:"14,display=Role"`
DB1 []DB1 `hl7:"15,display=Disability"`
OBX []OBX `hl7:"16,display=Observation/Result"`
AL1 []AL1 `hl7:"17,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"18,display=Diagnosis"`
DRG *DRG `hl7:"19,display=Diagnosis Related Group"`
Procedure []ADT_A07_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"22,display=Guarantor"`
Insurance []ADT_A07_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"27,display=Accident"`
UB1 *UB1 `hl7:"28,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"29,display=UB92 Data"`
}
Change an Inpatient to an Outpatient
An A07 event is sent when a patient who was admitted changes his/her status to "no longer admitted" but is still being seen for this episode of care. This event changes a patient from an "admitted" to a "non-admitted" status. The new patient location should appear in PV1-3 - Assigned Patient Location, while the old patient location (if different) should appear in PV1-6 - Prior Patient Location.
type ADT_A07_Insurance ¶
type ADT_A07_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A07_Insurance,type=tg"`
IN1 *IN1 `hl7:"23,required,display=Insurance"`
IN2 *IN2 `hl7:"24,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"25,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"26,display=Role"`
}
Insurance
type ADT_A07_Procedure ¶
type ADT_A07_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A07_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
ROL []ROL `hl7:"21,display=Role"`
}
Procedure
type ADT_A08 ¶
type ADT_A08 struct {
HL7 HL7Name `hl7:",name=ADT_A08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A08_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A08_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
PDA *PDA `hl7:"29,display=Patient Death and Autopsy"`
}
Update Patient Information
This trigger event is used when any patient information has changed but when no other trigger event has occurred. For example, an A08 event can be used to notify the receiving systems of a change of address or a name change. We strongly recommend that the A08 transaction be used to update fields that are not updated by any of the other trigger events. If there are specific trigger events for this update, these trigger events should be used. For example, if a patient's address and location are to be changed, then an A08 is used to change the patient address and the appropriate patient location trigger event is used to change the patient location. The A08 event can include information specific to an episode of care, but it can also be used for demographic information only.
type ADT_A08_Insurance ¶
type ADT_A08_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A08_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A08_Procedure ¶
type ADT_A08_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A08_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A09 ¶
type ADT_A09 struct {
HL7 HL7Name `hl7:",name=ADT_A09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
DG1 []DG1 `hl7:"11,display=Diagnosis"`
}
Patient Departing - Tracking
The A09 and A10 - patient arriving-tracking events are used when there is a change in a patient's physical location (inpatient or outpatient) and when this is NOT a change in the official census bed location, as in the case of an outpatient setting. There are three situations that qualify as non-census location changes: (a) patient tracking, (b) the patient is in transit between locations for some time, (c) a notification of temporary location change.
type ADT_A10 ¶
type ADT_A10 struct {
HL7 HL7Name `hl7:",name=ADT_A10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
DG1 []DG1 `hl7:"11,display=Diagnosis"`
}
Patient Arriving - Tracking
The A10 event is sent when a patient arrives at a new location in the healthcare facility (inpatient or outpatient). The A09 - patient departing-tracking and A10 events are used when there is a change in a patient's physical location and when this is NOT a change in the official census bed location, as in the case of an outpatient setting. There are three varieties of these non-census location changes involving three different kinds of notification: (a) an unofficial notification of location change prior to the official notification of patient tracking, (b) the patient is in transit between locations for some time, (c) a notification of a temporary location change.
type ADT_A11 ¶
type ADT_A11 struct {
HL7 HL7Name `hl7:",name=ADT_A11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
DG1 []DG1 `hl7:"11,display=Diagnosis"`
}
Cancel Admit/Visit Notification
For "admitted" patients, the A11 event is sent when an A01 (admit/visit notification) event is cancelled, either because of an erroneous entry of the A01 event, or because of a decision not to admit the patient after all.
For "non-admitted" patients, the A11 event is sent when an A04 (register a patient) event is cancelled, either because of an erroneous entry of the A04 event, or because of a decision not to check the patient in for the visit after all. To cancel an A05 (pre-admit a patient) event, use the A38 (cancel pre-admit), which was new for Version 2.3 of this Standard.
type ADT_A12 ¶
type ADT_A12 struct {
HL7 HL7Name `hl7:",name=ADT_A12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
DG1 *DG1 `hl7:"11,display=Diagnosis"`
}
Cancel Transfer
The A12 event is sent when an A02 (transfer a patient) event is cancelled, either because of erroneous entry of the A02 event or because of a decision not to transfer the patient after all. PV1-3 - Assigned Patient Location must show the location of the patient prior to the original transfer.
The DG1 segment remains in this message for backward compatibility only.
type ADT_A13 ¶
type ADT_A13 struct {
HL7 HL7Name `hl7:",name=ADT_A13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A13_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A13_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
PDA *PDA `hl7:"29,display=Patient Death and Autopsy"`
}
Cancel Discharge/End Visit
The A13 event is sent when an A03 (discharge/end visit) event is cancelled, either because of erroneous entry of the A03 event or because of a decision not to discharge or end the visit of the patient after all. PV1-3 - Assigned Patient Location should reflect the location of the patient after the cancellation has been processed. Note that this location may be different from the patient's location prior to the erroneous discharge. Prior Location could be used to show the location of the patient prior to the erroneous discharge.
Note from the Caristix team: ADT_A13.7 (ARV) does not exist in the documentation for HL7 v2.6, but it should exist given the structure of ADT_A01.
type ADT_A13_Insurance ¶
type ADT_A13_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A13_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A13_Procedure ¶
type ADT_A13_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A13_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A14 ¶
type ADT_A14 struct {
HL7 HL7Name `hl7:",name=ADT_A14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A14_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A14_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
}
Pending Admit
An A14 event notifies other systems of a planned admission, when there is a reservation or when patient admission is to occur imminently. The A14 event is similar to a pre-admit, but without the implication that an account should be opened for the purposes of tests prior to admission. It is used when advanced notification of an admit is required in order to prepare for the patient's arrival.
type ADT_A14_Insurance ¶
type ADT_A14_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A14_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A14_Procedure ¶
type ADT_A14_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A14_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A15 ¶
type ADT_A15 struct {
HL7 HL7Name `hl7:",name=ADT_A15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"11,display=Access Restrictions"`
ROL2 []ROL `hl7:"12,display=Role"`
DB1 []DB1 `hl7:"13,display=Disability"`
OBX []OBX `hl7:"14,display=Observation/Result"`
DG1 []DG1 `hl7:"15,display=Diagnosis"`
}
Pending Transfer
An A15 event notifies other systems of a plan to transfer a patient to a new location when the patient has not yet left the old location. It is used when advanced notification of a transfer is required in order to prepare for the patient's location change. For example, this transaction could be sent so that staff will be on hand to move the patient or so that dietary services can route the next meal to the new location.
The DG1 segment remains in this message for backward compatibility only
type ADT_A16 ¶
type ADT_A16 struct {
HL7 HL7Name `hl7:",name=ADT_A16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A16_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A16_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
}
Pending Discharge
An A16 event notifies other systems of a plan to discharge a patient when the patient has not yet left the healthcare facility. It is used when advanced notification of a discharge is required in order to prepare for the patient's change in location. For example, it is used to notify the pharmacy of the possible need for discharge drugs or to notify psychotherapy of the possible need for post-discharge appointments or to notify the extended care or home health system that the patient will be discharged and that the new extended care and home health admission assessment can be scheduled.
type ADT_A16_Insurance ¶
type ADT_A16_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A16_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A16_Procedure ¶
type ADT_A16_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A16_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A17 ¶
type ADT_A17 struct {
HL7 HL7Name `hl7:",name=ADT_A17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
PID2 *PID `hl7:"11,required,display=Patient Identification"`
PD12 *PD1 `hl7:"12,display=Patient Additional Demographic"`
PV12 *PV1 `hl7:"13,required,display=Patient Visit"`
PV22 *PV2 `hl7:"14,display=Patient Visit - Additional Information"`
DB12 []DB1 `hl7:"15,display=Disability"`
OBX2 []OBX `hl7:"16,display=Observation/Result"`
}
Swap Patients
The A17 is used when it is decided that two patients will exchange beds. The patient ID and visit data are repeated for the two patients changing places. See section 3.6.1, "Swapping a patient," for a discussion of issues related to implementing this trigger event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.
type ADT_A18 ¶
type ADT_A18 struct {
HL7 HL7Name `hl7:",name=ADT_A18,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
EVN *EVN `hl7:"3,required,display=Event Type"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
MRG *MRG `hl7:"6,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
}
Merge Patient Information
Event A18 has been retained for backward compatibility only in version 2.3.1. The A18 event was used to merge current and previous patient identification numbers: PID-3 - Patient Identifier List, PID-2 - Patient ID, PID-4 - Alternate Patient ID-PID, and PID-18 - Patient Account Number. This procedure is required, for example, when a previous patient is registered under a new patient identification number because of an error, or because there was insufficient time to determine the actual patient identification number. The merge event occurs when a decision is made to combine the information under either the new or the old identifier(s). The PID segment contains the surviving patient ID information. The MRG segment contains the non-surviving information.
From V2.3.1 onwards events A40 (merge patient-patient identifier list), A41 (merge account-patient account number), and A42 (merge visit-visit number) should be utilized in place of the A18 event.
type ADT_A20 ¶
type ADT_A20 struct {
HL7 HL7Name `hl7:",name=ADT_A20,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
NPU *NPU `hl7:"5,required,display=Bed Status Update"`
}
Bed Status Update
Certain nursing/census applications need to be able to update the Patient Administration system's bed status.
type ADT_A21 ¶
type ADT_A21 struct {
HL7 HL7Name `hl7:",name=ADT_A21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Patient Goes on a Leave of Absence
An A21 event is sent to notify systems that an admitted patient has left the healthcare institution temporarily. It is used for systems in which a bed is still assigned to the patient, and it puts the current admitted patient activities on hold. For example, it is used to notify dietary services and laboratory systems when the patient goes home for the weekend.
type ADT_A22 ¶
type ADT_A22 struct {
HL7 HL7Name `hl7:",name=ADT_A22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Patient Returns From a Leave of Absence
An A22 event is sent to notify systems that an admitted patient has returned to the healthcare institution after a temporary "leave of absence." It is used for systems in which a bed is still assigned to the patient, and it takes their current admitted patient activities off of "hold" status. For example, it is used to notify dietary services and laboratory systems when the patient returns from a weekend trip to his/her home.
type ADT_A23 ¶
type ADT_A23 struct {
HL7 HL7Name `hl7:",name=ADT_A23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Delete a Patient Record
The A23 event is used to delete visit or episode-specific information from the patient record. For example, it is used to remove old data from a database that cannot hold all historical patient visit data. When an event was entered erroneously, use one of the cancel transactions. This event can be used to purge account-level data while retaining the person in the database.
type ADT_A24 ¶
type ADT_A24 struct {
HL7 HL7Name `hl7:",name=ADT_A24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
DB1 []DB1 `hl7:"8,display=Disability"`
PID2 *PID `hl7:"9,required,display=Patient Identification"`
PD12 *PD1 `hl7:"10,display=Patient Additional Demographic"`
PV12 *PV1 `hl7:"11,display=Patient Visit"`
DB12 []DB1 `hl7:"12,display=Disability"`
}
Link Patient Information
The A24 event is used when the first PID segment needs to be linked to the second PID segment and when both patient identifiers identify the same patient. Linking two or more patients does not require the actual merging of patient information; following a link event, the affected patient data records should remain distinct. For example, this event could be used in a hospital network environment in which there are multiple campuses and in which records need to be linked. For example, hospital A, hospital B, and hospital C would each keep their own records on a patient, but an A24 link event would be sent to a corporate-wide MPI to enable the coupling of ID information with the corporate ID number. It is used for corporate data repositories, etc. This event is not meant to link mothers and babies since a field exists (PID-21 - Mother's Identifier) for that purpose. See section 3.6.3, "Patient record links," for a discussion of issues related to implementing patient link messages and MPI issues.
type ADT_A25 ¶
type ADT_A25 struct {
HL7 HL7Name `hl7:",name=ADT_A25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Cancel Pending Discharge
The A25 event is sent when an A16 (pending discharge) event is cancelled, either because of erroneous entry of the A16 event or because of a decision not to discharge the patient after all.
type ADT_A26 ¶
type ADT_A26 struct {
HL7 HL7Name `hl7:",name=ADT_A26,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Cancel Pending Transfer
The A26 event is sent when an A15 (pending transfer) event is cancelled, either because of erroneous entry of the A15 event or because of a decision not to transfer the patient after all.
type ADT_A27 ¶
type ADT_A27 struct {
HL7 HL7Name `hl7:",name=ADT_A27,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Cancel Pending Admit
The A27 event is sent when an A14 (pending admit) event is cancelled, either because of erroneous entry of the A14 event or because of a decision not to admit the patient after all.
type ADT_A28 ¶
type ADT_A28 struct {
HL7 HL7Name `hl7:",name=ADT_A28,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A28_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A28_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
}
Add Person Information
The purpose of this and the three following messages was to allow sites with multiple systems and respective master patient databases to communicate activity related to a person regardless of whether that person is currently a patient on each system. Each system has an interest in the database activity of the others in order to maintain data integrity across an institution. Though they are defined within the ADT message set, these messages differ in that they are not patient-specific. To a certain registry, the person may be a person of interest, a potential future patient, or a potential guarantor. For example, these events can be used to maintain an MPI (master patient index), a cancer registry, members of a managed care plan, an HIV database, etc.
type ADT_A28_Insurance ¶
type ADT_A28_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A28_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A28_Procedure ¶
type ADT_A28_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A28_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A29 ¶
type ADT_A29 struct {
HL7 HL7Name `hl7:",name=ADT_A29,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Delete Person Information
An A29 event can be used to delete all demographic information related to a given person. This event "undoes" an A28 (add person information) event. The information from the A28 event is deleted. This event is used, for example, when adding the information was performed in error, or when another record already exists for the person, or when one wants to purge the person from the database. When this event occurs, all visit and account level data for this person is also purged.
To maintain backward compatibility with previous releases, the PV1 segment is required. However, a "pseudo-optional" PV1 can be achieved by valuing PV1-2 - Patient Class to N - not applicable.
type ADT_A30 ¶
type ADT_A30 struct {
HL7 HL7Name `hl7:",name=ADT_A30,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
}
Merge Person Information
Event A30 has been retained for backward compatibility only. An A30 event was used to merge person information on an MPI. From V 2.3.1 onwards, the A40 (merge patient-patient identifier list) events should be used to merge patient information for a current episode. The "incorrect MRN" identified on the MRG segment (MRG-1 - Prior Patient Identifier List) is to be merged with the "correct MRN" identified on the PID segment (PID-3 - Patient Identifier List). The "incorrect MRN" then no longer exists. All PID data associated with the "correct MRN" are treated as updated information.
type ADT_A31 ¶
type ADT_A31 struct {
HL7 HL7Name `hl7:",name=ADT_A31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
ROL []ROL `hl7:"8,display=Role"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"12,display=Access Restrictions"`
ROL2 []ROL `hl7:"13,display=Role"`
DB1 []DB1 `hl7:"14,display=Disability"`
OBX []OBX `hl7:"15,display=Observation/Result"`
AL1 []AL1 `hl7:"16,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG *DRG `hl7:"18,display=Diagnosis Related Group"`
Procedure []ADT_A31_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []ADT_A31_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
UB1 *UB1 `hl7:"27,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"28,display=UB92 Data"`
}
Update Person Information
An A31 event can be used to update person information on an MPI. It is similar to an A08 (update patient information) event, but an A08 (update patient information) event should be used to update patient information for a current episode. An A28 (add person information) or A31 can also be used for backloading MPI information for the person, or for backloading person and historical information.
type ADT_A31_Insurance ¶
type ADT_A31_Insurance struct {
HL7 HL7Name `hl7:",name=ADT_A31_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type ADT_A31_Procedure ¶
type ADT_A31_Procedure struct {
HL7 HL7Name `hl7:",name=ADT_A31_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
ROL []ROL `hl7:"20,display=Role"`
}
Procedure
type ADT_A32 ¶
type ADT_A32 struct {
HL7 HL7Name `hl7:",name=ADT_A32,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Cancel Patient Arriving - Tracking
The A32 event is sent when an A10 (patient arriving-tracking) event is cancelled, either because of erroneous entry of the A10 event or because of a decision not to receive the patient after all.
If the patient was in a non-temporary location, then the PV1-3 - Assigned Patient Location may contain (if known) the original patient location prior to the erroneous A10 (patient arriving-tracking) event. If the patient was in a temporary location, then PV1-11 - Temporary Location may contain (if known) the original patient location prior to the erroneous A10 (patient arriving-tracking) event.
type ADT_A33 ¶
type ADT_A33 struct {
HL7 HL7Name `hl7:",name=ADT_A33,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Cancel Patient Departing - Tracking
The A33 event is sent when an A09 (patient departing-tracking) event is cancelled, either because of erroneous entry of the A09 event or because of a decision not to send the patient after all.
If the patient was in a non-temporary location, then PV1-3 - Assigned Patient location must contain the original patient location prior to the erroneous A09 (patient departing-tracking) event. If the patient was in a temporary location, then PV1-11 - Temporary Location must contain the original patient location prior to the erroneous A09 (patient departing-tracking) event.
type ADT_A34 ¶
type ADT_A34 struct {
HL7 HL7Name `hl7:",name=ADT_A34,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
MRG *MRG `hl7:"8,required,display=Merge Patient Information"`
}
Merge Patient Information - Patient ID Only
From V2.3.1, event A34 has been retained for backward compatibility only; event A40 (Merge patient - patient identifier list) should be used instead. Only the patient identifier list has changed as a result of the merge.
An A34 (merge patient information-patient ID only) event was intended for merging or changing patient identifiers. It was used to change patient identifiers on all of this patient's existing accounts.
type ADT_A35 ¶
type ADT_A35 struct {
HL7 HL7Name `hl7:",name=ADT_A35,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
}
Merge Patient Information - Account Number Only
From V2.3.1, event A35 has been retained for backward compatibility only; event A41 (Merge patient - patient account number) should be used instead. Only the patient account number has changed as a result of the merge.
An A35 (merge patient information-account number only) event was intended for merging or changing an account number only.
type ADT_A36 ¶
type ADT_A36 struct {
HL7 HL7Name `hl7:",name=ADT_A36,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
MRG *MRG `hl7:"8,required,display=Merge Patient Information"`
}
Merge Patient Information - Patient ID & Account Number
From V2.3.1, event A36 has been retained for backward compatibility only; events A40 (merge patient - patient identifier list) and A41 (merge patient - patient account number) should be used instead. Both patient identifier list and the patient account number have changed as a result of the merge.
type ADT_A37 ¶
type ADT_A37 struct {
HL7 HL7Name `hl7:",name=ADT_A37,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
DB1 []DB1 `hl7:"8,display=Disability"`
PID2 *PID `hl7:"9,required,display=Patient Identification"`
PD12 *PD1 `hl7:"10,display=Patient Additional Demographic"`
PV12 *PV1 `hl7:"11,display=Patient Visit"`
DB12 []DB1 `hl7:"12,display=Disability"`
}
Unlink Patient Information
The A37 event unlinks two patient identifiers.
type ADT_A38 ¶
type ADT_A38 struct {
HL7 HL7Name `hl7:",name=ADT_A38,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
DB1 []DB1 `hl7:"9,display=Disability"`
OBX []OBX `hl7:"10,display=Observation/Result"`
DG1 []DG1 `hl7:"11,display=Diagnosis"`
DRG *DRG `hl7:"12,display=Diagnosis Related Group"`
}
Cancel Pre-Admit
The A38 event is sent when an A05 (pre-admit a patient) event is cancelled, either because of erroneous entry of the A05 event or because of a decision not to pre-admit the patient after all.
type ADT_A39 ¶
type ADT_A39 struct {
HL7 HL7Name `hl7:",name=ADT_A39,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A39_Patient `hl7:",required,display=Patient"`
}
Merge Person - Patient Id
From V2.3.1, Event A39 has been retained for backward compatibility only; event A40 (merge patient - patient identifier list) should be used instead. A merge has been done at the patient identifier level. That is, two PID-2 - Patient ID identifiers have been merged into one.
An A39 event is used to signal a merge of records for a person that was incorrectly filed under two different PID-2 - Patient IDs. The "incorrect source patient ID" identified in the MRG segment (MRG-4 - Prior Patient ID) is to be merged with the required "correct target patient ID" identified in the PID segment (PID-2 - Patient ID). The "incorrect source patient ID" would then logically never be referenced in future transactions. It is noted that some systems may still physically keep this "incorrect identifier" for audit trail purposes or other reasons associated with database index implementation requirements.
type ADT_A39_Patient ¶
type ADT_A39_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A39_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
}
Patient
type ADT_A40 ¶
type ADT_A40 struct {
HL7 HL7Name `hl7:",name=ADT_A40,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A40_Patient `hl7:",required,display=Patient"`
}
Merge patient - Patient Identifier List
A merge has been done at the patient identifier list level. That is, two PID-3 - Patient Identifier List identifiers have been merged into one.
An A40 event is used to signal a merge of records for a patient that was incorrectly filed under two different identifiers. The "incorrect source identifier" identified in the MRG segment (MRG-1 - Prior Patient Identifier List) is to be merged with the required "correct target identifier" of the same "identifier type code" component identified in the PID segment (PID-3 - Patient Identifier List). The "incorrect source identifier" would then logically never be referenced in future transactions. It is noted that some systems may still physically keep this "incorrect identifier" for audit trail purposes or other reasons associated with database index implementation requirements.
type ADT_A40_Patient ¶
type ADT_A40_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A40_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
}
Patient
type ADT_A41 ¶
type ADT_A41 struct {
HL7 HL7Name `hl7:",name=ADT_A41,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A41_Patient `hl7:",required,display=Patient"`
}
Merge Account - Patient Account Number
A merge has been done at the account identifier level. That is, two PID-18 - Patient Account Number identifiers have been merged into one.
An A41 event is used to signal a merge of records for an account that was incorrectly filed under two different account numbers. The "incorrect source patient account number" identified in the MRG segment (MRG-3 - Prior Patient Account Number) is to be merged with the "correct target patient account number" identified in the PID segment (PID-18 - Patient Account Number). The "incorrect source patient account number" would then logically never be referenced in future transactions. It is noted that some systems may still physically keep this "incorrect identifier" for audit trail purposes or other reasons associated with database index implementation requirements.
type ADT_A41_Patient ¶
type ADT_A41_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A41_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
}
Patient
type ADT_A42 ¶
type ADT_A42 struct {
HL7 HL7Name `hl7:",name=ADT_A42,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A42_Patient `hl7:",required,display=Patient"`
}
Merge Visit - Visit Number
A merge has been done at the visit identifier level. That is, two PV1-19 - Visit Number identifiers have been merged into one.
An A42 event is used to signal a merge of records for a visit that was incorrectly filed under two different visit numbers. The "incorrect source visit number" identified in the MRG segment (MRG-5 - Prior Visit Number) is to be merged with the required "correct target visit number" identified in the PV1 segment (PV1-19 - Visit Number). The "incorrect source visit number" would then logically never be referenced in future transactions. It is noted that some systems may still physically keep this "incorrect identifier" for audit trail purposes or other reasons associated with database index implementation requirements.
type ADT_A42_Patient ¶
type ADT_A42_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A42_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
}
Patient
type ADT_A43 ¶
type ADT_A43 struct {
HL7 HL7Name `hl7:",name=ADT_A43,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A43_Patient `hl7:",required,display=Patient"`
}
Move Patient Information - Patient Identifier List
A move has been done at the patient identifier list level. Identifier to be moved in the PID-3 - Patient Identifier List and MRG-1 - Prior Patient Identifier List will have the same value. The "from" (incorrect source patient ID) and "to" (correct target patient ID) identifiers have different values. The identifiers involved in identifying the patient to be moved (MRG-1 - Prior Patient Identifier List) may or may not have accounts, which may or may not have visits. In any case, all subordinate data sets associated with the identifier in MRG-1 - Prior Patient Identifier List are moved along with the identifier, from the "incorrect source patient ID" to the "correct target patient ID."
type ADT_A43_Patient ¶
type ADT_A43_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A43_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
}
Patient
type ADT_A44 ¶
type ADT_A44 struct {
HL7 HL7Name `hl7:",name=ADT_A44,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []ADT_A44_Patient `hl7:",required,display=Patient"`
}
Move Account Information - Patient Account Number
A move has been done at the account identifier level. That is, a PID-18 - Patient Account Number associated with one PID-3 - Patient Identifier List has been moved to another patient identifier list.
An A44 event is used to signal a move of records identified by the MRG-3 - Prior Patient Account Number from the "incorrect source patient identifier list" identified in the MRG segment (MRG-1 - Prior Patient Identifier List) to the "correct target patient identifier list" identified in the PID segment (PID-3 - Patient Identifier List).
type ADT_A44_Patient ¶
type ADT_A44_Patient struct {
HL7 HL7Name `hl7:",name=ADT_A44_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
MRG *MRG `hl7:"8,required,display=Merge Patient Information"`
}
Patient
type ADT_A45 ¶
type ADT_A45 struct {
HL7 HL7Name `hl7:",name=ADT_A45,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MergeInfo []ADT_A45_MergeInfo `hl7:",required,display=Merge Info"`
}
Move Visit Information - Visit Number
A move has been done at the visit identifier level. That is, a PV1-19 - Visit Number or PV1-50 - Alternate Visit ID associated with one account identifier (PID-18 - Patient Account Number) has been moved to another account identifier.
An A45 event is used to signal a move of records identified by the MRG-5 - Prior Visit Number or the MRG-6 - Prior Alternate Visit ID from the "incorrect source account identifier" identified in the MRG segment (MRG-3 - Prior Patient Account Number) to the "correct target account identifier" identified in the PID segment (PID-18 - Patient Account Number).
type ADT_A45_MergeInfo ¶
type ADT_A45_MergeInfo struct {
HL7 HL7Name `hl7:",name=ADT_A45_MergeInfo,type=tg"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
}
MergeInfo
type ADT_A46 ¶
type ADT_A46 struct {
HL7 HL7Name `hl7:",name=ADT_A46,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
MRG *MRG `hl7:"8,required,display=Merge Patient Information"`
}
Change Patient ID
From V2.3.1, Event A46 has been retained for backward compatibility only, corresponding with PID-2 - Patient ID, which is also retained for backward compatibility; event A47 (change patient identifier list) should be used instead. A change has been done at the patient identifier level. That is, a PID-2 - Patient ID has been found to be incorrect and has been changed.
An A46 event is used to signal a change of an incorrectly assigned PID-2 - Patient ID value. The "incorrect source patient ID" value is stored in the MRG segment (MRG-4 - Prior Patient ID) and is to be changed to the "correct target patient ID" value stored in the PID segment (PID-2 - Patient ID).
type ADT_A47 ¶
type ADT_A47 struct {
HL7 HL7Name `hl7:",name=ADT_A47,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ARV []ARV `hl7:"7,display=Access Restrictions"`
MRG *MRG `hl7:"8,required,display=Merge Patient Information"`
}
Change Patient Identifier List
A change has been done at the patient identifier list level. That is, a single PID-3 - patient identifier list value has been found to be incorrect and has been changed.
An A47 event is used to signal a change of an incorrectly assigned PID-3 - Patient Identifier List value. The "incorrect source identifier" value is stored in the MRG segment (MRG-1 - Prior Patient Identifier List) and is to be changed to the "correct target patient ID" value stored in the PID segment (PID-3 - Patient Identifier List).
type ADT_A48 ¶
type ADT_A48 struct {
HL7 HL7Name `hl7:",name=ADT_A48,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
}
Change Alternate Patient ID
From V2.3.1, Event A48 has been retained for backward compatibility only, corresponding with PID-4 - Alternate Patient ID-PID, which is also retained for backward compatibility; event A47 (change patient identifier list) should be used instead. A change has been done at the alternate patient identifier level. That is, a PID-4 - Alternate Patient ID-PID has been found to be incorrect and has been changed.
An A48 event is used to signal a change of an incorrectly assigned alternate patient identifier value. The "incorrect source alternate patient ID" value is stored in the MRG segment (MRG-2 - Prior Alternate Patient ID) and is to be changed to the "correct target alternate patient ID" value stored in the PID segment (PID-4 - Alternate Patient ID-PID).
type ADT_A49 ¶
type ADT_A49 struct {
HL7 HL7Name `hl7:",name=ADT_A49,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
}
Change Patient Account Number
A change has been done at the account identifier level. That is, a PID-18 - patient account number has been found to be incorrect and has been changed.
An A49 event is used to signal a change of an incorrectly assigned account number value. The "incorrect source account number" value is stored in the MRG segment (MRG-3 - Prior Patient Account Number) and is to be changed to the "correct target account number" value stored in the PID segment (PID-18 - Patient Account Number).
type ADT_A50 ¶
type ADT_A50 struct {
HL7 HL7Name `hl7:",name=ADT_A50,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
}
Change Visit Number
A change has been done at the visit identifier level. That is, a PV1-19 - Visit Number has been found to be incorrect and has been changed.
An A50 event is used to signal a change of an incorrectly assigned visit number value. The "incorrect source visit number" value is stored in the MRG segment (MRG-5 - Prior Visit Number) and is to be changed to the "correct target visit number" value stored in the PV1 segment (PV1-19 - Visit Number).
type ADT_A51 ¶
type ADT_A51 struct {
HL7 HL7Name `hl7:",name=ADT_A51,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
MRG *MRG `hl7:"7,required,display=Merge Patient Information"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
}
Change Alternate Visit ID
A change has been done at the alternate visit identifier level. That is, a PV1-50 - Alternate Visit ID has been found to be incorrect and has been changed.
An A51 event is used to signal a change of an incorrectly assigned alternate visit ID value. The "incorrect source alternate visit ID" value is stored in the MRG segment (MRG-6 - Prior Alternate Visit ID) and is to be changed to the "correct target alternate visit ID" value stored in the PV1 segment (PV1-50 - Alternate Visit ID).
type ADT_A52 ¶
type ADT_A52 struct {
HL7 HL7Name `hl7:",name=ADT_A52,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Cancel Leave of Absence for a Patient
The A52 event is sent when an A21 (patient goes on "leave of absence") event is cancelled, either because of erroneous entry of the A21 event or because of a decision not to put the patient on "leave of absence" after all.
type ADT_A53 ¶
type ADT_A53 struct {
HL7 HL7Name `hl7:",name=ADT_A53,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Cancel Patient Returns from a Leave of Absence
The A53 event is sent when an A22 (patient returns from "leave of absence") event is cancelled, either because of erroneous entry of the A22 event or because of a decision not to return the patient from "leave of absence" after all.
type ADT_A54 ¶
type ADT_A54 struct {
HL7 HL7Name `hl7:",name=ADT_A54,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL2 []ROL `hl7:"10,display=Role"`
}
Change Attending Doctor
An A54 event is issued as a result of a change in the attending doctor responsible for the treatment of a patient.
type ADT_A55 ¶
type ADT_A55 struct {
HL7 HL7Name `hl7:",name=ADT_A55,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL2 []ROL `hl7:"10,display=Role"`
}
Cancel Change Attending Doctor
The A55 event is sent when an A54 (change attending doctor) event is cancelled, either because of erroneous entry of the A54 event or because of a decision not to change the attending doctor after all. PV1-7 - Attending Doctor must contain the patient's doctor prior to the change of attending doctor.
type ADT_A60 ¶
type ADT_A60 struct {
HL7 HL7Name `hl7:",name=ADT_A60,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
ARV []ARV `hl7:"6,display=Access Restrictions"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
ARV2 []ARV `hl7:"9,display=Access Restrictions"`
IAM []IAM `hl7:"10,display=Patient Adverse Reaction Information"`
}
Update Adverse Reaction Information
This trigger event is used when person/patient allergy information has changed. It is used in conjunction with a new allergy segment, the IAM - Patient Allergy Information Segment-Unique Identifier, which supports Action code/unique identifier mode update for repeating segments as defined in 2.10.4, "Protocol for interpreting repeating segments or segment groups in an update Message."
type ADT_A61 ¶
type ADT_A61 struct {
HL7 HL7Name `hl7:",name=ADT_A61,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
ROL2 []ROL `hl7:"9,display=Role"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Change Consulting Doctor
An A61 event is used as a result of a change in the consulting physician(s) for the treatment of a patient.
type ADT_A62 ¶
type ADT_A62 struct {
HL7 HL7Name `hl7:",name=ADT_A62,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
ROL2 []ROL `hl7:"9,display=Role"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Cancel Change Consulting Doctor
The A62 event is sent when an A61 (change consulting doctor) event is cancelled, either because of erroneous entry of the A61 event or because of a decision not to change the consulting physician(s) after all. PV1-9 - Consulting Doctor must show the patient's doctor prior to the change being cancelled.
type AFF ¶
type AFF struct {
HL7 HL7Name `hl7:",name=AFF,type=s"`
SetID SI `hl7:"1,seq,required,len=60,display=Set ID - AFF"`
ProfessionalOrganization XON `hl7:"2,required,len=250,display=Professional Organization"`
ProfessionalOrganizationAddress *XAD `hl7:"3,len=250,display=Professional Organization Address"`
ProfessionalOrganizationAffiliationDateRange []DR `hl7:"4,len=52,display=Professional Organization Affiliation Date Range"`
ProfessionalAffiliationAdditionalInformation ST `hl7:"5,len=60,display=Professional Affiliation Additional Information"`
}
Professional Affiliation
The AFF segment adds detailed information regarding professional affiliations with which the staff member identified by the STF segment is/was associated.
type AIG ¶
type AIG struct {
HL7 HL7Name `hl7:",name=AIG,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - AIG"`
SegmentActionCode ID `hl7:"2,conditional,len=3,table=0206,display=Segment Action Code"`
ResourceID *CWE `hl7:"3,conditional,len=250,display=Resource ID"`
ResourceType CWE `hl7:"4,required,len=250,display=Resource Type"`
ResourceGroup []CWE `hl7:"5,len=250,display=Resource Group"`
ResourceQuantity NM `hl7:"6,len=5,display=Resource Quantity"`
ResourceQuantityUnits *CNE `hl7:"7,len=250,display=Resource Quantity Units"`
StartDateTime DTM `hl7:"8,conditional,len=24,format=YMDHM,display=Start Date/Time"`
StartDateTimeOffset NM `hl7:"9,conditional,len=20,display=Start Date/Time Offset"`
StartDateTimeOffsetUnits *CNE `hl7:"10,conditional,len=250,display=Start Date/Time Offset Units"`
Duration NM `hl7:"11,len=20,display=Duration"`
DurationUnits *CNE `hl7:"12,len=250,display=Duration Units"`
AllowSubstitutionCode IS `hl7:"13,conditional,len=10,table=0279,display=Allow Substitution Code"`
FillerStatusCode *CWE `hl7:"14,conditional,len=250,table=0278,display=Filler Status Code"`
}
Appointment Information - General Resource
The AIG segment contains information about various kinds of resources (other than those with specifically defined segments in this chapter) that can be scheduled. Resources included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not identified on a schedule request using this segment. Resources described by this segment are general kinds of resources, such as equipment, that are identified with a simple identification code.
type AIL ¶
type AIL struct {
HL7 HL7Name `hl7:",name=AIL,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - AIL"`
SegmentActionCode ID `hl7:"2,conditional,len=3,table=0206,display=Segment Action Code"`
LocationResourceID []PL `hl7:"3,conditional,len=80,display=Location Resource ID"`
LocationType *CWE `hl7:"4,conditional,len=250,table=0305,display=Location Type-AIL"`
LocationGroup *CWE `hl7:"5,len=250,display=Location Group"`
StartDateTime DTM `hl7:"6,conditional,len=24,format=YMDHM,display=Start Date/Time"`
StartDateTimeOffset NM `hl7:"7,conditional,len=20,display=Start Date/Time Offset"`
StartDateTimeOffsetUnits *CNE `hl7:"8,conditional,len=250,display=Start Date/Time Offset Units"`
Duration NM `hl7:"9,len=20,display=Duration"`
DurationUnits *CNE `hl7:"10,len=250,display=Duration Units"`
AllowSubstitutionCode IS `hl7:"11,conditional,len=10,table=0279,display=Allow Substitution Code"`
FillerStatusCode *CWE `hl7:"12,conditional,len=250,table=0278,display=Filler Status Code"`
}
Appointment Information - Location Resource
The AIL segment contains information about location resources (meeting rooms, operating rooms, examination rooms, or other locations) that can be scheduled. Resources included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not identified on a schedule request using this segment. Location resources are identified with this specific segment because of the specific encoding of locations used by the HL7 specification.
type AIP ¶
type AIP struct {
HL7 HL7Name `hl7:",name=AIP,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - AIP"`
SegmentActionCode ID `hl7:"2,conditional,len=3,table=0206,display=Segment Action Code"`
PersonnelResourceID []XCN `hl7:"3,conditional,len=250,display=Personnel Resource ID"`
ResourceType *CWE `hl7:"4,conditional,len=250,table=0182,display=Resource Type"`
ResourceGroup *CWE `hl7:"5,len=250,display=Resource Group"`
StartDateTime DTM `hl7:"6,conditional,len=24,format=YMDHM,display=Start Date/Time"`
StartDateTimeOffset NM `hl7:"7,conditional,len=20,display=Start Date/Time Offset"`
StartDateTimeOffsetUnits *CNE `hl7:"8,conditional,len=250,display=Start Date/Time Offset Units"`
Duration NM `hl7:"9,len=20,display=Duration"`
DurationUnits *CNE `hl7:"10,len=250,display=Duration Units"`
AllowSubstitutionCode IS `hl7:"11,conditional,len=10,table=0279,display=Allow Substitution Code"`
FillerStatusCode *CWE `hl7:"12,conditional,len=250,table=0278,display=Filler Status Code"`
}
Appointment Information - Personnel Resource
The AIP segment contains information about the personnel types that can be scheduled. Personnel included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Personnel not controlled by a schedule are not identified on a schedule request using this segment. The kinds of personnel described on this segment include any healthcare provider in the institution controlled by a schedule (for example: technicians, physicians, nurses, surgeons, anesthesiologists, or CRNAs).
type AIS ¶
type AIS struct {
HL7 HL7Name `hl7:",name=AIS,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - AIS"`
SegmentActionCode ID `hl7:"2,conditional,len=3,table=0206,display=Segment Action Code"`
UniversalServiceIdentifier CWE `hl7:"3,required,len=705,display=Universal Service Identifier"`
StartDateTime DTM `hl7:"4,conditional,len=24,format=YMDHM,display=Start Date/Time"`
StartDateTimeOffset NM `hl7:"5,conditional,len=20,display=Start Date/Time Offset"`
StartDateTimeOffsetUnits *CNE `hl7:"6,conditional,len=250,display=Start Date/Time Offset Units"`
Duration NM `hl7:"7,len=20,display=Duration"`
DurationUnits *CNE `hl7:"8,len=250,display=Duration Units"`
AllowSubstitutionCode IS `hl7:"9,conditional,len=10,table=0279,display=Allow Substitution Code"`
FillerStatusCode *CWE `hl7:"10,conditional,len=250,table=0278,display=Filler Status Code"`
PlacerSupplementalServiceInformation []CWE `hl7:"11,len=705,table=0411,display=Placer Supplemental Service Information"`
FillerSupplementalServiceInformation []CWE `hl7:"12,len=705,table=0411,display=Filler Supplemental Service Information"`
}
Appointment Information
The AIS segment contains information about various kinds of services that can be scheduled. Services included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Services not controlled by a schedule are not identified on a schedule request using this segment.
type AL1 ¶
type AL1 struct {
HL7 HL7Name `hl7:",name=AL1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - AL1"`
AllergenTypeCode *CWE `hl7:"2,len=705,table=0127,display=Allergen Type Code"`
AllergenCodeMnemonicDescription CWE `hl7:"3,required,len=705,display=Allergen Code/Mnemonic/Description"`
AllergySeverityCode *CWE `hl7:"4,len=705,table=0128,display=Allergy Severity Code"`
AllergyReactionCode []ST `hl7:"5,len=15,display=Allergy Reaction Code"`
IdentificationDate DT `hl7:"6,len=8,format=YMD,display=Identification Date"`
}
Patient Allergy Information
The AL1 segment contains patient allergy information of various types. Most of this information will be derived from user-defined tables. Each AL1 segment describes a single patient allergy.
type APR ¶
type APR struct {
HL7 HL7Name `hl7:",name=APR,type=s"`
TimeSelectionCriteria []SCV `hl7:"1,len=80,display=Time Selection Criteria"`
ResourceSelectionCriteria []SCV `hl7:"2,len=80,display=Resource Selection Criteria"`
LocationSelectionCriteria []SCV `hl7:"3,len=80,display=Location Selection Criteria"`
SlotSpacingCriteria NM `hl7:"4,len=5,display=Slot Spacing Criteria"`
FillerOverrideCriteria []SCV `hl7:"5,len=80,display=Filler Override Criteria"`
}
Appointment Preferences
The APR segment contains parameters and preference specifications used for requesting appointments in the SRM message. It allows placer applications to provide coded parameters and preference indicators to the filler application, to help determine when a requested appointment should be scheduled. An APR segment can be provided in conjunction with either the ARQ segment or any of the service and resource segments (AIG, AIS, AIP, and AIL). If an APR segment appears in conjunction with an ARQ segment, its parameters and preference indicators pertain to the schedule request as a whole. If the APR segment appears with any of the service and resource segments, then its parameters and preferences apply only to the immediately preceding service or resource.
type ARQ ¶
type ARQ struct {
HL7 HL7Name `hl7:",name=ARQ,type=s"`
PlacerAppointmentID EI `hl7:"1,required,len=75,display=Placer Appointment ID"`
FillerAppointmentID *EI `hl7:"2,conditional,len=75,display=Filler Appointment ID"`
OccurrenceNumber NM `hl7:"3,conditional,len=5,display=Occurrence Number"`
PlacerGroupNumber *EI `hl7:"4,len=22,display=Placer Group Number"`
ScheduleID *CWE `hl7:"5,len=250,display=Schedule ID"`
RequestEventReason *CWE `hl7:"6,len=250,display=Request Event Reason"`
AppointmentReason *CWE `hl7:"7,len=250,table=0276,display=Appointment Reason"`
AppointmentType *CWE `hl7:"8,len=250,table=0277,display=Appointment Type"`
AppointmentDuration NM `hl7:"9,len=20,display=Appointment Duration"`
AppointmentDurationUnits *CNE `hl7:"10,len=250,display=Appointment Duration Units"`
RequestedStartDateTimeRange []DR `hl7:"11,len=49,display=Requested Start Date/Time Range"`
Priority ST `hl7:"12,len=5,display=Priority-ARQ"`
RepeatingInterval *RI `hl7:"13,len=100,display=Repeating Interval"`
RepeatingIntervalDuration ST `hl7:"14,len=5,display=Repeating Interval Duration"`
PlacerContactPerson []XCN `hl7:"15,required,len=250,display=Placer Contact Person"`
PlacerContactPhoneNumber []XTN `hl7:"16,len=250,display=Placer Contact Phone Number"`
PlacerContactAddress []XAD `hl7:"17,len=250,display=Placer Contact Address"`
PlacerContactLocation *PL `hl7:"18,len=80,display=Placer Contact Location"`
EnteredByPerson []XCN `hl7:"19,required,len=250,display=Entered By Person"`
EnteredByPhoneNumber []XTN `hl7:"20,len=250,display=Entered By Phone Number"`
EnteredByLocation *PL `hl7:"21,len=80,display=Entered By Location"`
ParentPlacerAppointmentID *EI `hl7:"22,len=75,display=Parent Placer Appointment ID"`
ParentFillerAppointmentID *EI `hl7:"23,len=75,display=Parent Filler Appointment ID"`
PlacerOrderNumber []EI `hl7:"24,conditional,len=427,display=Placer Order Number"`
FillerOrderNumber []EI `hl7:"25,conditional,len=427,display=Filler Order Number"`
}
Appointment Request
The ARQ segment defines a request for the booking of an appointment. It is used in transactions sent from an application acting in the role of a placer.
type ARV ¶
type ARV struct {
HL7 HL7Name `hl7:",name=ARV,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID"`
AccessRestrictionActionCode CNE `hl7:"2,required,len=705,table=0206,display=Access Restriction Action Code"`
AccessRestrictionValue CWE `hl7:"3,required,len=705,table=0717,display=Access Restriction Value"`
AccessRestrictionReason []CWE `hl7:"4,len=705,table=0719,display=Access Restriction Reason"`
SpecialAccessRestrictionInstructions []ST `hl7:"5,len=250,display=Special Access Restriction Instructions"`
AccessRestrictionDateRange *DR `hl7:"6,len=49,display=Access Restriction Date Range"`
}
Access Restrictions
The ARV segment is used to communicate the requested/required type of access restrictions from system to system, at both the person/patient and the encounter/visit level.
type AUI ¶
type AUI struct {
HL7 HL7Name `hl7:",name=AUI,len=239,type=d"`
AuthorizationNumber ST `hl7:"1,len=30,display=Identifier assigned to the authorization."`
Date DT `hl7:"2,len=8,format=YMD,display=Date of authorization."`
Source ST `hl7:"3,len=199,display=Source of authorization."`
}
Authorization Information
This data type specifies the identifier or code for an insurance authorization instance and its associated detail.
type AUT ¶
type AUT struct {
HL7 HL7Name `hl7:",name=AUT,type=s"`
AuthorizingPayorPlanID *CWE `hl7:"1,len=250,table=0072,display=Authorizing Payor- Plan ID"`
AuthorizingPayorCompanyID CWE `hl7:"2,required,len=250,table=0285,display=Authorizing Payor- Company ID"`
AuthorizingPayorCompanyName ST `hl7:"3,len=45,display=Authorizing Payor- Company Name"`
AuthorizationEffectiveDate DTM `hl7:"4,len=24,format=YMDHM,display=Authorization Effective Date"`
AuthorizationExpirationDate DTM `hl7:"5,len=24,format=YMDHM,display=Authorization Expiration Date"`
AuthorizationIdentifier *EI `hl7:"6,conditional,len=30,display=Authorization Identifier"`
ReimbursementLimit *CP `hl7:"7,len=25,display=Reimbursement Limit"`
RequestedNumberOfTreatments NM `hl7:"8,len=2,display=Requested Number of Treatments"`
AuthorizedNumberOfTreatments NM `hl7:"9,len=2,display=Authorized Number of Treatments"`
ProcessDate DTM `hl7:"10,len=24,format=YMDHM,display=Process Date"`
}
Authorization Information
This segment represents an authorization or a pre-authorization for a referred procedure or requested service by the payor covering the patient's health care.
type BAR_P01 ¶
type BAR_P01 struct {
HL7 HL7Name `hl7:",name=BAR_P01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
Visit []BAR_P01_Visit `hl7:",required,display=Visit"`
}
Add Patient Account
Data are sent from some application (usually a Registration or an ADT system, for example) to the patient accounting or financial system to establish an account for a patient’s billing/accounts receivable record. Many of the segments associated with this event are optional.
From Standard Version 2.3 onward, the P01 event should only be used to add a new account that did not exist before, not to update an existing account. The new P05 (update account) event should be used to update an existing account. The new P06 (end account) event should be used to close an account. With the P01 event, EVN-2 - Recorded Date/Time should contain the account start date.
type BAR_P01_Insurance ¶
type BAR_P01_Insurance struct {
HL7 HL7Name `hl7:",name=BAR_P01_Insurance,type=tg"`
IN1 *IN1 `hl7:"20,required,display=Insurance"`
IN2 *IN2 `hl7:"21,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"22,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"23,display=Role"`
}
Insurance
type BAR_P01_Procedure ¶
type BAR_P01_Procedure struct {
HL7 HL7Name `hl7:",name=BAR_P01_Procedure,type=tg"`
PR1 *PR1 `hl7:"16,required,display=Procedures"`
ROL []ROL `hl7:"17,display=Role"`
}
Procedure
type BAR_P01_Visit ¶
type BAR_P01_Visit struct {
HL7 HL7Name `hl7:",name=BAR_P01_Visit,type=tg"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL []ROL `hl7:"10,display=Role"`
DB1 []DB1 `hl7:"11,display=Disability"`
OBX []OBX `hl7:"12,display=Observation/Result"`
AL1 []AL1 `hl7:"13,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"14,display=Diagnosis"`
DRG *DRG `hl7:"15,display=Diagnosis Related Group"`
Procedure []BAR_P01_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"18,display=Guarantor"`
NK1 []NK1 `hl7:"19,display=Next of Kin / Associated Parties"`
Insurance []BAR_P01_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"24,display=Accident"`
UB1 *UB1 `hl7:"25,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"26,display=UB92 Data"`
}
Visit
type BAR_P02 ¶
type BAR_P02 struct {
HL7 HL7Name `hl7:",name=BAR_P02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []BAR_P02_Patient `hl7:",required,display=Patient"`
}
Purge Patient Accounts
Generally, the elimination of all billing/accounts receivable records will be an internal function controlled, for example, by the patient accounting or financial system. However, on occasion, there will be a need to correct an account, or a series of accounts, that may require that a notice of account deletion be sent from another sub-system and processed, for example, by the patient accounting or financial system. Although a series of accounts may be purged within this one event, we recommend that only one PID segment be sent per event.
type BAR_P02_Patient ¶
type BAR_P02_Patient struct {
HL7 HL7Name `hl7:",name=BAR_P02_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
DB1 []DB1 `hl7:"8,display=Disability"`
}
Patient
type BAR_P05 ¶
type BAR_P05 struct {
HL7 HL7Name `hl7:",name=BAR_P05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
Visit []BAR_P05_Visit `hl7:",required,display=Visit"`
}
Update Account
The P05 event is sent when an existing account is being updated. From version 2.3 onward, the P01 (add account) event should no longer be used for updating an existing account, but only for creating a new account. With the addition of P10 (transmit ambulatory payment classification [APC] groups) in version 2.4, it is expected that the P05 (update account) will be used to send inpatient coding information and the P10 (transmit ambulatory payment classification [APC] groups) will be used to send outpatient coding information.
type BAR_P05_Insurance ¶
type BAR_P05_Insurance struct {
HL7 HL7Name `hl7:",name=BAR_P05_Insurance,type=tg"`
IN1 *IN1 `hl7:"20,required,display=Insurance"`
IN2 *IN2 `hl7:"21,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"22,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"23,display=Role"`
}
Insurance
type BAR_P05_Procedure ¶
type BAR_P05_Procedure struct {
HL7 HL7Name `hl7:",name=BAR_P05_Procedure,type=tg"`
PR1 *PR1 `hl7:"16,required,display=Procedures"`
ROL []ROL `hl7:"17,display=Role"`
}
Procedure
type BAR_P05_Visit ¶
type BAR_P05_Visit struct {
HL7 HL7Name `hl7:",name=BAR_P05_Visit,type=tg"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL []ROL `hl7:"10,display=Role"`
DB1 []DB1 `hl7:"11,display=Disability"`
OBX []OBX `hl7:"12,display=Observation/Result"`
AL1 []AL1 `hl7:"13,display=Patient Allergy Information"`
DG1 []DG1 `hl7:"14,display=Diagnosis"`
DRG *DRG `hl7:"15,display=Diagnosis Related Group"`
Procedure []BAR_P05_Procedure `hl7:",display=Procedure"`
GT1 []GT1 `hl7:"18,display=Guarantor"`
NK1 []NK1 `hl7:"19,display=Next of Kin / Associated Parties"`
Insurance []BAR_P05_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"24,display=Accident"`
UB1 *UB1 `hl7:"25,display=Uniform Billing 1"`
UB2 *UB2 `hl7:"26,display=UB92 Data"`
ABS *ABS `hl7:"27,display=Abstract"`
BLC []BLC `hl7:"28,display=Blood Code"`
RMI *RMI `hl7:"29,display=Risk Management Incident"`
}
Visit
type BAR_P06 ¶
type BAR_P06 struct {
HL7 HL7Name `hl7:",name=BAR_P06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
Patient []BAR_P06_Patient `hl7:",required,display=Patient"`
}
End Account
The P06 event is a notification that the account is no longer open, that is, no new charges can accrue to this account. This notification is not related to whether or not the account is paid in full. EVN-2 - Recorded Date/Time must contain the account end date.
type BAR_P06_Patient ¶
type BAR_P06_Patient struct {
HL7 HL7Name `hl7:",name=BAR_P06_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
}
Patient
type BAR_P10 ¶
type BAR_P10 struct {
HL7 HL7Name `hl7:",name=BAR_P10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
DG1 []DG1 `hl7:"7,display=Diagnosis"`
GP1 *GP1 `hl7:"8,required,display=Grouping/Reimbursement - Visit"`
Procedure []BAR_P10_Procedure `hl7:",display=Procedure"`
}
Transmit Ambulatory Payment Classification (APC)
The P10 event is used to communicate Ambulatory Payment Classification (APC) grouping. The grouping can be estimated or actual, based on the APC status indictor in GP1-1. This information is mandated in the USA by the Centers for Medicare and Medicaid Services (CMS) for reimbursement of outpatient services. The PID and PV1 segments are included for identification purposes only. When other patient or visit related fields change, use the A08 (update patient information) event.
type BAR_P10_Procedure ¶
type BAR_P10_Procedure struct {
HL7 HL7Name `hl7:",name=BAR_P10_Procedure,type=tg"`
PR1 *PR1 `hl7:"9,required,display=Procedures"`
GP2 *GP2 `hl7:"10,display=Grouping/Reimbursement - Procedure Line Item"`
}
Procedure
type BAR_P12 ¶
type BAR_P12 struct {
HL7 HL7Name `hl7:",name=BAR_P12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
DG1 []DG1 `hl7:"7,display=Diagnosis"`
DRG *DRG `hl7:"8,display=Diagnosis Related Group"`
Procedure []BAR_P12_Procedure `hl7:",display=Procedure"`
}
Update Diagnosis/Procedure
The P12 event is used to communicate diagnosis and/or procedures in update mode. The newly created fields in DG1 and PR1, i.e., identifiers and action codes, must be populated to indicate which change should be applied. When other patient or visit related fields change, use the A08 (update patient information) event.
type BAR_P12_Procedure ¶
type BAR_P12_Procedure struct {
HL7 HL7Name `hl7:",name=BAR_P12_Procedure,type=tg"`
PR1 *PR1 `hl7:"9,required,display=Procedures"`
ROL []ROL `hl7:"10,display=Role"`
}
Procedure
type BHS ¶
type BHS struct {
HL7 HL7Name `hl7:",name=BHS,type=s"`
BatchFieldSeparator ST `hl7:"1,required,len=1,display=Batch Field Separator"`
BatchEncodingCharacters ST `hl7:"2,required,len=4,display=Batch Encoding Characters"`
BatchSendingApplication *HD `hl7:"3,len=227,display=Batch Sending Application"`
BatchSendingFacility *HD `hl7:"4,len=227,display=Batch Sending Facility"`
BatchReceivingApplication *HD `hl7:"5,len=227,display=Batch Receiving Application"`
BatchReceivingFacility *HD `hl7:"6,len=227,display=Batch Receiving Facility"`
BatchCreationDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Batch Creation Date/Time"`
BatchSecurity ST `hl7:"8,len=40,display=Batch Security"`
BatchNameIDType ST `hl7:"9,len=20,display=Batch Name/ID/Type"`
BatchComment ST `hl7:"10,len=80,display=Batch Comment"`
BatchControlID ST `hl7:"11,len=20,display=Batch Control ID"`
ReferenceBatchControlID ST `hl7:"12,len=20,display=Reference Batch Control ID"`
BatchSendingNetworkAddress *HD `hl7:"13,len=227,display=Batch Sending Network Address"`
BatchReceivingNetworkAddress *HD `hl7:"14,len=227,display=Batch Receiving Network Address"`
}
Batch Header
The BHS segment defines the start of a batch.
type BLC ¶
type BLC struct {
HL7 HL7Name `hl7:",name=BLC,type=s"`
BloodProductCode *CWE `hl7:"1,len=250,table=0426,display=Blood Product Code"`
BloodAmount *CQ `hl7:"2,len=267,display=Blood Amount"`
}
Blood Code
The BLC segment contains data necessary to communicate patient abstract blood information used for billing and reimbursement purposes. This segment is repeating to report blood product codes and the associated blood units.
type BLG ¶
type BLG struct {
HL7 HL7Name `hl7:",name=BLG,type=s"`
WhenToCharge *CCD `hl7:"1,len=40,display=When to Charge"`
ChargeType ID `hl7:"2,len=50,table=0122,display=Charge Type"`
AccountID *CX `hl7:"3,len=100,display=Account ID"`
ChargeTypeReason *CWE `hl7:"4,len=60,table=0475,display=Charge Type Reason"`
}
Billing
The BLG segment is used to provide billing information, on the ordered service, to the filling application.
type BPO ¶
type BPO struct {
HL7 HL7Name `hl7:",name=BPO,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID – BPO"`
BPUniversalServiceIdentifier CWE `hl7:"2,required,len=250,display=BP Universal Service Identifier"`
BPProcessingRequirements []CWE `hl7:"3,len=250,table=0508,display=BP Processing Requirements"`
BPQuantity NM `hl7:"4,required,len=5,display=BP Quantity"`
BPAmount NM `hl7:"5,len=5,display=BP Amount"`
BPUnits *CWE `hl7:"6,len=250,display=BP Units"`
BPIntendedUseDateTime DTM `hl7:"7,len=24,format=YMDHM,display=BP Intended Use Date/Time"`
BPIntendedDispenseFromLocation *PL `hl7:"8,len=80,display=BP Intended Dispense From Location"`
BPIntendedDispenseFromAddress *XAD `hl7:"9,len=250,display=BP Intended Dispense From Address"`
BPRequestedDispenseDateTime DTM `hl7:"10,len=24,format=YMDHM,display=BP Requested Dispense Date/Time"`
BPRequestedDispenseToLocation *PL `hl7:"11,len=80,display=BP Requested Dispense To Location"`
BPRequestedDispenseToAddress *XAD `hl7:"12,len=250,display=BP Requested Dispense To Address"`
BPIndicationForUse []CWE `hl7:"13,len=250,table=0509,display=BP Indication for Use"`
BPInformedConsentIndicator ID `hl7:"14,len=1,table=0136,display=BP Informed Consent Indicator"`
}
Blood product order
Blood product order messages require additional information that is not available in other standard HL7 order messages. Blood product order messages need to contain accompanying details regarding the blood product component, such as special processing requirements (e.g., irradiation and leukoreduction) and the amount of the blood product to be administered.
type BPS_O29 ¶
type BPS_O29 struct {
HL7 HL7Name `hl7:",name=BPS_O29,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *BPS_O29_Patient `hl7:",display=Patient"`
Order []BPS_O29_Order `hl7:",required,display=Order"`
}
Blood Product Dispense Status
In the pre-transfusion processing of blood products, it is necessary for the transfusion service and the placer system to communicate information that is not included in the current HL7 order/observation model. Examples of pre-transfusion processing include performing a crossmatch test to ensure compatibility with the patient, or irradiation of the blood product due to a special transfusion requirement for the patient. The blood product dispense status messages need to contain additional information regarding the blood products requested, such as the Donation ID, product code, blood type, expiration date/time and current status of the blood product.
In the processing of commercial blood products, such as Rh Immune Globulin, Factor Concentrate, or Albumin Products, the status messages need to contain additional information, such as the lot number and manufacturer, expiration date and status of the commercial product.
Blood product dispense status messages use the BPS and BRP messages as described below
type BPS_O29_Order ¶
type BPS_O29_Order struct {
HL7 HL7Name `hl7:",name=BPS_O29_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Timing []BPS_O29_Timing `hl7:",display=Timing"`
BPO *BPO `hl7:"13,required,display=Blood product order"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
Product []BPS_O29_Product `hl7:",display=Product"`
}
Order
type BPS_O29_Patient ¶
type BPS_O29_Patient struct {
HL7 HL7Name `hl7:",name=BPS_O29_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *BPS_O29_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type BPS_O29_PatientVisit ¶
type BPS_O29_PatientVisit struct {
HL7 HL7Name `hl7:",name=BPS_O29_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type BPS_O29_Product ¶
type BPS_O29_Product struct {
HL7 HL7Name `hl7:",name=BPS_O29_Product,type=tg"`
BPX *BPX `hl7:"15,required,display=Blood product dispense status"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Product
type BPS_O29_Timing ¶
type BPS_O29_Timing struct {
HL7 HL7Name `hl7:",name=BPS_O29_Timing,type=tg"`
TQ1 *TQ1 `hl7:"11,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"12,display=Timing/Quantity Relationship"`
}
Timing
type BPX ¶
type BPX struct {
HL7 HL7Name `hl7:",name=BPX,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID – BPX"`
BPDispenseStatus CWE `hl7:"2,required,len=250,table=0510,display=BP Dispense Status"`
BPStatus ID `hl7:"3,required,len=1,table=0511,display=BP Status"`
BPDateTimeOfStatus DTM `hl7:"4,required,len=24,format=YMDHM,display=BP Date/Time of Status"`
BCDonationID *EI `hl7:"5,conditional,len=22,display=BC Donation ID"`
BCComponent *CNE `hl7:"6,conditional,len=250,display=BC Component"`
BCDonationTypeIntendedUse *CNE `hl7:"7,len=250,display=BC Donation Type / Intended Use"`
CPCommercialProduct *CWE `hl7:"8,conditional,len=250,table=0512,display=CP Commercial Product"`
CPManufacturer *XON `hl7:"9,conditional,len=250,display=CP Manufacturer"`
CPLotNumber *EI `hl7:"10,conditional,len=22,display=CP Lot Number"`
BPBloodGroup *CNE `hl7:"11,len=250,display=BP Blood Group"`
BCSpecialTesting []CNE `hl7:"12,len=250,display=BC Special Testing"`
BPExpirationDateTime DTM `hl7:"13,len=24,format=YMDHM,display=BP Expiration Date/Time"`
BPQuantity NM `hl7:"14,required,len=5,display=BP Quantity"`
BPAmount NM `hl7:"15,len=5,display=BP Amount"`
BPUnits *CWE `hl7:"16,len=250,display=BP Units"`
BPUniqueID *EI `hl7:"17,len=22,display=BP Unique ID"`
BPActualDispensedToLocation *PL `hl7:"18,len=80,display=BP Actual Dispensed To Location"`
BPActualDispensedToAddress *XAD `hl7:"19,len=250,display=BP Actual Dispensed To Address"`
BPDispensedToReceiver *XCN `hl7:"20,len=250,display=BP Dispensed to Receiver"`
BPDispensingIndividual *XCN `hl7:"21,len=250,display=BP Dispensing Individual"`
}
Blood product dispense status
In the processing of blood products, it is necessary for the transfusion service and the placer system to communicate information. The status messages need to contain additional information regarding the blood products requested, such as the unique donation ID, product code, blood type, expiration date/time of the blood product, and current status of the product. This segment is similar to an OBX segment, but contains additional attributes.
type BRP_O30 ¶
type BRP_O30 struct {
HL7 HL7Name `hl7:",name=BRP_O30,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *BRP_O30_Response `hl7:",display=Response"`
}
Blood Product Dispense Status Acknowledgment
In the pre-transfusion processing of blood products, it is necessary for the transfusion service and the placer system to communicate information that is not included in the current HL7 order/observation model. Examples of pre-transfusion processing include performing a crossmatch test to ensure compatibility with the patient, or irradiation of the blood product due to a special transfusion requirement for the patient. The blood product dispense status messages need to contain additional information regarding the blood products requested, such as the Donation ID, product code, blood type, expiration date/time and current status of the blood product.
In the processing of commercial blood products, such as Rh Immune Globulin, Factor Concentrate, or Albumin Products, the status messages need to contain additional information, such as the lot number and manufacturer, expiration date and status of the commercial product.
Blood product dispense status messages use the BPS and BRP messages as described below
type BRP_O30_Order ¶
type BRP_O30_Order struct {
HL7 HL7Name `hl7:",name=BRP_O30_Order,type=tg"`
ORC *ORC `hl7:"8,required,display=Common Order"`
Timing []BRP_O30_Timing `hl7:",display=Timing"`
BPO *BPO `hl7:"11,display=Blood product order"`
BPX []BPX `hl7:"12,display=Blood product dispense status"`
}
Order
type BRP_O30_Patient ¶
type BRP_O30_Patient struct {
HL7 HL7Name `hl7:",name=BRP_O30_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
Order []BRP_O30_Order `hl7:",display=Order"`
}
Patient
type BRP_O30_Response ¶
type BRP_O30_Response struct {
HL7 HL7Name `hl7:",name=BRP_O30_Response,type=tg"`
Patient *BRP_O30_Patient `hl7:",display=Patient"`
}
Response
type BRP_O30_Timing ¶
type BRP_O30_Timing struct {
HL7 HL7Name `hl7:",name=BRP_O30_Timing,type=tg"`
TQ1 *TQ1 `hl7:"9,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"10,display=Timing/Quantity Relationship"`
}
Timing
type BRT_O32 ¶
type BRT_O32 struct {
HL7 HL7Name `hl7:",name=BRT_O32,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *BRT_O32_Response `hl7:",display=Response"`
}
Blood Product Transfusion/Disposition Acknowledgment
Blood product transfusion/disposition messages use the BTS and BRT messages.
type BRT_O32_Order ¶
type BRT_O32_Order struct {
HL7 HL7Name `hl7:",name=BRT_O32_Order,type=tg"`
ORC *ORC `hl7:"8,required,display=Common Order"`
Timing []BRT_O32_Timing `hl7:",display=Timing"`
BPO *BPO `hl7:"11,display=Blood product order"`
BTX []BTX `hl7:"12,display=Blood Product Transfusion/Disposition"`
}
Order
type BRT_O32_Response ¶
type BRT_O32_Response struct {
HL7 HL7Name `hl7:",name=BRT_O32_Response,type=tg"`
PID *PID `hl7:"7,display=Patient Identification"`
Order []BRT_O32_Order `hl7:",display=Order"`
}
Response
type BRT_O32_Timing ¶
type BRT_O32_Timing struct {
HL7 HL7Name `hl7:",name=BRT_O32_Timing,type=tg"`
TQ1 *TQ1 `hl7:"9,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"10,display=Timing/Quantity Relationship"`
}
Timing
type BTS ¶
type BTS struct {
HL7 HL7Name `hl7:",name=BTS,type=s"`
BatchMessageCount ST `hl7:"1,len=10,display=Batch Message Count"`
BatchComment ST `hl7:"2,len=80,display=Batch Comment"`
BatchTotals []NM `hl7:"3,len=100,display=Batch Totals"`
}
Batch Trailer
The BTS segment defines the end of a batch
type BTS_O31 ¶
type BTS_O31 struct {
HL7 HL7Name `hl7:",name=BTS_O31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *BTS_O31_Patient `hl7:",display=Patient"`
Order []BTS_O31_Order `hl7:",required,display=Order"`
}
Blood Product Transfusion/Disposition
Blood product transfusion/disposition messages use the BTS and BRT messages.
type BTS_O31_Order ¶
type BTS_O31_Order struct {
HL7 HL7Name `hl7:",name=BTS_O31_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Timing []BTS_O31_Timing `hl7:",display=Timing"`
BPO *BPO `hl7:"13,required,display=Blood product order"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
ProductStatus []BTS_O31_ProductStatus `hl7:",display=Product Status"`
}
Order
type BTS_O31_Patient ¶
type BTS_O31_Patient struct {
HL7 HL7Name `hl7:",name=BTS_O31_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *BTS_O31_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type BTS_O31_PatientVisit ¶
type BTS_O31_PatientVisit struct {
HL7 HL7Name `hl7:",name=BTS_O31_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type BTS_O31_ProductStatus ¶
type BTS_O31_ProductStatus struct {
HL7 HL7Name `hl7:",name=BTS_O31_ProductStatus,type=tg"`
BTX *BTX `hl7:"15,required,display=Blood Product Transfusion/Disposition"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
ProductStatus
type BTS_O31_Timing ¶
type BTS_O31_Timing struct {
HL7 HL7Name `hl7:",name=BTS_O31_Timing,type=tg"`
TQ1 *TQ1 `hl7:"11,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"12,display=Timing/Quantity Relationship"`
}
Timing
type BTX ¶
type BTX struct {
HL7 HL7Name `hl7:",name=BTX,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID – BTX"`
BCDonationID *EI `hl7:"2,conditional,len=22,display=BC Donation ID"`
BCComponent *CNE `hl7:"3,conditional,len=250,display=BC Component"`
BCBloodGroup *CNE `hl7:"4,conditional,len=250,display=BC Blood Group"`
CPCommercialProduct *CWE `hl7:"5,conditional,len=250,table=0512,display=CP Commercial Product"`
CPManufacturer *XON `hl7:"6,conditional,len=250,display=CP Manufacturer"`
CPLotNumber *EI `hl7:"7,conditional,len=22,display=CP Lot Number"`
BPQuantity NM `hl7:"8,required,len=5,display=BP Quantity"`
BPAmount NM `hl7:"9,len=5,display=BP Amount"`
BPUnits *CWE `hl7:"10,len=250,display=BP Units"`
BPTransfusionDispositionStatus CWE `hl7:"11,required,len=250,table=0513,display=BP Transfusion/Disposition Status"`
BPMessageStatus ID `hl7:"12,required,len=1,table=0511,display=BP Message Status"`
BPDateTimeOfStatus DTM `hl7:"13,required,len=24,format=YMDHM,display=BP Date/Time of Status"`
BPAdministrator *XCN `hl7:"14,len=250,display=BP Administrator"`
BPVerifier *XCN `hl7:"15,len=250,display=BP Verifier"`
BPTransfusionStartDateTimeOfStatus DTM `hl7:"16,len=24,format=YMDHM,display=BP Transfusion Start Date/Time of Status"`
BPTransfusionEndDateTimeOfStatus DTM `hl7:"17,len=24,format=YMDHM,display=BP Transfusion End Date/Time of Status"`
BPAdverseReactionType []CWE `hl7:"18,len=250,table=0514,display=BP Adverse Reaction Type"`
BPTransfusionInterruptedReason *CWE `hl7:"19,len=250,table=0515,display=BP Transfusion Interrupted Reason"`
}
Blood Product Transfusion/Disposition
type CCD ¶
type CCD struct {
HL7 HL7Name `hl7:",name=CCD,len=26,type=d"`
InvocationEvent ID `` /* 181-byte string literal not displayed */
DateTime DTM `` /* 215-byte string literal not displayed */
}
Charge Code and Date
Specifies whether a charge action is based on an invocation event or is time-based.
type CDM ¶
type CDM struct {
HL7 HL7Name `hl7:",name=CDM,type=s"`
PrimaryKeyValue CWE `hl7:"1,required,len=250,table=0132,display=Primary Key Value - CDM"`
ChargeCodeAlias []CWE `hl7:"2,len=250,display=Charge Code Alias"`
ChargeDescriptionShort ST `hl7:"3,required,len=20,display=Charge Description Short"`
ChargeDescriptionLong ST `hl7:"4,len=250,display=Charge Description Long"`
DescriptionOverrideIndicator IS `hl7:"5,len=1,table=0268,display=Description Override Indicator"`
ExplodingCharges []CWE `hl7:"6,len=250,table=0132,display=Exploding Charges"`
ProcedureCode []CWE `hl7:"7,len=705,table=0088,display=Procedure Code"`
ActiveInactiveFlag ID `hl7:"8,len=1,table=0183,display=Active/Inactive Flag"`
InventoryNumber []CWE `hl7:"9,len=250,table=0463,display=Inventory Number"`
ResourceLoad NM `hl7:"10,len=12,display=Resource Load"`
ContractNumber []CX `hl7:"11,len=250,display=Contract Number"`
ContractOrganization []XON `hl7:"12,len=250,display=Contract Organization"`
RoomFeeIndicator ID `hl7:"13,len=1,table=0136,display=Room Fee Indicator"`
}
Charge Description Master
The Technical Steward for the CDM segment is Financial Management.
The CDM segment contains the fields for identifying anything which is charged to patient accounts, including procedures, services, supplies. It is intended to be used to maintain a list of valid chargeable utilization items. Its purpose is to keep billing codes synchronized between HIS, Patient Accounting, and other departmental systems. It is not intended to completely support materials management, inventory, or complex pricing structures for which additional complex fields would be required. Given an identifying charge code, the associated fields in the charge description master file will provide basic pricing and billing data. All the additional information necessary for patient accounting systems to do billing and claims is not intended to be included in this segment; those should be part of insurance or billing profile tables.
type CE ¶
type CE struct {
HL7 HL7Name `hl7:",name=CE,len=0,type=d"`
Identifier ST `hl7:"1,display=Identifier"`
Text ST `hl7:"2,display=Text"`
NameOfCodingSystem ID `hl7:"3,table=0396,display=Name Of Coding System"`
AlternateIdentifier ST `hl7:"4,display=Alternate Identifier"`
AlternateText ST `hl7:"5,display=Alternate Text"`
NameOfAlternateCodingSystem ID `hl7:"6,table=0396,display=Name Of Alternate Coding System"`
}
Coded Element
The CE data type has been replaced by the CWE and CNE data types and the detail was withdrawn and removed from the standard as of v 2.6.
type CER ¶
type CER struct {
HL7 HL7Name `hl7:",name=CER,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID – CER"`
SerialNumber ST `hl7:"2,len=80,display=Serial Number"`
Version ST `hl7:"3,len=80,display=Version"`
GrantingAuthority *XON `hl7:"4,len=250,display=Granting Authority"`
IssuingAuthority *XCN `hl7:"5,len=250,display=Issuing Authority"`
SignatureOfIssuingAuthority *ED `hl7:"6,len=65536,display=Signature of Issuing Authority"`
GrantingCountry ID `hl7:"7,len=3,table=0399,display=Granting Country"`
GrantingStateProvince *CWE `hl7:"8,len=250,table=0347,display=Granting State/Province"`
GrantingCountyParish *CWE `hl7:"9,len=250,table=0289,display=Granting County/Parish"`
CertificateType *CWE `hl7:"10,len=250,display=Certificate Type"`
CertificateDomain *CWE `hl7:"11,len=250,display=Certificate Domain"`
SubjectID ID `hl7:"12,conditional,len=250,display=Subject ID"`
SubjectName ST `hl7:"13,required,len=250,display=Subject Name"`
SubjectDirectoryAttributeExtension []CWE `hl7:"14,len=250,display=Subject Directory Attribute Extension"`
SubjectPublicKeyInfo *CWE `hl7:"15,len=250,display=Subject Public Key Info"`
AuthorityKeyIdentifier *CWE `hl7:"16,len=250,display=Authority Key Identifier"`
BasicConstraint ID `hl7:"17,len=250,table=0136,display=Basic Constraint"`
CRLDistributionPoint []CWE `hl7:"18,len=250,display=CRL Distribution Point"`
JurisdictionCountry ID `hl7:"19,len=3,table=0399,display=Jurisdiction Country"`
JurisdictionStateProvince *CWE `hl7:"20,len=250,table=0347,display=Jurisdiction State/Province"`
JurisdictionCountyParish *CWE `hl7:"21,len=250,table=0289,display=Jurisdiction County/Parish"`
JurisdictionBreadth []CWE `hl7:"22,len=250,table=0547,display=Jurisdiction Breadth"`
GrantingDate DTM `hl7:"23,len=24,format=YMDHM,display=Granting Date"`
IssuingDate DTM `hl7:"24,len=24,format=YMDHM,display=Issuing Date"`
ActivationDate DTM `hl7:"25,len=24,format=YMDHM,display=Activation Date"`
InactivationDate DTM `hl7:"26,len=24,format=YMDHM,display=Inactivation Date"`
ExpirationDate DTM `hl7:"27,len=24,format=YMDHM,display=Expiration Date"`
RenewalDate DTM `hl7:"28,len=24,format=YMDHM,display=Renewal Date"`
RevocationDate DTM `hl7:"29,len=24,format=YMDHM,display=Revocation Date"`
RevocationReasonCode *CWE `hl7:"30,len=250,display=Revocation Reason Code"`
CertificateStatusCode *CWE `hl7:"31,len=250,table=0536,display=Certificate Status Code"`
}
Certificate Detail
The CER segment adds detailed information regarding the formal authorizations to provide a service (e.g. licenses, certificates) held by the health professional identified by the STF segment.
type CM0 ¶
type CM0 struct {
HL7 HL7Name `hl7:",name=CM0,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - CM0"`
SponsorStudyID EI `hl7:"2,required,len=427,display=Sponsor Study ID"`
AlternateStudyID []EI `hl7:"3,max=3,len=427,display=Alternate Study ID"`
TitleOfStudy ST `hl7:"4,required,len=300,display=Title of Study"`
ChairmanOfStudy []XCN `hl7:"5,len=250,display=Chairman of Study"`
LastIRBApprovalDate DT `hl7:"6,len=8,format=YMD,display=Last IRB Approval Date"`
TotalAccrualToDate NM `hl7:"7,len=8,display=Total Accrual to Date"`
LastAccrualDate DT `hl7:"8,len=8,format=YMD,display=Last Accrual Date"`
ContactForStudy []XCN `hl7:"9,len=250,display=Contact for Study"`
ContactsTelephoneNumber *XTN `hl7:"10,len=250,display=Contact's Telephone Number"`
ContactsAddress []XAD `hl7:"11,len=250,display=Contact's Address"`
}
Clinical Study Master
The Technical Steward for the CM0 segment is Orders and Observations.
The Clinical Study Master (CM0) segment contains the information about the study itself. The sending application study number for each patient is sent in the CSR segment. The optional CM0 enables information about the study at the sending application that may be useful to the receiving systems. All of the fields in the segment describe the study status at the sending facility unless otherwise agreed upon.
type CM1 ¶
type CM1 struct {
HL7 HL7Name `hl7:",name=CM1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - CM1"`
StudyPhaseIdentifier CWE `hl7:"2,required,len=705,display=Study Phase Identifier"`
DescriptionOfStudyPhase ST `hl7:"3,required,len=300,display=Description of Study Phase"`
}
Clinical Study Phase Master
The Technical Steward for the CM1 segment is Orders and Observations.
Each Clinical Study Phase Master (CM1) segment contains the information about one phase of a study identified in the preceding CM0. This is an optional structure to be used if the study has more than one treatment or evaluation phase within it. The identification of study phases that the patient enters are sent in the CSP segment: sequence 2. The CM1 segment describes the phase in general for the receiving system.
type CM2 ¶
type CM2 struct {
HL7 HL7Name `hl7:",name=CM2,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - CM2"`
ScheduledTimePoint CWE `hl7:"2,required,len=250,display=Scheduled Time Point"`
DescriptionOfTimePoint ST `hl7:"3,len=300,display=Description of Time Point"`
EventsScheduledThisTimePoint []CWE `hl7:"4,required,max=200,len=250,display=Events Scheduled This Time Point"`
}
Clinical Study Schedule Master
The Technical Steward for the CM2 segment is Orders and Observations.
The Clinical Study Schedule Master (CM2) contains the information about the scheduled time points for study or phase-related treatment or evaluation events. The fact that a patient has data satisfying a scheduled time point is sent in the CSS segment, sequence 2. The CM2 segment describes the scheduled time points in general.
type CNE ¶
type CNE struct {
HL7 HL7Name `hl7:",name=CNE,len=705,type=d"`
Identifier ST `` /* 223-byte string literal not displayed */
Text ST `` /* 233-byte string literal not displayed */
NameOfCodingSystem ID `` /* 300-byte string literal not displayed */
AlternateIdentifier ST `hl7:"4,len=20,display=Analogous to “Identifier” in component 1."`
AlternateText ST `hl7:"5,len=199,display=The descriptive or textual name of the alternate identifier. Analogous to 'Text' in component 2."`
NameOfAlternateCodingSystem ID `` /* 263-byte string literal not displayed */
CodingSystemVersionID ST `` /* 201-byte string literal not displayed */
AlternateCodingSystemVersionID ST `` /* 225-byte string literal not displayed */
OriginalText ST `` /* 132-byte string literal not displayed */
}
Coded with No Exceptions
Specifies a coded element and its associated detail. The CNE data type is used when a required or mandatory coded field is needed. The specified HL7 table or imported or externally defined coding system must be used and may not be extended with local values. Text may not replace the code. A CNE field must have an HL7 defined or external table associated with it. A CNE field may be context sensitive such that a choice of explicit coding systems might be designated. This allows for realm and other types of specificity. Every effort will be made to enumerate the valid coding system(s) to be specified in the 3rd component, however, the standards body realizes that this is impossible to fully enumerate.
type CNN ¶
type CNN struct {
HL7 HL7Name `hl7:",name=CNN,len=406,type=d"`
IDNumber ST `` /* 161-byte string literal not displayed */
FamilyName ST `hl7:"2,len=50,display=This component contains the person's family name in a string format."`
GivenName ST `hl7:"3,len=30,display=Used to specify a first name."`
SecondAndFurtherGivenNamesOrInitialsThereof ST `hl7:"4,len=30,display=Second And Further Given Names Or Initials Thereof"`
Suffix ST `hl7:"5,len=20,display=Used to specify a name suffix (e.g.- Jr. or III)."`
Prefix ST `hl7:"6,len=20,display=Used to specify a name prefix (e.g.- Dr.)."`
Degree IS `` /* 166-byte string literal not displayed */
SourceTable IS `` /* 240-byte string literal not displayed */
AssigningAuthorityNamespaceID IS `` /* 579-byte string literal not displayed */
AssigningAuthorityUniversalID ST `` /* 297-byte string literal not displayed */
AssigningAuthorityUniversalIDType ID `` /* 400-byte string literal not displayed */
}
Composite ID Number and Name Simplified
Specifies a person using both an identifier and the persons name. Retained for backward compatibility only as of v2.6.
type CNS ¶
type CNS struct {
HL7 HL7Name `hl7:",name=CNS,type=s"`
StartingNotificationReferenceNumber NM `hl7:"1,len=20,display=Starting Notification Reference Number"`
EndingNotificationReferenceNumber NM `hl7:"2,len=20,display=Ending Notification Reference Number"`
StartingNotificationDateTime DTM `hl7:"3,len=24,format=YMDHM,display=Starting Notification Date/Time"`
EndingNotificationDateTime DTM `hl7:"4,len=24,format=YMDHM,display=Ending Notification Date/Time"`
StartingNotificationCode *CWE `hl7:"5,len=705,display=Starting Notification Code"`
EndingNotificationCode *CWE `hl7:"6,len=705,display=Ending Notification Code"`
}
Clear Notification
The clear equipment notification segment contains the data necessary to allow the receiving equipment to clear any associated notifications.
type CP ¶
type CP struct {
HL7 HL7Name `hl7:",name=CP,len=765,type=d"`
Price MO `` /* 196-byte string literal not displayed */
PriceType ID `hl7:"2,len=2,table=0205,display=A coded value- data type ID. Refer to HL7 Table 0205 - Price type for valid values."`
FromValue NM `` /* 476-byte string literal not displayed */
ToValue NM `hl7:"4,len=16,display=See <from value>."`
RangeUnits *CWE `` /* 358-byte string literal not displayed */
RangeType ID `hl7:"6,len=1,table=0298,display=Range Type"`
}
Composite Price
type CQ ¶
type CQ struct {
HL7 HL7Name `hl7:",name=CQ,len=722,type=d"`
Quantity NM `hl7:"1,len=16,display=This component specifies the numeric quantity or amount of an entity."`
Units *CWE `` /* 347-byte string literal not displayed */
}
Composite Quantity with Units
type CRM_C01 ¶
type CRM_C01 struct {
HL7 HL7Name `hl7:",name=CRM_C01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C01_Patient `hl7:",required,display=Patient"`
}
Register a Patient on a Clinical Trial
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C01_Patient ¶
type CRM_C01_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C01_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C02 ¶
type CRM_C02 struct {
HL7 HL7Name `hl7:",name=CRM_C02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C02_Patient `hl7:",required,display=Patient"`
}
Cancel a Patient Registration on Clinical Trial
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C02_Patient ¶
type CRM_C02_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C02_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C03 ¶
type CRM_C03 struct {
HL7 HL7Name `hl7:",name=CRM_C03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C03_Patient `hl7:",required,display=Patient"`
}
Correct/Update Registration Information
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C03_Patient ¶
type CRM_C03_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C03_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C04 ¶
type CRM_C04 struct {
HL7 HL7Name `hl7:",name=CRM_C04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C04_Patient `hl7:",required,display=Patient"`
}
Patient Has Gone off a Clinical Trial
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C04_Patient ¶
type CRM_C04_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C04_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C05 ¶
type CRM_C05 struct {
HL7 HL7Name `hl7:",name=CRM_C05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C05_Patient `hl7:",required,display=Patient"`
}
Patient Enters Phase of Clinical Trial
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C05_Patient ¶
type CRM_C05_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C05_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C06 ¶
type CRM_C06 struct {
HL7 HL7Name `hl7:",name=CRM_C06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C06_Patient `hl7:",required,display=Patient"`
}
Cancel Patient Entering a Phase
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C06_Patient ¶
type CRM_C06_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C06_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C07 ¶
type CRM_C07 struct {
HL7 HL7Name `hl7:",name=CRM_C07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C07_Patient `hl7:",required,display=Patient"`
}
Correct/Update Phase Information
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C07_Patient ¶
type CRM_C07_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C07_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CRM_C08 ¶
type CRM_C08 struct {
HL7 HL7Name `hl7:",name=CRM_C08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CRM_C08_Patient `hl7:",required,display=Patient"`
}
Patient Has Gone off Phase of Clinical Trial
The data are entered in a clinical trials or other patient data system and broadcast to other facility systems such as order entry, pharmacy, accounting, and nursing systems. They can be transmitted in batch mode or broadcast to outside-facility computer systems, including diagnostic and patient management systems. It is assumed that proper routing and security mechanisms are in place.
type CRM_C08_Patient ¶
type CRM_C08_Patient struct {
HL7 HL7Name `hl7:",name=CRM_C08_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PV1 *PV1 `hl7:"5,display=Patient Visit"`
CSR *CSR `hl7:"6,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"7,display=Clinical Study Phase"`
}
Patient
type CSP ¶
type CSP struct {
HL7 HL7Name `hl7:",name=CSP,type=s"`
StudyPhaseIdentifier CWE `hl7:"1,required,len=705,display=Study Phase Identifier"`
DateTimeStudyPhaseBegan DTM `hl7:"2,required,len=24,format=YMDHM,display=Date/time Study Phase Began"`
DateTimeStudyPhaseEnded DTM `hl7:"3,len=24,format=YMDHM,display=Date/time Study Phase Ended"`
StudyPhaseEvaluability *CWE `hl7:"4,conditional,len=705,display=Study Phase Evaluability"`
}
Clinical Study Phase
The CSP segment contains information on a patients status for a particular phase of the study. This segment is optional and is useful when a study has different evaluation intervals within it. (See section 7.8.1, "HL7 Attribute Table - CSR - Clinical Study Registration," and section 7.6.1.2, "Phase of a clinical trial:.") The CSP segment is implemented on a study-specific basis for messaging purposes. The fact that the patient has entered a phase of the study that represents a certain treatment approach may need to be messaged to other systems, like pharmacy, nursing, or order entry. It is also important to sponsors and data management centers for tracking patient progress through the study and monitoring the data schedule defined for each phase. It may subsume OBR and OBX segments that follow it to indicate that these data describe the phase.
type CSR ¶
type CSR struct {
HL7 HL7Name `hl7:",name=CSR,type=s"`
SponsorStudyID EI `hl7:"1,required,len=427,display=Sponsor Study ID"`
AlternateStudyID *EI `hl7:"2,len=427,display=Alternate Study ID"`
InstitutionRegisteringThePatient *CWE `hl7:"3,len=705,display=Institution Registering the Patient"`
SponsorPatientID CX `hl7:"4,required,len=1913,display=Sponsor Patient ID"`
AlternatePatientID *CX `hl7:"5,len=1913,display=Alternate Patient ID - CSR"`
DateTimeOfPatientStudyRegistration DTM `hl7:"6,required,len=24,format=YMDHM,display=Date/Time Of Patient Study Registration"`
PersonPerformingStudyRegistration []XCN `hl7:"7,len=3220,display=Person Performing Study Registration"`
StudyAuthorizingProvider []XCN `hl7:"8,required,len=3220,display=Study Authorizing Provider"`
DateTimePatientStudyConsentSigned DTM `hl7:"9,conditional,len=24,format=YMDHM,display=Date/time Patient Study Consent Signed"`
PatientStudyEligibilityStatus *CWE `hl7:"10,conditional,len=705,display=Patient Study Eligibility Status"`
StudyRandomizationDateTime []DTM `hl7:"11,max=3,len=24,format=YMDHM,display=Study Randomization Date/time"`
RandomizedStudyArm []CWE `hl7:"12,max=3,len=705,display=Randomized Study Arm"`
StratumForStudyRandomization []CWE `hl7:"13,max=3,len=705,display=Stratum for Study Randomization"`
PatientEvaluabilityStatus *CWE `hl7:"14,conditional,len=705,display=Patient Evaluability Status"`
DateTimeEndedStudy DTM `hl7:"15,conditional,len=24,format=YMDHM,display=Date/Time Ended Study"`
ReasonEndedStudy *CWE `hl7:"16,conditional,len=705,display=Reason Ended Study"`
}
Clinical Study Registration
The CSR segment will contain fundamental administrative and regulatory information required to document a patients enrollment on a clinical trial. This segment is all that is required if one needs to message another system that an enrollment has taken place, i.e., from clinical trials to pharmacy, accounting, or order entry systems. The CSR segment may also be used to identify that OBR, OBX, RXA, and RXR segments that follow represent data applicable to the identified study.
type CSS ¶
type CSS struct {
HL7 HL7Name `hl7:",name=CSS,type=s"`
StudyScheduledTimePoint CWE `hl7:"1,required,len=705,display=Study Scheduled Time Point"`
StudyScheduledPatientTimePoint DTM `hl7:"2,len=24,format=YMDHM,display=Study Scheduled Patient Time Point"`
StudyQualityControlCodes []CWE `hl7:"3,max=3,len=705,display=Study Quality Control Codes"`
}
Clinical Study Data Schedule Segment
The Clinical Study Data Schedule (CSS) segment is optional depending on whether messaging of study data needs to be linked to the scheduled data time points for the study. (See Section 7.6.1.3, " Data schedule: .") The CSS segment enables communication of data schedules and adherence that ranges from the basic to the elaborate. Use of the segment must be planned for each implementation. Each CSS segment will subsume observation and drug administration segments that follow, indicating that they satisfy this scheduled time point.
type CSU_C09 ¶
type CSU_C09 struct {
HL7 HL7Name `hl7:",name=CSU_C09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CSU_C09_Patient `hl7:",required,display=Patient"`
}
Automated Time Intervals for Reporting, Like Monthly
Data are entered in the clinical trials system or may reside in laboratory, pathology, radiology, pharmacy and/or other clinical applications. Most clinical trials data clinical observations and study variables will be communicated in OBR and OBX segments. The CSR, CSP, and CSS segments will identify the specific association these OBR and OBX have to the clinical trial. Data can be broadcast or transmitted in batch mode to study sponsors or the data management center for collaborative studies.
type CSU_C09_Patient ¶
type CSU_C09_Patient struct {
HL7 HL7Name `hl7:",name=CSU_C09_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Visit *CSU_C09_Visit `hl7:",display=Visit"`
CSR *CSR `hl7:"9,required,display=Clinical Study Registration"`
StudyPhase []CSU_C09_StudyPhase `hl7:",required,display=Study Phase"`
}
Patient
type CSU_C09_RxAdmin ¶
type CSU_C09_RxAdmin struct {
HL7 HL7Name `hl7:",name=CSU_C09_RxAdmin,type=tg"`
RXA *RXA `hl7:"19,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
}
RxAdmin
type CSU_C09_StudyObservation ¶
type CSU_C09_StudyObservation struct {
HL7 HL7Name `hl7:",name=CSU_C09_StudyObservation,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []CSU_C09_TimingQty `hl7:",display=Timing Qty"`
OBX []OBX `hl7:"17,required,display=Observation/Result"`
}
StudyObservation
type CSU_C09_StudyPharm ¶
type CSU_C09_StudyPharm struct {
HL7 HL7Name `hl7:",name=CSU_C09_StudyPharm,type=tg"`
ORC *ORC `hl7:"18,display=Common Order"`
RxAdmin []CSU_C09_RxAdmin `hl7:",required,display=Rx Admin"`
}
StudyPharm
type CSU_C09_StudyPhase ¶
type CSU_C09_StudyPhase struct {
HL7 HL7Name `hl7:",name=CSU_C09_StudyPhase,type=tg"`
CSP *CSP `hl7:"10,display=Clinical Study Phase"`
StudySchedule []CSU_C09_StudySchedule `hl7:",required,display=Study Schedule"`
}
StudyPhase
type CSU_C09_StudySchedule ¶
type CSU_C09_StudySchedule struct {
HL7 HL7Name `hl7:",name=CSU_C09_StudySchedule,type=tg"`
CSS *CSS `hl7:"11,display=Clinical Study Data Schedule Segment"`
StudyObservation []CSU_C09_StudyObservation `hl7:",required,display=Study Observation"`
StudyPharm []CSU_C09_StudyPharm `hl7:",required,display=Study Pharm"`
}
StudySchedule
type CSU_C09_TimingQty ¶
type CSU_C09_TimingQty struct {
HL7 HL7Name `hl7:",name=CSU_C09_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type CSU_C09_Visit ¶
type CSU_C09_Visit struct {
HL7 HL7Name `hl7:",name=CSU_C09_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type CSU_C10 ¶
type CSU_C10 struct {
HL7 HL7Name `hl7:",name=CSU_C10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CSU_C10_Patient `hl7:",required,display=Patient"`
}
Patient Completes the Clinical Trial
Data are entered in the clinical trials system or may reside in laboratory, pathology, radiology, pharmacy and/or other clinical applications. Most clinical trials data clinical observations and study variables will be communicated in OBR and OBX segments. The CSR, CSP, and CSS segments will identify the specific association these OBR and OBX have to the clinical trial. Data can be broadcast or transmitted in batch mode to study sponsors or the data management center for collaborative studies.
type CSU_C10_Patient ¶
type CSU_C10_Patient struct {
HL7 HL7Name `hl7:",name=CSU_C10_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Visit *CSU_C10_Visit `hl7:",display=Visit"`
CSR *CSR `hl7:"9,required,display=Clinical Study Registration"`
StudyPhase []CSU_C10_StudyPhase `hl7:",required,display=Study Phase"`
}
Patient
type CSU_C10_RxAdmin ¶
type CSU_C10_RxAdmin struct {
HL7 HL7Name `hl7:",name=CSU_C10_RxAdmin,type=tg"`
RXA *RXA `hl7:"19,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
}
RxAdmin
type CSU_C10_StudyObservation ¶
type CSU_C10_StudyObservation struct {
HL7 HL7Name `hl7:",name=CSU_C10_StudyObservation,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []CSU_C10_TimingQty `hl7:",display=Timing Qty"`
OBX []OBX `hl7:"17,required,display=Observation/Result"`
}
StudyObservation
type CSU_C10_StudyPharm ¶
type CSU_C10_StudyPharm struct {
HL7 HL7Name `hl7:",name=CSU_C10_StudyPharm,type=tg"`
ORC *ORC `hl7:"18,display=Common Order"`
RxAdmin []CSU_C10_RxAdmin `hl7:",required,display=Rx Admin"`
}
StudyPharm
type CSU_C10_StudyPhase ¶
type CSU_C10_StudyPhase struct {
HL7 HL7Name `hl7:",name=CSU_C10_StudyPhase,type=tg"`
CSP *CSP `hl7:"10,display=Clinical Study Phase"`
StudySchedule []CSU_C10_StudySchedule `hl7:",required,display=Study Schedule"`
}
StudyPhase
type CSU_C10_StudySchedule ¶
type CSU_C10_StudySchedule struct {
HL7 HL7Name `hl7:",name=CSU_C10_StudySchedule,type=tg"`
CSS *CSS `hl7:"11,display=Clinical Study Data Schedule Segment"`
StudyObservation []CSU_C10_StudyObservation `hl7:",required,display=Study Observation"`
StudyPharm []CSU_C10_StudyPharm `hl7:",required,display=Study Pharm"`
}
StudySchedule
type CSU_C10_TimingQty ¶
type CSU_C10_TimingQty struct {
HL7 HL7Name `hl7:",name=CSU_C10_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type CSU_C10_Visit ¶
type CSU_C10_Visit struct {
HL7 HL7Name `hl7:",name=CSU_C10_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type CSU_C11 ¶
type CSU_C11 struct {
HL7 HL7Name `hl7:",name=CSU_C11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CSU_C11_Patient `hl7:",required,display=Patient"`
}
Patient Completes a Phase of the Clinical Trial
Data are entered in the clinical trials system or may reside in laboratory, pathology, radiology, pharmacy and/or other clinical applications. Most clinical trials data clinical observations and study variables will be communicated in OBR and OBX segments. The CSR, CSP, and CSS segments will identify the specific association these OBR and OBX have to the clinical trial. Data can be broadcast or transmitted in batch mode to study sponsors or the data management center for collaborative studies.
type CSU_C11_Patient ¶
type CSU_C11_Patient struct {
HL7 HL7Name `hl7:",name=CSU_C11_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Visit *CSU_C11_Visit `hl7:",display=Visit"`
CSR *CSR `hl7:"9,required,display=Clinical Study Registration"`
StudyPhase []CSU_C11_StudyPhase `hl7:",required,display=Study Phase"`
}
Patient
type CSU_C11_RxAdmin ¶
type CSU_C11_RxAdmin struct {
HL7 HL7Name `hl7:",name=CSU_C11_RxAdmin,type=tg"`
RXA *RXA `hl7:"19,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
}
RxAdmin
type CSU_C11_StudyObservation ¶
type CSU_C11_StudyObservation struct {
HL7 HL7Name `hl7:",name=CSU_C11_StudyObservation,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []CSU_C11_TimingQty `hl7:",display=Timing Qty"`
OBX []OBX `hl7:"17,required,display=Observation/Result"`
}
StudyObservation
type CSU_C11_StudyPharm ¶
type CSU_C11_StudyPharm struct {
HL7 HL7Name `hl7:",name=CSU_C11_StudyPharm,type=tg"`
ORC *ORC `hl7:"18,display=Common Order"`
RxAdmin []CSU_C11_RxAdmin `hl7:",required,display=Rx Admin"`
}
StudyPharm
type CSU_C11_StudyPhase ¶
type CSU_C11_StudyPhase struct {
HL7 HL7Name `hl7:",name=CSU_C11_StudyPhase,type=tg"`
CSP *CSP `hl7:"10,display=Clinical Study Phase"`
StudySchedule []CSU_C11_StudySchedule `hl7:",required,display=Study Schedule"`
}
StudyPhase
type CSU_C11_StudySchedule ¶
type CSU_C11_StudySchedule struct {
HL7 HL7Name `hl7:",name=CSU_C11_StudySchedule,type=tg"`
CSS *CSS `hl7:"11,display=Clinical Study Data Schedule Segment"`
StudyObservation []CSU_C11_StudyObservation `hl7:",required,display=Study Observation"`
StudyPharm []CSU_C11_StudyPharm `hl7:",required,display=Study Pharm"`
}
StudySchedule
type CSU_C11_TimingQty ¶
type CSU_C11_TimingQty struct {
HL7 HL7Name `hl7:",name=CSU_C11_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type CSU_C11_Visit ¶
type CSU_C11_Visit struct {
HL7 HL7Name `hl7:",name=CSU_C11_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type CSU_C12 ¶
type CSU_C12 struct {
HL7 HL7Name `hl7:",name=CSU_C12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Patient []CSU_C12_Patient `hl7:",required,display=Patient"`
}
Update/Correction of Patient Order/Result Information
Data are entered in the clinical trials system or may reside in laboratory, pathology, radiology, pharmacy and/or other clinical applications. Most clinical trials data clinical observations and study variables will be communicated in OBR and OBX segments. The CSR, CSP, and CSS segments will identify the specific association these OBR and OBX have to the clinical trial. Data can be broadcast or transmitted in batch mode to study sponsors or the data management center for collaborative studies.
type CSU_C12_Patient ¶
type CSU_C12_Patient struct {
HL7 HL7Name `hl7:",name=CSU_C12_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Visit *CSU_C12_Visit `hl7:",display=Visit"`
CSR *CSR `hl7:"9,required,display=Clinical Study Registration"`
StudyPhase []CSU_C12_StudyPhase `hl7:",required,display=Study Phase"`
}
Patient
type CSU_C12_RxAdmin ¶
type CSU_C12_RxAdmin struct {
HL7 HL7Name `hl7:",name=CSU_C12_RxAdmin,type=tg"`
RXA *RXA `hl7:"19,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
}
RxAdmin
type CSU_C12_StudyObservation ¶
type CSU_C12_StudyObservation struct {
HL7 HL7Name `hl7:",name=CSU_C12_StudyObservation,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []CSU_C12_TimingQty `hl7:",display=Timing Qty"`
OBX []OBX `hl7:"17,required,display=Observation/Result"`
}
StudyObservation
type CSU_C12_StudyPharm ¶
type CSU_C12_StudyPharm struct {
HL7 HL7Name `hl7:",name=CSU_C12_StudyPharm,type=tg"`
ORC *ORC `hl7:"18,display=Common Order"`
RxAdmin []CSU_C12_RxAdmin `hl7:",required,display=Rx Admin"`
}
StudyPharm
type CSU_C12_StudyPhase ¶
type CSU_C12_StudyPhase struct {
HL7 HL7Name `hl7:",name=CSU_C12_StudyPhase,type=tg"`
CSP *CSP `hl7:"10,display=Clinical Study Phase"`
StudySchedule []CSU_C12_StudySchedule `hl7:",required,display=Study Schedule"`
}
StudyPhase
type CSU_C12_StudySchedule ¶
type CSU_C12_StudySchedule struct {
HL7 HL7Name `hl7:",name=CSU_C12_StudySchedule,type=tg"`
CSS *CSS `hl7:"11,display=Clinical Study Data Schedule Segment"`
StudyObservation []CSU_C12_StudyObservation `hl7:",required,display=Study Observation"`
StudyPharm []CSU_C12_StudyPharm `hl7:",required,display=Study Pharm"`
}
StudySchedule
type CSU_C12_TimingQty ¶
type CSU_C12_TimingQty struct {
HL7 HL7Name `hl7:",name=CSU_C12_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type CSU_C12_Visit ¶
type CSU_C12_Visit struct {
HL7 HL7Name `hl7:",name=CSU_C12_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type CTD ¶
type CTD struct {
HL7 HL7Name `hl7:",name=CTD,type=s"`
ContactRole []CWE `hl7:"1,required,len=705,table=0131,display=Contact Role"`
ContactName []XPN `hl7:"2,len=250,display=Contact Name"`
ContactAddress []XAD `hl7:"3,len=2915,display=Contact Address"`
ContactLocation *PL `hl7:"4,len=60,display=Contact Location"`
ContactCommunicationInformation []XTN `hl7:"5,len=250,display=Contact Communication Information"`
PreferredMethodOfContact *CWE `hl7:"6,len=705,table=0185,display=Preferred Method of Contact"`
ContactIdentifiers []PLN `hl7:"7,len=100,display=Contact Identifiers"`
}
Contact Data
The CTD segment may identify any contact personnel associated with a patient referral message and its related transactions. The CTD segment will be paired with a PRD segment. The PRD segment contains data specifically focused on provider information in a referral. While it is important in an inter-enterprise transaction to transmit specific information regarding the providers involved (referring and referred-to), it may also be important to identify the contact personnel associated with the given provider. For example, a provider receiving a referral may need to know the office manager or the billing person at the institution of the provider who sent the referral. This segment allows for multiple contact personnel to be associated with a single provider.
type CTI ¶
type CTI struct {
HL7 HL7Name `hl7:",name=CTI,type=s"`
SponsorStudyID EI `hl7:"1,required,len=427,display=Sponsor Study ID"`
StudyPhaseIdentifier *CWE `hl7:"2,conditional,len=705,display=Study Phase Identifier"`
StudyScheduledTimePoint *CWE `hl7:"3,len=705,display=Study Scheduled Time Point"`
}
Clinical Trial Identification
The CTI segment is an optional segment that contains information to identify the clinical trial, phase and time point with which an order or result is associated.
type CWE ¶
type CWE struct {
HL7 HL7Name `hl7:",name=CWE,len=0,type=d"`
Identifier ST `` /* 214-byte string literal not displayed */
Text ST `` /* 153-byte string literal not displayed */
NameOfCodingSystem ID `` /* 200-byte string literal not displayed */
AlternateIdentifier ST `` /* 203-byte string literal not displayed */
AlternateText ST `` /* 160-byte string literal not displayed */
NameOfAlternateCodingSystem ID `` /* 194-byte string literal not displayed */
CodingSystemVersionID ST `` /* 516-byte string literal not displayed */
AlternateCodingSystemVersionID ST `hl7:"8,len=10,display=This component carries the version for the coding system identified by components 4-6."`
OriginalText ST `` /* 132-byte string literal not displayed */
}
Coded with Exceptions
Specifies a coded element and its associated detail. The CWE data type is used when 1) more than one table may be applicable or 2) the specified HL7 or externally defined table may be extended with local values or 3) when text is in place, the code may be omitted.
type CX ¶
type CX struct {
HL7 HL7Name `hl7:",name=CX,len=1916,type=d"`
IDNumber ST `hl7:"1,required,len=15,display=The value of the identifier itself."`
IdentifierCheckDigit ST `` /* 236-byte string literal not displayed */
CheckDigitScheme ID `hl7:"3,len=3,table=0061,display=Contains the code identifying the check digit scheme employed."`
AssigningAuthority *HD `` /* 233-byte string literal not displayed */
IdentifierTypeCode ID `` /* 234-byte string literal not displayed */
AssigningFacility *HD `` /* 317-byte string literal not displayed */
EffectiveDate DT `hl7:"7,len=8,format=YMD,display=The first date- if known- on which the identifier is valid and active."`
ExpirationDate DT `hl7:"8,len=8,format=YMD,display=The last date- if known- on which the identifier is valid and active."`
AssigningJurisdiction *CWE `hl7:"9,len=705,display=The geo-political body that assigned the identifier in component 1."`
AssigningAgencyOrDepartment *CWE `hl7:"10,len=705,display=The agency or department that assigned the identifier in component 1."`
}
Extended Composite ID with Check Digit
This data type is used for specifying an identifier with its associated administrative detail.
type DB1 ¶
type DB1 struct {
HL7 HL7Name `hl7:",name=DB1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - DB1"`
DisabledPersonCode IS `hl7:"2,len=2,table=0334,display=Disabled Person Code"`
DisabledPersonIdentifier []CX `hl7:"3,len=250,display=Disabled Person Identifier"`
DisabledIndicator ID `hl7:"4,len=1,table=0136,display=Disabled Indicator"`
DisabilityStartDate DT `hl7:"5,len=8,format=YMD,display=Disability Start Date"`
DisabilityEndDate DT `hl7:"6,len=8,format=YMD,display=Disability End Date"`
DisabilityReturnToWorkDate DT `hl7:"7,len=8,format=YMD,display=Disability Return to Work Date"`
DisabilityUnableToWorkDate DT `hl7:"8,len=8,format=YMD,display=Disability Unable to Work Date"`
}
Disability
The disability segment contains information related to the disability of a person. This segment was created instead of adding disability attributes to each segment that contains a person (to which disability may apply). This is an optional segment that can be used to send disability information about a person already defined by the Patient Administration Chapter. The disabled person code and identifier allow for the association of the disability information to the person.
type DDI ¶
type DDI struct {
HL7 HL7Name `hl7:",name=DDI,len=25,type=d"`
DelayDays NM `hl7:"1,len=3,display=The number of days after which the daily deductible begins"`
MonetaryAmount MO `hl7:"2,required,len=16,display=The monetary amount of the deductible"`
NumberOfDays NM `` /* 149-byte string literal not displayed */
}
Daily Deductible Information
This data type specifies the detail information for the daily deductible.
type DFT_P03 ¶
type DFT_P03 struct {
HL7 HL7Name `hl7:",name=DFT_P03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL2 []ROL `hl7:"10,display=Role"`
DB1 []DB1 `hl7:"11,display=Disability"`
CommonOrder []DFT_P03_CommonOrder `hl7:",display=Common Order"`
Financial []DFT_P03_Financial `hl7:",required,display=Financial"`
DG1 []DG1 `hl7:"30,display=Diagnosis"`
DRG *DRG `hl7:"31,display=Diagnosis Related Group"`
GT1 []GT1 `hl7:"32,display=Guarantor"`
Insurance []DFT_P03_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"37,display=Accident"`
}
Post Detail Financial Transaction
The Detail Financial Transaction (DFT) message is used to describe a finan¬cial transaction transmitted between systems, that is, to the billing system for ancillary charges, ADT to billing system for patient deposits, etc
Note: There is an information overlap between the FT1, DG1 and PR1 segments. If diagnosis information is sent in an FT1 segment, it should be consistent with the information contained in any DG1 segments present within its hierarchy. Since the procedure code field within the FT1 does not repeat, if procedure information is sent on an FT1 it is recommended that the single occurrence of the code in FT1 equates to the primary procedure (PR1-14 - Procedure Priority code value 1).
Note: The extra set of DG1/DRG/GT1/IN1/IN2/IN3/ROL segments added in V2.4 have been withdrawn as a technical correction.
type DFT_P03_CommonOrder ¶
type DFT_P03_CommonOrder struct {
HL7 HL7Name `hl7:",name=DFT_P03_CommonOrder,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
TimingQuantity []DFT_P03_TimingQuantity `hl7:",display=Timing Quantity"`
Order *DFT_P03_Order `hl7:",display=Order"`
Observation []DFT_P03_Observation `hl7:",display=Observation"`
}
CommonOrder
type DFT_P03_Financial ¶
type DFT_P03_Financial struct {
HL7 HL7Name `hl7:",name=DFT_P03_Financial,type=tg"`
FT1 *FT1 `hl7:"19,required,display=Financial Transaction"`
NTE *NTE `hl7:"20,display=Notes and Comments"`
FinancialProcedure []DFT_P03_FinancialProcedure `hl7:",display=Financial Procedure"`
FinancialCommonOrder []DFT_P03_FinancialCommonOrder `hl7:",display=Financial Common Order"`
}
Financial
type DFT_P03_FinancialCommonOrder ¶
type DFT_P03_FinancialCommonOrder struct {
HL7 HL7Name `hl7:",name=DFT_P03_FinancialCommonOrder,type=tg"`
ORC *ORC `hl7:"23,display=Common Order"`
FinancialTimingQuantity []DFT_P03_FinancialTimingQuantity `hl7:",display=Financial Timing Quantity"`
FinancialOrder *DFT_P03_FinancialOrder `hl7:",display=Financial Order"`
FinancialObservation []DFT_P03_FinancialObservation `hl7:",display=Financial Observation"`
}
FinancialCommonOrder
type DFT_P03_FinancialObservation ¶
type DFT_P03_FinancialObservation struct {
HL7 HL7Name `hl7:",name=DFT_P03_FinancialObservation,type=tg"`
OBX *OBX `hl7:"28,required,display=Observation/Result"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
FinancialObservation
type DFT_P03_FinancialOrder ¶
type DFT_P03_FinancialOrder struct {
HL7 HL7Name `hl7:",name=DFT_P03_FinancialOrder,type=tg"`
OBR *OBR `hl7:"26,required,display=Observation Request"`
NTE []NTE `hl7:"27,display=Notes and Comments"`
}
FinancialOrder
type DFT_P03_FinancialProcedure ¶
type DFT_P03_FinancialProcedure struct {
HL7 HL7Name `hl7:",name=DFT_P03_FinancialProcedure,type=tg"`
PR1 *PR1 `hl7:"21,required,display=Procedures"`
ROL []ROL `hl7:"22,display=Role"`
}
FinancialProcedure
type DFT_P03_FinancialTimingQuantity ¶
type DFT_P03_FinancialTimingQuantity struct {
HL7 HL7Name `hl7:",name=DFT_P03_FinancialTimingQuantity,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
FinancialTimingQuantity
type DFT_P03_Insurance ¶
type DFT_P03_Insurance struct {
HL7 HL7Name `hl7:",name=DFT_P03_Insurance,type=tg"`
IN1 *IN1 `hl7:"33,required,display=Insurance"`
IN2 *IN2 `hl7:"34,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"35,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"36,display=Role"`
}
Insurance
type DFT_P03_Observation ¶
type DFT_P03_Observation struct {
HL7 HL7Name `hl7:",name=DFT_P03_Observation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Observation
type DFT_P03_Order ¶
type DFT_P03_Order struct {
HL7 HL7Name `hl7:",name=DFT_P03_Order,type=tg"`
OBR *OBR `hl7:"15,required,display=Observation Request"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Order
type DFT_P03_TimingQuantity ¶
type DFT_P03_TimingQuantity struct {
HL7 HL7Name `hl7:",name=DFT_P03_TimingQuantity,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingQuantity
type DFT_P11 ¶
type DFT_P11 struct {
HL7 HL7Name `hl7:",name=DFT_P11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
ROL []ROL `hl7:"7,display=Role"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
ROL2 []ROL `hl7:"10,display=Role"`
DB1 []DB1 `hl7:"11,display=Disability"`
CommonOrder []DFT_P11_CommonOrder `hl7:",display=Common Order"`
DG1 []DG1 `hl7:"19,display=Diagnosis"`
DRG *DRG `hl7:"20,display=Diagnosis Related Group"`
GT1 []GT1 `hl7:"21,display=Guarantor"`
Insurance []DFT_P11_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"26,display=Accident"`
Financial []DFT_P11_Financial `hl7:",required,display=Financial"`
}
Post Detail Financial Transactions - Expanded
The Detail Financial Transaction (DFT) - Expanded message is used to describe a finan¬cial transaction transmitted between systems, that is, to the billing system for ancillary charges, ADT to billing system for patient deposits, etc. It serves the same function as the Post Detail Financial Transactions (event P03) message, but also supports the use cases described below.
Note: There is an information overlap between the FT1, DG1 and PR1 segments. If diagnosis information is sent in an FT1 segment, it should be consistent with the information contained in any DG1 segments present within its hierarchy. Since the procedure code field within the FT1 does not repeat, if procedure information is sent on an FT1 it is recommended that the single occurrence of the code in FT1 equates to the primary procedure (PR1-14 - Procedure Priority code value 1).
type DFT_P11_CommonOrder ¶
type DFT_P11_CommonOrder struct {
HL7 HL7Name `hl7:",name=DFT_P11_CommonOrder,type=tg"`
ORC *ORC `hl7:"12,display=Common Order"`
TimingQuantity []DFT_P11_TimingQuantity `hl7:",display=Timing Quantity"`
Order *DFT_P11_Order `hl7:",display=Order"`
Observation []DFT_P11_Observation `hl7:",display=Observation"`
}
CommonOrder
type DFT_P11_Financial ¶
type DFT_P11_Financial struct {
HL7 HL7Name `hl7:",name=DFT_P11_Financial,type=tg"`
FT1 *FT1 `hl7:"27,required,display=Financial Transaction"`
FinancialProcedure []DFT_P11_FinancialProcedure `hl7:",display=Financial Procedure"`
FinancialCommonOrder []DFT_P11_FinancialCommonOrder `hl7:",display=Financial Common Order"`
DG1 []DG1 `hl7:"37,display=Diagnosis"`
DRG *DRG `hl7:"38,display=Diagnosis Related Group"`
GT1 []GT1 `hl7:"39,display=Guarantor"`
FinancialInsurance []DFT_P11_FinancialInsurance `hl7:",display=Financial Insurance"`
}
Financial
type DFT_P11_FinancialCommonOrder ¶
type DFT_P11_FinancialCommonOrder struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialCommonOrder,type=tg"`
ORC *ORC `hl7:"30,display=Common Order"`
FinancialTimingQuantity []DFT_P11_FinancialTimingQuantity `hl7:",display=Financial Timing Quantity"`
FinancialOrder *DFT_P11_FinancialOrder `hl7:",display=Financial Order"`
FinancialObservation []DFT_P11_FinancialObservation `hl7:",display=Financial Observation"`
}
FinancialCommonOrder
type DFT_P11_FinancialInsurance ¶
type DFT_P11_FinancialInsurance struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialInsurance,type=tg"`
IN1 *IN1 `hl7:"40,required,display=Insurance"`
IN2 *IN2 `hl7:"41,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"42,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"43,display=Role"`
}
FinancialInsurance
type DFT_P11_FinancialObservation ¶
type DFT_P11_FinancialObservation struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
}
FinancialObservation
type DFT_P11_FinancialOrder ¶
type DFT_P11_FinancialOrder struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialOrder,type=tg"`
OBR *OBR `hl7:"33,required,display=Observation Request"`
NTE []NTE `hl7:"34,display=Notes and Comments"`
}
FinancialOrder
type DFT_P11_FinancialProcedure ¶
type DFT_P11_FinancialProcedure struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialProcedure,type=tg"`
PR1 *PR1 `hl7:"28,required,display=Procedures"`
ROL []ROL `hl7:"29,display=Role"`
}
FinancialProcedure
type DFT_P11_FinancialTimingQuantity ¶
type DFT_P11_FinancialTimingQuantity struct {
HL7 HL7Name `hl7:",name=DFT_P11_FinancialTimingQuantity,type=tg"`
TQ1 *TQ1 `hl7:"31,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"32,display=Timing/Quantity Relationship"`
}
FinancialTimingQuantity
type DFT_P11_Insurance ¶
type DFT_P11_Insurance struct {
HL7 HL7Name `hl7:",name=DFT_P11_Insurance,type=tg"`
IN1 *IN1 `hl7:"22,required,display=Insurance"`
IN2 *IN2 `hl7:"23,display=Insurance Additional Information"`
IN3 []IN3 `hl7:"24,display=Insurance Additional Information- Certification"`
ROL []ROL `hl7:"25,display=Role"`
}
Insurance
type DFT_P11_Observation ¶
type DFT_P11_Observation struct {
HL7 HL7Name `hl7:",name=DFT_P11_Observation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Observation
type DFT_P11_Order ¶
type DFT_P11_Order struct {
HL7 HL7Name `hl7:",name=DFT_P11_Order,type=tg"`
OBR *OBR `hl7:"15,required,display=Observation Request"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Order
type DFT_P11_TimingQuantity ¶
type DFT_P11_TimingQuantity struct {
HL7 HL7Name `hl7:",name=DFT_P11_TimingQuantity,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingQuantity
type DG1 ¶
type DG1 struct {
HL7 HL7Name `hl7:",name=DG1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - DG1"`
DiagnosisCodingMethod ST `hl7:"2,display=Diagnosis Coding Method"`
DiagnosisCode CWE `hl7:"3,required,len=250,table=0051,display=Diagnosis Code - DG1"`
DiagnosisDescription ST `hl7:"4,display=Diagnosis Description"`
DiagnosisDateTime DTM `hl7:"5,len=24,format=YMDHM,display=Diagnosis Date/Time"`
DiagnosisType IS `hl7:"6,required,len=2,table=0052,display=Diagnosis Type"`
MajorDiagnosticCategory ST `hl7:"7,display=Major Diagnostic Category"`
DiagnosticRelatedGroup ST `hl7:"8,display=Diagnostic Related Group"`
DRGApprovalIndicator ST `hl7:"9,display=DRG Approval Indicator"`
DRGGrouperReviewCode ST `hl7:"10,display=DRG Grouper Review Code"`
OutlierType ST `hl7:"11,display=Outlier Type"`
OutlierDays ST `hl7:"12,display=Outlier Days"`
OutlierCost ST `hl7:"13,display=Outlier Cost"`
GrouperVersionAndType ST `hl7:"14,display=Grouper Version And Type"`
DiagnosisPriority ID `hl7:"15,len=2,table=0359,display=Diagnosis Priority"`
DiagnosingClinician []XCN `hl7:"16,len=250,display=Diagnosing Clinician"`
DiagnosisClassification IS `hl7:"17,len=3,table=0228,display=Diagnosis Classification"`
ConfidentialIndicator ID `hl7:"18,len=1,table=0136,display=Confidential Indicator"`
AttestationDateTime DTM `hl7:"19,len=24,format=YMDHM,display=Attestation Date/Time"`
DiagnosisIdentifier *EI `hl7:"20,conditional,len=427,display=Diagnosis Identifier"`
DiagnosisActionCode ID `hl7:"21,conditional,len=1,table=0206,display=Diagnosis Action Code"`
ParentDiagnosis *EI `hl7:"22,conditional,len=427,display=Parent Diagnosis"`
DRGCCLValueCode *CWE `hl7:"23,len=705,table=0728,display=DRG CCL Value Code"`
DRGGroupingUsage ID `hl7:"24,len=20,table=0136,display=DRG Grouping Usage"`
DRGDiagnosisDeterminationStatus IS `hl7:"25,len=20,table=0731,display=DRG Diagnosis Determination Status"`
PresentOnAdmissionPOAIndicator IS `hl7:"26,len=1,table=0895,display=Present On Admission (POA) Indicator"`
}
Diagnosis
The DG1 segment contains patient diagnosis information of various types, for example, admitting, primary, etc. The DG1 segment is used to send multiple diagnoses (for example, for medical records encoding). It is also used when the FT1-19 - Diagnosis Code - FT1 does not provide sufficient information for a billing system. This diagnosis coding should be distinguished from the clinical problem segment used by caregivers to manage the patient (see Chapter 12, Patient Care). Coding methodologies are also defined.
type DIN ¶
type DIN struct {
HL7 HL7Name `hl7:",name=DIN,len=730,type=d"`
Date DTM `hl7:"1,required,len=24,format=YMDHM,display=Specifies the date when a staff member became active or inactive."`
InstitutionName CWE `` /* 178-byte string literal not displayed */
}
Date and Institution Name
Specifies the date and institution information where a staff member became active or inactive.
type DLD ¶
type DLD struct {
HL7 HL7Name `hl7:",name=DLD,len=730,type=d"`
DischargeToLocation CWE `` /* 209-byte string literal not displayed */
EffectiveDate DTM `hl7:"2,len=24,format=YMDHM,display=Specifies the date on which the patient was discharged to a healthcare facility."`
}
Discharge Location and Date
Specifies the healthcare facility to which the patient was discharged and the date.
type DLN ¶
type DLN struct {
HL7 HL7Name `hl7:",name=DLN,len=66,type=d"`
LicenseNumber ST `hl7:"1,required,len=20,display=This field contains the drivers license number."`
IssuingStateProvinceCountry IS `` /* 481-byte string literal not displayed */
ExpirationDate DT `hl7:"3,len=8,format=YMD,display=Expiration date (DT) for drivers license."`
}
Driver_s License Number
This field contains the drivers license information. For state or province refer to official postal codes for that country; for country refer to ISO 3166 for codes.
type DLT ¶
type DLT struct {
HL7 HL7Name `hl7:",name=DLT,len=45,type=d"`
NormalRange *NR `hl7:"1,len=33,display=Specifies the normal interval of the reference data"`
NumericThreshold NM `hl7:"2,len=4,display=The numeric threshold of the change that is detected."`
ChangeComputation ID `` /* 175-byte string literal not displayed */
DaysRetained NM `hl7:"4,len=4,display=The length of time in days that the value is retained for computing delta checks."`
}
Delta
Describes the information that controls delta check warnings.
type DMI ¶
type DMI struct {
HL7 HL7Name `hl7:",name=DMI,type=s"`
DiagnosticRelatedGroup *CNE `hl7:"1,len=250,table=0055,display=Diagnostic Related Group"`
MajorDiagnosticCategory *CNE `hl7:"2,conditional,len=1,table=0118,display=Major Diagnostic Category"`
LowerAndUpperTrimPoints *NR `hl7:"3,conditional,len=7,display=Lower and Upper Trim Points"`
AverageLengthOfStay NM `hl7:"4,conditional,len=5,display=Average Length of Stay"`
RelativeWeight NM `hl7:"5,conditional,len=7,display=Relative Weight"`
}
DRG Master File Information
The Technical Steward for the DMI segment is Financial Management.
The DMI segment contains the DRG related basic information, for example, relative weight, etc. The DMI segment is used to send the fixed information assigned to a specific DRG.
type DOC_T12 ¶
type DOC_T12 struct {
HL7 HL7Name `hl7:",name=DOC_T12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"3,display=Error"`
QAK *QAK `hl7:"4,display=Query Acknowledgment"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
Result []DOC_T12_Result `hl7:",required,display=Result"`
DSC *DSC `hl7:"11,display=Continuation Pointer"`
}
Document Response
Retained for backwards compatibility only in version 2.4 and later
type DOC_T12_Result ¶
type DOC_T12_Result struct {
HL7 HL7Name `hl7:",name=DOC_T12_Result,type=tg"`
EVN *EVN `hl7:"6,display=Event Type"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
TXA *TXA `hl7:"9,required,display=Transcription Document Header"`
OBX []OBX `hl7:"10,display=Observation/Result"`
}
Result
type DR ¶
type DR struct {
HL7 HL7Name `hl7:",name=DR,len=49,type=d"`
RangeStartDateTime DTM `hl7:"1,len=24,format=YMDHM,display=The first component contains the earliest date/time (time stamp) in the specified range."`
RangeEndDateTime DTM `` /* 190-byte string literal not displayed */
}
Date/Time Range
type DRG ¶
type DRG struct {
HL7 HL7Name `hl7:",name=DRG,type=s"`
DiagnosticRelatedGroup *CNE `hl7:"1,len=250,table=0055,display=Diagnostic Related Group"`
AssignedDateTime DTM `hl7:"2,len=24,format=YMDHM,display=DRG Assigned Date/Time"`
ApprovalIndicator ID `hl7:"3,len=1,table=0136,display=DRG Approval Indicator"`
GrouperReviewCode IS `hl7:"4,len=2,table=0056,display=DRG Grouper Review Code"`
OutlierType *CWE `hl7:"5,len=250,table=0083,display=Outlier Type"`
OutlierDays NM `hl7:"6,len=3,display=Outlier Days"`
OutlierCost *CP `hl7:"7,len=12,display=Outlier Cost"`
Payor IS `hl7:"8,len=1,table=0229,display=DRG Payor"`
OutlierReimbursement *CP `hl7:"9,len=9,display=Outlier Reimbursement"`
ConfidentialIndicator ID `hl7:"10,len=1,table=0136,display=Confidential Indicator"`
TransferType IS `hl7:"11,len=21,table=0415,display=DRG Transfer Type"`
NameOfCoder *XPN `hl7:"12,len=1103,display=Name of Coder"`
GrouperStatus *CWE `hl7:"13,len=705,table=0734,display=Grouper Status"`
PCCLValueCode *CWE `hl7:"14,len=20,table=0136,display=PCCL Value Code"`
EffectiveWeight NM `hl7:"15,len=5,display=Effective Weight"`
MonetaryAmount *MO `hl7:"16,len=20,display=Monetary Amount"`
StatusPatient IS `hl7:"17,len=20,table=0739,display=Status Patient"`
GrouperSoftwareName ST `hl7:"18,len=100,display=Grouper Software Name"`
GrouperSoftwareVersion ST `hl7:"19,len=100,display=Grouper Software Version"`
StatusFinancialCalculation IS `hl7:"20,len=20,table=0742,display=Status Financial Calculation"`
RelativeDiscountSurcharge *MO `hl7:"21,len=20,display=Relative Discount/Surcharge"`
BasicCharge *MO `hl7:"22,len=20,display=Basic Charge"`
TotalCharge *MO `hl7:"23,len=20,display=Total Charge"`
DiscountSurcharge *MO `hl7:"24,len=20,display=Discount/Surcharge"`
CalculatedDays NM `hl7:"25,len=5,display=Calculated Days"`
StatusGender IS `hl7:"26,len=20,table=0749,display=Status Gender"`
StatusAge IS `hl7:"27,len=20,table=0749,display=Status Age"`
StatusLengthOfStay IS `hl7:"28,len=20,table=0749,display=Status Length of Stay"`
StatusSameDayFlag IS `hl7:"29,len=20,table=0749,display=Status Same Day Flag"`
StatusSeparationMode IS `hl7:"30,len=20,table=0749,display=Status Separation Mode"`
StatusWeightAtBirth IS `hl7:"31,len=20,table=0755,display=Status Weight at Birth"`
StatusRespirationMinutes IS `hl7:"32,len=20,table=0757,display=Status Respiration Minutes"`
StatusAdmission IS `hl7:"33,len=20,table=0759,display=Status Admission"`
}
Diagnosis Related Group
The DRG segment contains diagnoses-related grouping information of various types. The DRG segment is used to send the DRG information, for example, for billing and medical records encoding.
type DSC ¶
type DSC struct {
HL7 HL7Name `hl7:",name=DSC,type=s"`
ContinuationPointer ST `hl7:"1,len=180,display=Continuation Pointer"`
ContinuationStyle ID `hl7:"2,len=1,table=0398,display=Continuation Style"`
}
Continuation Pointer
The DSC segment is used in the continuation protocol.
type DSP ¶
type DSP struct {
HL7 HL7Name `hl7:",name=DSP,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - DSP"`
DisplayLevel SI `hl7:"2,len=4,display=Display Level"`
DataLine TX `hl7:"3,required,len=300,display=Data Line"`
LogicalBreakPoint ST `hl7:"4,len=2,display=Logical Break Point"`
ResultID TX `hl7:"5,len=20,display=Result ID"`
}
Display Data
The DSP segment is used to contain data that has been preformatted by the sender for display. The semantic content of the data is lost; the data is simply treated as lines of text.
type DSR_Q01 ¶
type DSR_Q01 struct {
HL7 HL7Name `hl7:",name=DSR_Q01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
DSP []DSP `hl7:"9,required,display=Display Data"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Original Mode Display Immediate Response
This section is retained for backward compatibility as of V2.4.
type DSR_Q03 ¶
type DSR_Q03 struct {
HL7 HL7Name `hl7:",name=DSR_Q03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
DSP []DSP `hl7:"9,required,display=Display Data"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Deferred Response to a Query
This section is retained for backward compatibility as of V2.4.
type DT ¶
Date
Specifies the century and year with optional precision to month and day.
Prior to v 2.3, this data type was specified in the format YYYYMMDD. As of v 2.3 month and days are no longer required. By site-specific agreement, YYYYMMDD may be used where backward compatibility must be maintained.
type DTM ¶
Date/Time
Specifies a point in time using a 24-hour clock notation.
Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]]+/-ZZZZ.
type DTN ¶
type DTN struct {
HL7 HL7Name `hl7:",name=DTN,len=6,type=d"`
DayType IS `hl7:"1,required,len=2,table=0149,display=Specifies whether the days are denied- pending- or approved."`
NumberOfDays NM `hl7:"2,required,len=3,display=Specifies the number of days for which the certification is valid."`
}
Day Type and Number
This data type specifies the type and number of days for which a certification is valid.
type EAC_U07 ¶
type EAC_U07 struct {
HL7 HL7Name `hl7:",name=EAC_U07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
Command []EAC_U07_Command `hl7:",required,display=Command"`
ROL *ROL `hl7:"10,display=Role"`
}
Automated Equipment Command
This message is used to send equipment commands from one application to another (e.g., a Laboratory Automation System to automated Equipment).
type EAC_U07_Command ¶
type EAC_U07_Command struct {
HL7 HL7Name `hl7:",name=EAC_U07_Command,type=tg"`
ECD *ECD `hl7:"5,required,display=Equipment Command"`
TQ1 *TQ1 `hl7:"6,display=Timing/Quantity"`
SpecimenContainer *EAC_U07_SpecimenContainer `hl7:",display=Specimen Container"`
CNS *CNS `hl7:"9,display=Clear Notification"`
}
Command
type EAC_U07_SpecimenContainer ¶
type EAC_U07_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=EAC_U07_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"7,required,display=Specimen Container Detail"`
SPM []SPM `hl7:"8,display=Specimen"`
}
SpecimenContainer
type EAN_U09 ¶
type EAN_U09 struct {
HL7 HL7Name `hl7:",name=EAN_U09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
Notification []EAN_U09_Notification `hl7:",required,display=Notification"`
ROL *ROL `hl7:"7,display=Role"`
}
Automated Equipment Notification
This message is used to send equipment notifications from one application to another (e.g., alerts sent by automated equipment to a Laboratory Automation System).
type EAN_U09_Notification ¶
type EAN_U09_Notification struct {
HL7 HL7Name `hl7:",name=EAN_U09_Notification,type=tg"`
NDS *NDS `hl7:"5,required,display=Notification Detail"`
NTE *NTE `hl7:"6,display=Notes and Comments"`
}
Notification
type EAR_U08 ¶
type EAR_U08 struct {
HL7 HL7Name `hl7:",name=EAR_U08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
CommandResponse []EAR_U08_CommandResponse `hl7:",required,display=Command Response"`
ROL *ROL `hl7:"9,display=Role"`
}
Automated Equipment Response
This message is used to send equipment responses to previously issued commands from one application to another (e.g., automated Equipment to a Laboratory Automation System).
type EAR_U08_CommandResponse ¶
type EAR_U08_CommandResponse struct {
HL7 HL7Name `hl7:",name=EAR_U08_CommandResponse,type=tg"`
ECD *ECD `hl7:"5,required,display=Equipment Command"`
SpecimenContainer *EAR_U08_SpecimenContainer `hl7:",display=Specimen Container"`
ECR *ECR `hl7:"8,required,display=Equipment Command Response"`
}
CommandResponse
type EAR_U08_SpecimenContainer ¶
type EAR_U08_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=EAR_U08_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"6,required,display=Specimen Container Detail"`
SPM []SPM `hl7:"7,display=Specimen"`
}
SpecimenContainer
type ECD ¶
type ECD struct {
HL7 HL7Name `hl7:",name=ECD,type=s"`
ReferenceCommandNumber NM `hl7:"1,required,len=20,display=Reference Command Number"`
RemoteControlCommand CWE `hl7:"2,required,len=250,table=0368,display=Remote Control Command"`
ResponseRequired ID `hl7:"3,len=80,table=0136,display=Response Required"`
RequestedCompletionTime TQ `hl7:"4,len=200,display=Requested Completion Time"`
Parameters []TX `hl7:"5,len=65536,display=Parameters"`
}
Equipment Command
The equipment command segment contains the information required to notify the receiving component what is to happen.
type ECR ¶
type ECR struct {
HL7 HL7Name `hl7:",name=ECR,type=s"`
CommandResponse CWE `hl7:"1,required,len=705,table=0387,display=Command Response"`
DateTimeCompleted DTM `hl7:"2,required,len=24,format=YMDHM,display=Date/Time Completed"`
CommandResponseParameters []TX `hl7:"3,len=65536,display=Command Response Parameters"`
}
Equipment Command Response
The equipment command response segment contains the receiving component's response to the previously received command.
type ED ¶
type ED struct {
HL7 HL7Name `hl7:",name=ED,len=65536,type=d"`
SourceApplication *HD `` /* 204-byte string literal not displayed */
TypeOfData ID `` /* 162-byte string literal not displayed */
DataSubtype ID `` /* 143-byte string literal not displayed */
Encoding ID `` /* 199-byte string literal not displayed */
Data TX `` /* 378-byte string literal not displayed */
}
Encapsulated Data
This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference pointer) data type of Section 2.A.65, "RP - reference pointer," except that instead of pointing to the data on another system, it contains the data which is to be sent to that system.
type EDR_R07 ¶
type EDR_R07 struct {
HL7 HL7Name `hl7:",name=EDR_R07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"4,display=Error"`
QAK *QAK `hl7:"5,required,display=Query Acknowledgment"`
DSP []DSP `hl7:"6,required,display=Display Data"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Enhanced Display Response
This section is retained for backward compatibility as of V2.4.
type EDU ¶
type EDU struct {
HL7 HL7Name `hl7:",name=EDU,type=s"`
SetID SI `hl7:"1,seq,required,len=60,display=Set ID – EDU"`
AcademicDegree IS `hl7:"2,len=10,table=0360,display=Academic Degree"`
AcademicDegreeProgramDateRange *DR `hl7:"3,len=52,display=Academic Degree Program Date Range"`
AcademicDegreeProgramParticipationDateRange *DR `hl7:"4,len=52,display=Academic Degree Program Participation Date Range"`
AcademicDegreeGrantedDate DT `hl7:"5,len=8,format=YMD,display=Academic Degree Granted Date"`
School *XON `hl7:"6,len=250,display=School"`
SchoolTypeCode *CWE `hl7:"7,len=250,table=0402,display=School Type Code"`
SchoolAddress *XAD `hl7:"8,len=250,display=School Address"`
MajorFieldOfStudy []CWE `hl7:"9,len=250,display=Major Field of Study"`
}
Educational Detail
The EDU segment adds detailed educational information to the staff member identified by the STF segment. An EDU segment may optionally follow an STF segment. An EDU segment must always have been preceded by a corresponding STF segment.
type EHC_E01 ¶
type EHC_E01 struct {
HL7 HL7Name `hl7:",name=EHC_E01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
InvoiceInformation *EHC_E01_InvoiceInformation `hl7:",required,display=Invoice Information"`
}
Submit HealthCare Services Invoice
This message is used to submit a HealthCare Services Invoice to a TPA/Payer for processing and payment. A HealthCare Services Invoice may have 1 or more Product/Service Line Items (detail lines), grouped as a Product/Service Group. Each Product/Service Line Item represents a specific fee item. Refer to the beginning of this section for more information on the structure of a HealthCare Services Invoice.
type EHC_E01_Diagnosis ¶
type EHC_E01_Diagnosis struct {
HL7 HL7Name `hl7:",name=EHC_E01_Diagnosis,type=tg"`
DG1 *DG1 `hl7:"20,required,display=Diagnosis"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
Diagnosis
type EHC_E01_Insurance ¶
type EHC_E01_Insurance struct {
HL7 HL7Name `hl7:",name=EHC_E01_Insurance,type=tg"`
IN1 *IN1 `hl7:"18,required,display=Insurance"`
IN2 *IN2 `hl7:"19,display=Insurance Additional Information"`
}
Insurance
type EHC_E01_InvoiceInformation ¶
type EHC_E01_InvoiceInformation struct {
HL7 HL7Name `hl7:",name=EHC_E01_InvoiceInformation,type=tg"`
IVC *IVC `hl7:"4,required,display=Invoice"`
PYE *PYE `hl7:"5,display=Payee Information"`
CTD []CTD `hl7:"6,display=Contact Data"`
AUT *AUT `hl7:"7,display=Authorization Information"`
LOC []LOC `hl7:"8,display=Location Identification"`
ROL []ROL `hl7:"9,display=Role"`
ProductServiceSection []EHC_E01_ProductServiceSection `hl7:",required,display=Product Service Section"`
}
InvoiceInformation
type EHC_E01_InvoiceProcessing ¶
type EHC_E01_InvoiceProcessing struct {
HL7 HL7Name `hl7:",name=EHC_E01_InvoiceProcessing,type=tg"`
IPR *IPR `hl7:"32,required,display=Invoice Processing Results"`
}
InvoiceProcessing
type EHC_E01_PatientInfo ¶
type EHC_E01_PatientInfo struct {
HL7 HL7Name `hl7:",name=EHC_E01_PatientInfo,type=tg"`
PID *PID `hl7:"14,required,display=Patient Identification"`
PV1 *PV1 `hl7:"15,display=Patient Visit"`
PV2 *PV2 `hl7:"16,display=Patient Visit - Additional Information"`
ACC []ACC `hl7:"17,display=Accident"`
Insurance []EHC_E01_Insurance `hl7:",required,display=Insurance"`
Diagnosis []EHC_E01_Diagnosis `hl7:",display=Diagnosis"`
OBX []OBX `hl7:"22,display=Observation/Result"`
}
PatientInfo
type EHC_E01_Procedure ¶
type EHC_E01_Procedure struct {
HL7 HL7Name `hl7:",name=EHC_E01_Procedure,type=tg"`
PR1 *PR1 `hl7:"29,required,display=Procedures"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
ROL []ROL `hl7:"31,display=Role"`
}
Procedure
type EHC_E01_ProductServiceGroup ¶
type EHC_E01_ProductServiceGroup struct {
HL7 HL7Name `hl7:",name=EHC_E01_ProductServiceGroup,type=tg"`
PSG *PSG `hl7:"11,required,display=Product/Service Group"`
LOC []LOC `hl7:"12,display=Location Identification"`
ROL []ROL `hl7:"13,display=Role"`
PatientInfo []EHC_E01_PatientInfo `hl7:",display=Patient Info"`
ProductServiceLineItem []EHC_E01_ProductServiceLineItem `hl7:",required,display=Product Service Line Item"`
Procedure []EHC_E01_Procedure `hl7:",display=Procedure"`
InvoiceProcessing []EHC_E01_InvoiceProcessing `hl7:",display=Invoice Processing"`
}
ProductServiceGroup
type EHC_E01_ProductServiceLineItem ¶
type EHC_E01_ProductServiceLineItem struct {
HL7 HL7Name `hl7:",name=EHC_E01_ProductServiceLineItem,type=tg"`
PSL *PSL `hl7:"23,required,display=Product/Service Line Item"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
ADJ []ADJ `hl7:"25,display=Adjustment"`
AUT *AUT `hl7:"26,display=Authorization Information"`
LOC []LOC `hl7:"27,display=Location Identification"`
ROL []ROL `hl7:"28,display=Role"`
}
ProductServiceLineItem
type EHC_E01_ProductServiceSection ¶
type EHC_E01_ProductServiceSection struct {
HL7 HL7Name `hl7:",name=EHC_E01_ProductServiceSection,type=tg"`
PSS *PSS `hl7:"10,required,display=Product/Service Section"`
ProductServiceGroup []EHC_E01_ProductServiceGroup `hl7:",required,display=Product Service Group"`
}
ProductServiceSection
type EHC_E02 ¶
type EHC_E02 struct {
HL7 HL7Name `hl7:",name=EHC_E02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
InvoiceInformation *EHC_E02_InvoiceInformation `hl7:",required,display=Invoice Information"`
}
Cancel HealthCare Services Invoice
This message is used to cancel one HealthCare Services Invoices or one Product/Service Group in an Invoice or one Product/Service Line Item in an Invoice that have previously been submitted to a TPA/Payer for processing and payment. Invoice Control codes are used to indicate the specific action being requested of the Payer (CN for Cancel Invoice, CG for Cancel Product/Service Group and CI for Cancel Product/Service Line Item). An Invoice that is cancelled must be marked as cancel only and not purged from the Payer Application's database.
type EHC_E02_InvoiceInformation ¶
type EHC_E02_InvoiceInformation struct {
HL7 HL7Name `hl7:",name=EHC_E02_InvoiceInformation,type=tg"`
IVC *IVC `hl7:"4,required,display=Invoice"`
PYE *PYE `hl7:"5,required,display=Payee Information"`
CTD []CTD `hl7:"6,display=Contact Data"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
ProductServiceSection []EHC_E02_ProductServiceSection `hl7:",display=Product Service Section"`
}
InvoiceInformation
type EHC_E02_ProductServiceSection ¶
type EHC_E02_ProductServiceSection struct {
HL7 HL7Name `hl7:",name=EHC_E02_ProductServiceSection,type=tg"`
PSS *PSS `hl7:"8,required,display=Product/Service Section"`
Psg []EHC_E02_Psg `hl7:",display=Psg"`
}
ProductServiceSection
type EHC_E02_Psg ¶
type EHC_E02_Psg struct {
HL7 HL7Name `hl7:",name=EHC_E02_Psg,type=tg"`
PSG *PSG `hl7:"9,required,display=Product/Service Group"`
PSL []PSL `hl7:"10,display=Product/Service Line Item"`
}
Psg
type EHC_E04 ¶
type EHC_E04 struct {
HL7 HL7Name `hl7:",name=EHC_E04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
ReassessmentRequestInfo *EHC_E04_ReassessmentRequestInfo `hl7:",required,display=Reassessment Request Info"`
}
Re-Assess HealthCare Services Invoice Request
This message is used to submit a single Re-Assess HealthCare Services Invoice Request to a TPA/Payer for processing. The Re-Assess HealthCare Services Invoice Request is used by a Provider, to request review of a previously adjudicated HealthCare Services Invoice, with optional specification of a Product/Service Line Item within that Invoice. Note that the HealthCare Services Invoice need not necessarily be sent to a TPA/Payer using the EHC^E01 – Submit HealthCare Services Invoice: it may be manually submitted.
type EHC_E04_ProductServiceGroup ¶
type EHC_E04_ProductServiceGroup struct {
HL7 HL7Name `hl7:",name=EHC_E04_ProductServiceGroup,type=tg"`
PSG *PSG `hl7:"7,required,display=Product/Service Group"`
PSL []PSL `hl7:"8,display=Product/Service Line Item"`
}
ProductServiceGroup
type EHC_E04_ProductServiceSection ¶
type EHC_E04_ProductServiceSection struct {
HL7 HL7Name `hl7:",name=EHC_E04_ProductServiceSection,type=tg"`
PSS *PSS `hl7:"6,required,display=Product/Service Section"`
ProductServiceGroup []EHC_E04_ProductServiceGroup `hl7:",display=Product Service Group"`
}
ProductServiceSection
type EHC_E04_ReassessmentRequestInfo ¶
type EHC_E04_ReassessmentRequestInfo struct {
HL7 HL7Name `hl7:",name=EHC_E04_ReassessmentRequestInfo,type=tg"`
IVC *IVC `hl7:"4,required,display=Invoice"`
NTE []NTE `hl7:"5,display=Notes and Comments"`
ProductServiceSection []EHC_E04_ProductServiceSection `hl7:",display=Product Service Section"`
}
ReassessmentRequestInfo
type EHC_E10 ¶
type EHC_E10 struct {
HL7 HL7Name `hl7:",name=EHC_E10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
InvoiceProcessingResultsInfo []EHC_E10_InvoiceProcessingResultsInfo `hl7:",required,display=Invoice Processing Results Info"`
}
Edit/Adjudication Results
This message is used to send edit and/or adjudication results for a HealthCare Services Invoice. Edit/Adjudication results are sent to the same Network Application ID that originated the Invoice, which was specified as the Sending Application on MSH on the original HealthCare Services Invoice.
type EHC_E10_InvoiceProcessingResultsInfo ¶
type EHC_E10_InvoiceProcessingResultsInfo struct {
HL7 HL7Name `hl7:",name=EHC_E10_InvoiceProcessingResultsInfo,type=tg"`
IPR *IPR `hl7:"6,required,display=Invoice Processing Results"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PYE *PYE `hl7:"8,required,display=Payee Information"`
IN1 *IN1 `hl7:"9,required,display=Insurance"`
IN2 *IN2 `hl7:"10,display=Insurance Additional Information"`
IVC *IVC `hl7:"11,required,display=Invoice"`
ProductServiceSection []EHC_E10_ProductServiceSection `hl7:",required,display=Product Service Section"`
}
InvoiceProcessingResultsInfo
type EHC_E10_ProductServiceGroup ¶
type EHC_E10_ProductServiceGroup struct {
HL7 HL7Name `hl7:",name=EHC_E10_ProductServiceGroup,type=tg"`
PSG *PSG `hl7:"13,required,display=Product/Service Group"`
ProductServiceLineInfo []EHC_E10_ProductServiceLineInfo `hl7:",required,display=Product Service Line Info"`
}
ProductServiceGroup
type EHC_E10_ProductServiceLineInfo ¶
type EHC_E10_ProductServiceLineInfo struct {
HL7 HL7Name `hl7:",name=EHC_E10_ProductServiceLineInfo,type=tg"`
PSL *PSL `hl7:"14,required,display=Product/Service Line Item"`
ADJ []ADJ `hl7:"15,display=Adjustment"`
}
ProductServiceLineInfo
type EHC_E10_ProductServiceSection ¶
type EHC_E10_ProductServiceSection struct {
HL7 HL7Name `hl7:",name=EHC_E10_ProductServiceSection,type=tg"`
PSS *PSS `hl7:"12,required,display=Product/Service Section"`
ProductServiceGroup []EHC_E10_ProductServiceGroup `hl7:",required,display=Product Service Group"`
}
ProductServiceSection
type EHC_E12 ¶
type EHC_E12 struct {
HL7 HL7Name `hl7:",name=EHC_E12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
RFI *RFI `hl7:"4,required,display=Request for Information"`
CTD []CTD `hl7:"5,display=Contact Data"`
IVC *IVC `hl7:"6,required,display=Invoice"`
PSS *PSS `hl7:"7,required,display=Product/Service Section"`
PSG *PSG `hl7:"8,required,display=Product/Service Group"`
PID *PID `hl7:"9,display=Patient Identification"`
PSL []PSL `hl7:"10,display=Product/Service Line Item"`
Request []EHC_E12_Request `hl7:",required,display=Request"`
}
Request Additional Information
A Payer or TPA uses this message to request additional information in support of an Invoice or a (Pre) Authorization Request. Normally, this request would be sent following receipt of an E01 or E20 message. However, it can also be sent following receipt of an E04 Re-Assess HealthCare Services Invoice Request. In this latter case the request for additional information still has as its object the original invoice (which is now under review) rather than the Re-assessment request per se.
The E12 can only be used to initiate a request for information and cannot be used to modify, place on hold or cancel an earlier request. This message cannot be used to convey information on the status of a claim and/or adjudication results (i.e., cannot be used in place of an E10 Edit/Adjudication Results message).
type EHC_E12_Request ¶
type EHC_E12_Request struct {
HL7 HL7Name `hl7:",name=EHC_E12_Request,type=tg"`
CTD *CTD `hl7:"11,display=Contact Data"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
NTE *NTE `hl7:"13,display=Notes and Comments"`
OBX []OBX `hl7:"14,display=Observation/Result"`
}
Request
type EHC_E13 ¶
type EHC_E13 struct {
HL7 HL7Name `hl7:",name=EHC_E13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
RFI *RFI `hl7:"6,required,display=Request for Information"`
CTD []CTD `hl7:"7,display=Contact Data"`
IVC *IVC `hl7:"8,required,display=Invoice"`
PSS *PSS `hl7:"9,required,display=Product/Service Section"`
PSG *PSG `hl7:"10,required,display=Product/Service Group"`
PID *PID `hl7:"11,display=Patient Identification"`
PSL *PSL `hl7:"12,display=Product/Service Line Item"`
Request []EHC_E13_Request `hl7:",required,display=Request"`
}
Additional Information Response
This message is used by a Provider to immediately respond to an EHC_E12 Request for Additional Information, in other words an automated response. The EHC_E13 message cannot be sent unsolicited.
type EHC_E13_Request ¶
type EHC_E13_Request struct {
HL7 HL7Name `hl7:",name=EHC_E13_Request,type=tg"`
CTD *CTD `hl7:"13,display=Contact Data"`
OBR *OBR `hl7:"14,required,display=Observation Request"`
NTE *NTE `hl7:"15,display=Notes and Comments"`
Response []EHC_E13_Response `hl7:",required,display=Response"`
}
Request
type EHC_E13_Response ¶
type EHC_E13_Response struct {
HL7 HL7Name `hl7:",name=EHC_E13_Response,type=tg"`
OBX *OBX `hl7:"16,required,display=Observation/Result"`
NTE *NTE `hl7:"17,display=Notes and Comments"`
TXA *TXA `hl7:"18,display=Transcription Document Header"`
}
Response
type EHC_E15 ¶
type EHC_E15 struct {
HL7 HL7Name `hl7:",name=EHC_E15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
PaymentRemittanceHeaderInfo *EHC_E15_PaymentRemittanceHeaderInfo `hl7:",required,display=Payment Remittance Header Info"`
PaymentRemittanceDetailInfo []EHC_E15_PaymentRemittanceDetailInfo `hl7:",display=Payment Remittance Detail Info"`
AdjustmentPayee []EHC_E15_AdjustmentPayee `hl7:",display=Adjustment Payee"`
}
Payment/Remittance Advice
This message is used to send a payment/ remittance advice to a Payee for the payment of HealthCare Services Invoices and/or other adjustments. The Payment/Remittance Advice can be sent to the originating Provider Application (Network Application ID) or alternately to the Payee's Network Application ID, depending on how the Payee has been configured by the Payer. If a Payment/Remittance Advice is paid by check, it typically has a 1 to 1 correspondence with a check number. However, there are occasions when one check number covers multiple Payment/Remittance Advices. This message does not enforce a 1 to 1 relationship between check number and Payment/Remittance Advice. That is, the same check number (Check Number on PMT) can be used on multiple Payment/Remittance Advices.
type EHC_E15_AdjustmentPayee ¶
type EHC_E15_AdjustmentPayee struct {
HL7 HL7Name `hl7:",name=EHC_E15_AdjustmentPayee,type=tg"`
ADJ *ADJ `hl7:"12,required,display=Adjustment"`
ROL *ROL `hl7:"13,display=Role"`
}
AdjustmentPayee
type EHC_E15_PaymentRemittanceDetailInfo ¶
type EHC_E15_PaymentRemittanceDetailInfo struct {
HL7 HL7Name `hl7:",name=EHC_E15_PaymentRemittanceDetailInfo,type=tg"`
IPR *IPR `hl7:"6,required,display=Invoice Processing Results"`
IVC *IVC `hl7:"7,required,display=Invoice"`
ProductServiceSection []EHC_E15_ProductServiceSection `hl7:",required,display=Product Service Section"`
}
PaymentRemittanceDetailInfo
type EHC_E15_PaymentRemittanceHeaderInfo ¶
type EHC_E15_PaymentRemittanceHeaderInfo struct {
HL7 HL7Name `hl7:",name=EHC_E15_PaymentRemittanceHeaderInfo,type=tg"`
PMT *PMT `hl7:"4,required,display=Payment Information"`
PYE *PYE `hl7:"5,required,display=Payee Information"`
}
PaymentRemittanceHeaderInfo
type EHC_E15_ProductServiceGroup ¶
type EHC_E15_ProductServiceGroup struct {
HL7 HL7Name `hl7:",name=EHC_E15_ProductServiceGroup,type=tg"`
PSG *PSG `hl7:"9,required,display=Product/Service Group"`
PslItemInfo []EHC_E15_PslItemInfo `hl7:",required,display=Psl Item Info"`
}
ProductServiceGroup
type EHC_E15_ProductServiceSection ¶
type EHC_E15_ProductServiceSection struct {
HL7 HL7Name `hl7:",name=EHC_E15_ProductServiceSection,type=tg"`
PSS *PSS `hl7:"8,required,display=Product/Service Section"`
ProductServiceGroup []EHC_E15_ProductServiceGroup `hl7:",required,display=Product Service Group"`
}
ProductServiceSection
type EHC_E15_PslItemInfo ¶
type EHC_E15_PslItemInfo struct {
HL7 HL7Name `hl7:",name=EHC_E15_PslItemInfo,type=tg"`
PSL *PSL `hl7:"10,required,display=Product/Service Line Item"`
ADJ []ADJ `hl7:"11,display=Adjustment"`
}
PslItemInfo
type EHC_E20 ¶
type EHC_E20 struct {
HL7 HL7Name `hl7:",name=EHC_E20,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
AuthorizationRequest *EHC_E20_AuthorizationRequest `hl7:",required,display=Authorization Request"`
}
Submit Authorization Request
This message is used to submit a single Authorization Request to a TPA/Payer for authorization (for payment). An Authorization Request is made for one or more patients and may include 1 or more Product/Service Line Items (detail lines), each of which represents a specific, billable item or Payer allowed Treatment Plan.
type EHC_E20_AuthorizationRequest ¶
type EHC_E20_AuthorizationRequest struct {
HL7 HL7Name `hl7:",name=EHC_E20_AuthorizationRequest,type=tg"`
IVC *IVC `hl7:"4,required,display=Invoice"`
CTD []CTD `hl7:"5,required,display=Contact Data"`
LOC []LOC `hl7:"6,display=Location Identification"`
ROL []ROL `hl7:"7,display=Role"`
PatInfo []EHC_E20_PatInfo `hl7:",required,display=Pat Info"`
PslItemInfo []EHC_E20_PslItemInfo `hl7:",required,display=Psl Item Info"`
}
AuthorizationRequest
type EHC_E20_Diagnosis ¶
type EHC_E20_Diagnosis struct {
HL7 HL7Name `hl7:",name=EHC_E20_Diagnosis,type=tg"`
DG1 *DG1 `hl7:"12,required,display=Diagnosis"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Diagnosis
type EHC_E20_Insurance ¶
type EHC_E20_Insurance struct {
HL7 HL7Name `hl7:",name=EHC_E20_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
}
Insurance
type EHC_E20_PatInfo ¶
type EHC_E20_PatInfo struct {
HL7 HL7Name `hl7:",name=EHC_E20_PatInfo,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
ACC []ACC `hl7:"9,display=Accident"`
Insurance []EHC_E20_Insurance `hl7:",required,display=Insurance"`
Diagnosis []EHC_E20_Diagnosis `hl7:",display=Diagnosis"`
OBX []OBX `hl7:"14,display=Observation/Result"`
}
PatInfo
type EHC_E20_PslItemInfo ¶
type EHC_E20_PslItemInfo struct {
HL7 HL7Name `hl7:",name=EHC_E20_PslItemInfo,type=tg"`
PSL *PSL `hl7:"15,required,display=Product/Service Line Item"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
ADJ []ADJ `hl7:"17,display=Adjustment"`
LOC []LOC `hl7:"18,display=Location Identification"`
ROL []ROL `hl7:"19,display=Role"`
}
PslItemInfo
type EHC_E21 ¶
type EHC_E21 struct {
HL7 HL7Name `hl7:",name=EHC_E21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
AuthorizationRequest *EHC_E21_AuthorizationRequest `hl7:",required,display=Authorization Request"`
}
Cancel Authorization Request
This message is used to cancel an Authorization Request, as a result of a previously submitted EHC^E20 – Submit Authorization Request message.
type EHC_E21_AuthorizationRequest ¶
type EHC_E21_AuthorizationRequest struct {
HL7 HL7Name `hl7:",name=EHC_E21_AuthorizationRequest,type=tg"`
IVC *IVC `hl7:"4,required,display=Invoice"`
PslItemInfo []EHC_E21_PslItemInfo `hl7:",required,display=Psl Item Info"`
}
AuthorizationRequest
type EHC_E21_PslItemInfo ¶
type EHC_E21_PslItemInfo struct {
HL7 HL7Name `hl7:",name=EHC_E21_PslItemInfo,type=tg"`
PSL *PSL `hl7:"5,required,display=Product/Service Line Item"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
AUT *AUT `hl7:"7,display=Authorization Information"`
}
PslItemInfo
type EHC_E24 ¶
type EHC_E24 struct {
HL7 HL7Name `hl7:",name=EHC_E24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
AuthorizationResponseInfo *EHC_E24_AuthorizationResponseInfo `hl7:",required,display=Authorization Response Info"`
}
Authorization Response
This message is used to send results of an Authorization Request to a Provider Application. Authorization results are sent to the same Network Application ID that originated the Authorization Request, which was specified as the Sending Application on MSH on the original Authorization Request.
type EHC_E24_AuthorizationResponseInfo ¶
type EHC_E24_AuthorizationResponseInfo struct {
HL7 HL7Name `hl7:",name=EHC_E24_AuthorizationResponseInfo,type=tg"`
IVC *IVC `hl7:"6,required,display=Invoice"`
PslItemInfo []EHC_E24_PslItemInfo `hl7:",required,display=Psl Item Info"`
}
AuthorizationResponseInfo
type EHC_E24_PayerAdjustment ¶
type EHC_E24_PayerAdjustment struct {
HL7 HL7Name `hl7:",name=EHC_E24_PayerAdjustment,type=tg"`
ADJ *ADJ `hl7:"9,required,display=Adjustment"`
}
PayerAdjustment
type EHC_E24_PslItemInfo ¶
type EHC_E24_PslItemInfo struct {
HL7 HL7Name `hl7:",name=EHC_E24_PslItemInfo,type=tg"`
PSL *PSL `hl7:"7,required,display=Product/Service Line Item"`
AUT *AUT `hl7:"8,display=Authorization Information"`
PayerAdjustment []EHC_E24_PayerAdjustment `hl7:",display=Payer Adjustment"`
}
PslItemInfo
type EI ¶
type EI struct {
HL7 HL7Name `hl7:",name=EI,len=427,type=d"`
EntityIdentifier ST `` /* 293-byte string literal not displayed */
NamespaceID IS `` /* 236-byte string literal not displayed */
UniversalID ST `hl7:"3,conditional,len=199,display=Universal Id"`
UniversalIDType ID `hl7:"4,conditional,len=6,table=0301,display=Universal Id Type"`
}
Entity Identifier
The entity identifier defines a given entity within a specified series of identifiers.
type EIP ¶
type EIP struct {
HL7 HL7Name `hl7:",name=EIP,len=855,type=d"`
PlacerAssignedIdentifier *EI `hl7:"1,len=427,display=Specifies an identifier assigned to an entity by the placer system."`
FillerAssignedIdentifier *EI `hl7:"2,len=427,display=Specifies an identifier assigned to an entity by the filler system."`
}
Entity Identifier Pair
Specifies an identifier assigned to an entity by either the placer or the filler system. If both components are populated the identifiers must refer to the same entity.
type ELD ¶
type ELD struct {
HL7 HL7Name `hl7:",name=ELD,len=715,type=d"`
SegmentID ST `hl7:"1,len=3,display=The segment containing the error in another message"`
SegmentSequence NM `` /* 133-byte string literal not displayed */
FieldPosition NM `` /* 186-byte string literal not displayed */
CodeIdentifyingError *CWE `` /* 195-byte string literal not displayed */
}
Error Location and Description
Specifies the segment that contains an error and describes the nature of the error.
type EQL ¶
type EQL struct {
HL7 HL7Name `hl7:",name=EQL,type=s"`
QueryTag ST `hl7:"1,len=32,display=Query Tag"`
QueryResponseFormatCode ID `hl7:"2,required,len=1,table=0106,display=Query/Response Format Code"`
QueryName CE `hl7:"3,required,len=250,display=EQL Query Name"`
QueryStatement ST `hl7:"4,required,len=4096,display=EQL Query Statement"`
}
Embedded Query Language
The EQL segment is used to define queries using select statements based on the query language of choice (e.g., SQL). Refer to the functional chapters for the lists of HL7-defined EQL select statements.
type EQP ¶
type EQP struct {
HL7 HL7Name `hl7:",name=EQP,type=s"`
EventType CWE `hl7:"1,required,len=705,table=0450,display=Event type"`
FileName ST `hl7:"2,len=20,display=File Name"`
StartDateTime DTM `hl7:"3,required,len=24,format=YMDHM,display=Start Date/Time"`
EndDateTime DTM `hl7:"4,len=24,format=YMDHM,display=End Date/Time"`
TransactionData FT `hl7:"5,required,len=65536,display=Transaction Data"`
}
Equipment/log Service
The equipment log/service segment is the data necessary to maintain an adequate audit trail of events that have occurred on a particular piece of equipment.
type EQQ_Q04 ¶
type EQQ_Q04 struct {
HL7 HL7Name `hl7:",name=EQQ_Q04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
EQL *EQL `hl7:"3,required,display=Embedded Query Language"`
DSC *DSC `hl7:"4,display=Continuation Pointer"`
}
Embedded Query Language Query
This section is retained for backward compatibility as of V2.4.
This query provides an envelope with which a query expressed in a language (e.g., SQL) is packaged and sent to the responding system. It is meant to provide the maximum query function without reinventing the wheel.
The EQQ with its EQL query defining segment supports free-form select statements, based on the query language of choice (e.g., SQL).
type EQU ¶
type EQU struct {
HL7 HL7Name `hl7:",name=EQU,type=s"`
EquipmentInstanceIdentifier EI `hl7:"1,required,len=427,display=Equipment Instance Identifier"`
EventDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Event Date/Time"`
EquipmentState *CWE `hl7:"3,conditional,len=705,table=0365,display=Equipment State"`
LocalRemoteControlState *CWE `hl7:"4,len=705,table=0366,display=Local/Remote Control State"`
AlertLevel *CWE `hl7:"5,len=705,table=0367,display=Alert Level"`
}
Equipment Detail
The equipment detail segment contains the data necessary to identify and maintain the equipment that is being used throughout the Laboratory Automation System.
type ERL ¶
type ERL struct {
HL7 HL7Name `hl7:",name=ERL,len=18,type=d"`
SegmentID ST `hl7:"1,required,len=3,display=Specifies the 3-letter name for the segment."`
SegmentSequence NM `hl7:"2,required,len=2,display=Identifies the segment occurrence within the message."`
FieldPosition NM `` /* 194-byte string literal not displayed */
FieldRepetition NM `` /* 291-byte string literal not displayed */
ComponentNumber NM `` /* 202-byte string literal not displayed */
SubComponentNumber NM `` /* 222-byte string literal not displayed */
}
Error Location
This data type identifies the segment and its constituent where an error has occurred.
type ERP_R09 ¶
type ERP_R09 struct {
HL7 HL7Name `hl7:",name=ERP_R09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"4,display=Error"`
QAK *QAK `hl7:"5,required,display=Query Acknowledgment"`
ERQ *ERQ `hl7:"6,required,display=Event replay query"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Event Replay Response
This section is retained for backward compatibility as of V2.4.
type ERQ ¶
type ERQ struct {
HL7 HL7Name `hl7:",name=ERQ,type=s"`
QueryTag ST `hl7:"1,len=32,display=Query Tag"`
EventIdentifier CE `hl7:"2,required,len=250,display=Event Identifier"`
InputParameterList []QIP `hl7:"3,len=256,display=Input Parameter List"`
}
Event replay query
The ERQ segment is used to issue queries where the desired response is formatted as an event replay response message. This enables the querying application to request detailed event data from an application that supports this feature, such that it may no longer be necessary for it to capture and store all event information at the time of the original trigger event.
type ERR ¶
type ERR struct {
HL7 HL7Name `hl7:",name=ERR,type=s"`
ErrorCodeAndLocation []ELD `hl7:"1,len=493,display=Error Code and Location"`
ErrorLocation []ERL `hl7:"2,len=18,display=Error Location"`
HL7ErrorCode CWE `hl7:"3,required,len=705,table=0357,display=HL7 Error Code"`
Severity ID `hl7:"4,required,len=2,table=0516,display=Severity"`
ApplicationErrorCode *CWE `hl7:"5,len=705,table=0533,display=Application Error Code"`
ApplicationErrorParameter []ST `hl7:"6,max=10,len=80,display=Application Error Parameter"`
DiagnosticInformation TX `hl7:"7,len=2048,display=Diagnostic Information"`
UserMessage TX `hl7:"8,len=250,display=User Message"`
InformPersonIndicator []IS `hl7:"9,len=20,table=0517,display=Inform Person Indicator"`
OverrideType *CWE `hl7:"10,len=705,table=0518,display=Override Type"`
OverrideReasonCode []CWE `hl7:"11,len=705,table=0519,display=Override Reason Code"`
HelpDeskContactPoint []XTN `hl7:"12,len=652,display=Help Desk Contact Point"`
}
Error
The ERR segment is used to add error comments to acknowledgment messages.
type ESR_U02 ¶
type ESR_U02 struct {
HL7 HL7Name `hl7:",name=ESR_U02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
ROL *ROL `hl7:"5,display=Role"`
}
Automated Equipment Status Request
This message is used to send information concerning the location and status of specimens from one application to another (e.g., automated equipment to a Laboratory Automation System). The OBX segments attached to the SAC should be used for transfer of information not included in the SAC segment.
type ESU_U01 ¶
type ESU_U01 struct {
HL7 HL7Name `hl7:",name=ESU_U01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
ISD []ISD `hl7:"5,display=Interaction Status Detail"`
ROL *ROL `hl7:"6,display=Role"`
}
Automated Equipment Status Update
This message is used to send information about the status of a device or equipment from one application to another (e.g., automated device to a Laboratory Automation System). The status update can be sent unsolicited or as a response to the trigger "Automated Equipment Status Request."
type EVN ¶
type EVN struct {
HL7 HL7Name `hl7:",name=EVN,type=s"`
EventTypeCode ID `hl7:"1,len=3,table=0003,display=Event Type Code"`
RecordedDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Recorded Date/Time"`
DateTimePlannedEvent DTM `hl7:"3,len=24,format=YMDHM,display=Date/Time Planned Event"`
EventReasonCode IS `hl7:"4,len=3,table=0062,display=Event Reason Code"`
OperatorID []XCN `hl7:"5,len=250,table=0188,display=Operator ID"`
EventOccurred DTM `hl7:"6,len=24,format=YMDHM,display=Event Occurred"`
EventFacility *HD `hl7:"7,len=241,display=Event Facility"`
}
Event Type
The EVN segment is used to communicate necessary trigger event information to receiving applications. Valid event types for all chapters are contained in HL7 Table 0003 - Event Type.
type FAC ¶
type FAC struct {
HL7 HL7Name `hl7:",name=FAC,type=s"`
FacilityID EI `hl7:"1,required,len=427,display=Facility ID-FAC"`
FacilityType ID `hl7:"2,len=1,table=0331,display=Facility Type"`
FacilityAddress []XAD `hl7:"3,required,len=2915,display=Facility Address"`
FacilityTelecommunication XTN `hl7:"4,required,len=2743,display=Facility Telecommunication"`
ContactPerson []XCN `hl7:"5,len=3220,display=Contact Person"`
ContactTitle []ST `hl7:"6,len=60,display=Contact Title"`
ContactAddress []XAD `hl7:"7,len=2915,display=Contact Address"`
ContactTelecommunication []XTN `hl7:"8,len=2743,display=Contact Telecommunication"`
SignatureAuthority []XCN `hl7:"9,required,len=3220,display=Signature Authority"`
SignatureAuthorityTitle ST `hl7:"10,len=199,display=Signature Authority Title"`
SignatureAuthorityAddress []XAD `hl7:"11,len=2915,display=Signature Authority Address"`
SignatureAuthorityTelecommunication *XTN `hl7:"12,len=2743,display=Signature Authority Telecommunication"`
}
Facility
type FC ¶
type FC struct {
HL7 HL7Name `hl7:",name=FC,len=45,type=d"`
FinancialClassCode IS `` /* 237-byte string literal not displayed */
EffectiveDate DTM `` /* 166-byte string literal not displayed */
}
Financial Class
type FHS ¶
type FHS struct {
HL7 HL7Name `hl7:",name=FHS,type=s"`
FileFieldSeparator ST `hl7:"1,required,len=1,display=File Field Separator"`
FileEncodingCharacters ST `hl7:"2,required,len=4,display=File Encoding Characters"`
FileSendingApplication *HD `hl7:"3,len=227,display=File Sending Application"`
FileSendingFacility *HD `hl7:"4,len=227,display=File Sending Facility"`
FileReceivingApplication *HD `hl7:"5,len=227,display=File Receiving Application"`
FileReceivingFacility *HD `hl7:"6,len=227,display=File Receiving Facility"`
FileCreationDateTime DTM `hl7:"7,len=24,format=YMDHM,display=File Creation Date/Time"`
FileSecurity ST `hl7:"8,len=40,display=File Security"`
FileNameID ST `hl7:"9,len=20,display=File Name/ID"`
FileHeaderComment ST `hl7:"10,len=80,display=File Header Comment"`
FileControlID ST `hl7:"11,len=20,display=File Control ID"`
ReferenceFileControlID ST `hl7:"12,len=20,display=Reference File Control ID"`
FileSendingNetworkAddress *HD `hl7:"13,len=227,display=File Sending Network Address"`
FileReceivingNetworkAddress *HD `hl7:"14,len=227,display=File Receiving Network Address"`
}
File Header
The FHS segment is used to head a file (group of batches) as defined in Section 2.10.3, "HL7 batch protocol".
type FN ¶
type FN = string
Family Name
This data type allows full specification of the surname of a person. Where appropriate, it differentiates the person's own surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name. It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root.
type FT ¶
type FT = string
Formatted Text Data
This data type is derived from the TX data type by allowing the addition of embedded formatting instructions. These instructions are limited to those that are intrinsic and independent of the circumstances under which the field is being used. The actual instructions and their representation are described in section 2.7.6, Usage and Examples of Formatted Text. The FT field is of arbitrary length (up to 64k) and may contain formatting commands enclosed in escape characters.
type FT1 ¶
type FT1 struct {
HL7 HL7Name `hl7:",name=FT1,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - FT1"`
TransactionID ST `hl7:"2,len=12,display=Transaction ID"`
TransactionBatchID ST `hl7:"3,len=10,display=Transaction Batch ID"`
TransactionDate DR `hl7:"4,required,len=53,display=Transaction Date"`
TransactionPostingDate DTM `hl7:"5,len=24,format=YMDHM,display=Transaction Posting Date"`
TransactionType IS `hl7:"6,required,len=8,table=0017,display=Transaction Type"`
TransactionCode CWE `hl7:"7,required,len=250,table=0132,display=Transaction Code"`
TransactionDescription ST `hl7:"8,display=Transaction Description"`
TransactionDescriptionAlt ST `hl7:"9,display=Transaction Description - Alt"`
TransactionQuantity NM `hl7:"10,len=6,display=Transaction Quantity"`
TransactionAmountExtended *CP `hl7:"11,len=12,display=Transaction Amount - Extended"`
TransactionAmountUnit *CP `hl7:"12,len=12,display=Transaction Amount - Unit"`
DepartmentCode *CWE `hl7:"13,len=250,table=0049,display=Department Code"`
InsurancePlanID *CWE `hl7:"14,len=250,table=0072,display=Insurance Plan ID"`
InsuranceAmount *CP `hl7:"15,len=12,display=Insurance Amount"`
AssignedPatientLocation *PL `hl7:"16,len=80,display=Assigned Patient Location"`
FeeSchedule IS `hl7:"17,len=1,table=0024,display=Fee Schedule"`
PatientType IS `hl7:"18,len=2,table=0018,display=Patient Type"`
DiagnosisCode []CWE `hl7:"19,len=250,table=0051,display=Diagnosis Code - FT1"`
PerformedByCode []XCN `hl7:"20,len=250,table=0084,display=Performed By Code"`
OrderedByCode []XCN `hl7:"21,len=250,display=Ordered By Code"`
UnitCost *CP `hl7:"22,len=12,display=Unit Cost"`
FillerOrderNumber *EI `hl7:"23,len=427,display=Filler Order Number"`
EnteredByCode []XCN `hl7:"24,len=250,display=Entered By Code"`
ProcedureCode *CNE `hl7:"25,len=705,table=0088,display=Procedure Code"`
ProcedureCodeModifier []CNE `hl7:"26,len=705,table=0340,display=Procedure Code Modifier"`
AdvancedBeneficiaryNoticeCode *CWE `hl7:"27,len=250,table=0339,display=Advanced Beneficiary Notice Code"`
MedicallyNecessaryDuplicateProcedureReason *CWE `hl7:"28,len=705,table=0476,display=Medically Necessary Duplicate Procedure Reason."`
NDCCode *CWE `hl7:"29,len=250,table=0549,display=NDC Code"`
PaymentReferenceID *CX `hl7:"30,len=250,display=Payment Reference ID"`
TransactionReferenceKey []SI `hl7:"31,len=4,display=Transaction Reference Key"`
}
Financial Transaction
The FT1 segment contains the detail data necessary to post charges, payments, adjustments, etc., to patient accounting records.
type FTS ¶
type FTS struct {
HL7 HL7Name `hl7:",name=FTS,type=s"`
FileBatchCount NM `hl7:"1,len=10,display=File Batch Count"`
FileTrailerComment ST `hl7:"2,len=80,display=File Trailer Comment"`
}
File Trailer
The FTS segment defines the end of a file.
type GOL ¶
type GOL struct {
HL7 HL7Name `hl7:",name=GOL,type=s"`
ActionCode ID `hl7:"1,required,len=2,table=0287,display=Action Code"`
ActionDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Action Date/Time"`
GoalID CWE `hl7:"3,required,len=705,display=Goal ID"`
GoalInstanceID EI `hl7:"4,required,len=60,display=Goal Instance ID"`
EpisodeOfCareID *EI `hl7:"5,len=60,display=Episode of Care ID"`
GoalListPriority NM `hl7:"6,len=60,display=Goal List Priority"`
GoalEstablishedDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Goal Established Date/Time"`
ExpectedGoalAchieveDateTime DTM `hl7:"8,len=24,format=YMDHM,display=Expected Goal Achieve Date/Time"`
GoalClassification *CWE `hl7:"9,len=705,display=Goal Classification"`
GoalManagementDiscipline *CWE `hl7:"10,len=705,display=Goal Management Discipline"`
CurrentGoalReviewStatus *CWE `hl7:"11,len=705,display=Current Goal Review Status"`
CurrentGoalReviewDateTime DTM `hl7:"12,len=24,format=YMDHM,display=Current Goal Review Date/Time"`
NextGoalReviewDateTime DTM `hl7:"13,len=24,format=YMDHM,display=Next Goal Review Date/Time"`
PreviousGoalReviewDateTime DTM `hl7:"14,len=24,format=YMDHM,display=Previous Goal Review Date/Time"`
GoalReviewInterval *TQ `hl7:"15,len=200,display=Goal Review Interval"`
GoalEvaluation *CWE `hl7:"16,len=705,display=Goal Evaluation"`
GoalEvaluationComment []ST `hl7:"17,len=300,display=Goal Evaluation Comment"`
GoalLifeCycleStatus *CWE `hl7:"18,len=705,display=Goal Life Cycle Status"`
GoalLifeCycleStatusDateTime DTM `hl7:"19,len=24,format=YMDHM,display=Goal Life Cycle Status Date/Time"`
GoalTargetType []CWE `hl7:"20,len=705,display=Goal Target Type"`
GoalTargetName []XPN `hl7:"21,len=250,display=Goal Target Name"`
MoodCode *CNE `hl7:"22,conditional,len=705,table=0725,display=Mood Code"`
}
Goal Detail
The goal detail segment contains the data necessary to add, update, correct, and delete the goals for an individual.
type GP1 ¶
type GP1 struct {
HL7 HL7Name `hl7:",name=GP1,type=s"`
TypeOfBillCode IS `hl7:"1,required,len=3,table=0455,display=Type of Bill Code"`
RevenueCode []IS `hl7:"2,len=3,table=0456,display=Revenue Code"`
OverallClaimDispositionCode IS `hl7:"3,len=1,table=0457,display=Overall Claim Disposition Code"`
OCEEditsPerVisitCode []IS `hl7:"4,len=2,table=0458,display=OCE Edits per Visit Code"`
OutlierCost *CP `hl7:"5,len=12,display=Outlier Cost"`
}
Grouping/Reimbursement - Visit
These fields are used in grouping and reimbursement for CMS APCs. Please refer to the "Outpatient Prospective Payment System Final Rule" ("OPPS Final Rule") issued by CMS.
The GP1 segment is specific to the US and may not be implemented in non-US systems.
type GP2 ¶
type GP2 struct {
HL7 HL7Name `hl7:",name=GP2,type=s"`
RevenueCode IS `hl7:"1,len=3,table=0456,display=Revenue Code"`
NumberOfServiceUnits NM `hl7:"2,len=7,display=Number of Service Units"`
Charge *CP `hl7:"3,len=12,display=Charge"`
ReimbursementActionCode IS `hl7:"4,len=1,table=0459,display=Reimbursement Action Code"`
DenialOrRejectionCode IS `hl7:"5,len=1,table=0460,display=Denial or Rejection Code"`
OCEEditCode []IS `hl7:"6,len=3,table=0458,display=OCE Edit Code"`
AmbulatoryPaymentClassificationCode *CWE `hl7:"7,len=250,table=0466,display=Ambulatory Payment Classification Code"`
ModifierEditCode []IS `hl7:"8,len=1,table=0467,display=Modifier Edit Code"`
PaymentAdjustmentCode IS `hl7:"9,len=1,table=0468,display=Payment Adjustment Code"`
PackagingStatusCode IS `hl7:"10,len=1,table=0469,display=Packaging Status Code"`
ExpectedCMSPaymentAmount *CP `hl7:"11,len=12,display=Expected CMS Payment Amount"`
ReimbursementTypeCode IS `hl7:"12,len=2,table=0470,display=Reimbursement Type Code"`
CoPayAmount *CP `hl7:"13,len=12,display=Co-Pay Amount"`
PayRatePerServiceUnit NM `hl7:"14,len=4,display=Pay Rate per Service Unit"`
}
Grouping/Reimbursement - Procedure Line Item
This segment is used for items that pertain to each HCPC/CPT line item.
The GP2 segment is specific to the US and may not be implemented in non-US systems.
type GT1 ¶
type GT1 struct {
HL7 HL7Name `hl7:",name=GT1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - GT1"`
GuarantorNumber []CX `hl7:"2,len=250,display=Guarantor Number"`
GuarantorName []XPN `hl7:"3,required,len=250,display=Guarantor Name"`
GuarantorSpouseName []XPN `hl7:"4,len=250,display=Guarantor Spouse Name"`
GuarantorAddress []XAD `hl7:"5,len=250,display=Guarantor Address"`
GuarantorPhNumHome []XTN `hl7:"6,len=250,display=Guarantor Ph Num - Home"`
GuarantorPhNumBusiness []XTN `hl7:"7,len=250,display=Guarantor Ph Num - Business"`
GuarantorDateTimeOfBirth DTM `hl7:"8,len=24,format=YMDHM,display=Guarantor Date/Time Of Birth"`
GuarantorAdministrativeSex IS `hl7:"9,len=1,table=0001,display=Guarantor Administrative Sex"`
GuarantorType IS `hl7:"10,len=2,table=0068,display=Guarantor Type"`
GuarantorRelationship *CWE `hl7:"11,len=250,table=0063,display=Guarantor Relationship"`
GuarantorSSN ST `hl7:"12,len=11,display=Guarantor SSN"`
GuarantorDateBegin DT `hl7:"13,len=8,format=YMD,display=Guarantor Date - Begin"`
GuarantorDateEnd DT `hl7:"14,len=8,format=YMD,display=Guarantor Date - End"`
GuarantorPriority NM `hl7:"15,len=2,display=Guarantor Priority"`
GuarantorEmployerName []XPN `hl7:"16,len=250,display=Guarantor Employer Name"`
GuarantorEmployerAddress []XAD `hl7:"17,len=250,display=Guarantor Employer Address"`
GuarantorEmployerPhoneNumber []XTN `hl7:"18,len=250,display=Guarantor Employer Phone Number"`
GuarantorEmployeeIDNumber []CX `hl7:"19,len=250,display=Guarantor Employee ID Number"`
GuarantorEmploymentStatus IS `hl7:"20,len=2,table=0066,display=Guarantor Employment Status"`
GuarantorOrganizationName []XON `hl7:"21,len=250,display=Guarantor Organization Name"`
GuarantorBillingHoldFlag ID `hl7:"22,len=1,table=0136,display=Guarantor Billing Hold Flag"`
GuarantorCreditRatingCode *CWE `hl7:"23,len=250,table=0341,display=Guarantor Credit Rating Code"`
GuarantorDeathDateAndTime DTM `hl7:"24,len=24,format=YMDHM,display=Guarantor Death Date And Time"`
GuarantorDeathFlag ID `hl7:"25,len=1,table=0136,display=Guarantor Death Flag"`
GuarantorChargeAdjustmentCode *CWE `hl7:"26,len=250,table=0218,display=Guarantor Charge Adjustment Code"`
GuarantorHouseholdAnnualIncome *CP `hl7:"27,len=10,display=Guarantor Household Annual Income"`
GuarantorHouseholdSize NM `hl7:"28,len=3,display=Guarantor Household Size"`
GuarantorEmployerIDNumber []CX `hl7:"29,len=250,display=Guarantor Employer ID Number"`
GuarantorMaritalStatusCode *CWE `hl7:"30,len=250,table=0002,display=Guarantor Marital Status Code"`
GuarantorHireEffectiveDate DT `hl7:"31,len=8,format=YMD,display=Guarantor Hire Effective Date"`
EmploymentStopDate DT `hl7:"32,len=8,format=YMD,display=Employment Stop Date"`
LivingDependency IS `hl7:"33,len=2,table=0223,display=Living Dependency"`
AmbulatoryStatus []IS `hl7:"34,len=2,table=0009,display=Ambulatory Status"`
Citizenship []CWE `hl7:"35,len=705,table=0171,display=Citizenship"`
PrimaryLanguage *CWE `hl7:"36,len=705,table=0296,display=Primary Language"`
LivingArrangement IS `hl7:"37,len=2,table=0220,display=Living Arrangement"`
PublicityCode *CWE `hl7:"38,len=705,table=0215,display=Publicity Code"`
ProtectionIndicator ID `hl7:"39,len=1,table=0136,display=Protection Indicator"`
StudentIndicator IS `hl7:"40,len=2,table=0231,display=Student Indicator"`
Religion *CWE `hl7:"41,len=705,table=0006,display=Religion"`
MothersMaidenName []XPN `hl7:"42,len=250,display=Mother's Maiden Name"`
Nationality *CWE `hl7:"43,len=705,table=0212,display=Nationality"`
EthnicGroup []CWE `hl7:"44,len=705,table=0189,display=Ethnic Group"`
ContactPersonsName []XPN `hl7:"45,len=250,display=Contact Person's Name"`
ContactPersonsTelephoneNumber []XTN `hl7:"46,len=250,display=Contact Person's Telephone Number"`
ContactReason *CWE `hl7:"47,len=705,table=0212,display=Contact Reason"`
ContactRelationship IS `hl7:"48,len=3,table=0063,display=Contact Relationship"`
JobTitle ST `hl7:"49,len=20,display=Job Title"`
JobCodeClass *JCC `hl7:"50,len=20,display=Job Code/Class"`
GuarantorEmployersOrganizationName []XON `hl7:"51,len=250,display=Guarantor Employer's Organization Name"`
Handicap IS `hl7:"52,len=2,table=0295,display=Handicap"`
JobStatus IS `hl7:"53,len=2,table=0311,display=Job Status"`
GuarantorFinancialClass *FC `hl7:"54,len=50,display=Guarantor Financial Class"`
GuarantorRace []CWE `hl7:"55,len=250,table=0005,display=Guarantor Race"`
GuarantorBirthPlace ST `hl7:"56,len=250,display=Guarantor Birth Place"`
VIPIndicator IS `hl7:"57,len=2,table=0099,display=VIP Indicator"`
}
Guarantor
The GT1 segment contains guarantor (e.g., the person or the organization with financial responsibility for payment of a patient account) data for patient and insurance billing applications.
type GTS ¶
type GTS = string
General Timing Specification
The General Timing Specification data type is used to communicate complex inter-related information Timing information. The value of such a field follows the formatting rules for a ST field. The string data will be structured according to the rules set forth in the "Version 3 Data Types Part II Unabridged Specification" for the General Timing Specification (GTS) data type.
type HD ¶
type HD struct {
HL7 HL7Name `hl7:",name=HD,len=1027,type=d"`
NamespaceID IS `` /* 133-byte string literal not displayed */
UniversalID ST `` /* 706-byte string literal not displayed */
UniversalIDType ID `` /* 284-byte string literal not displayed */
}
Hierarchic Designator
The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or drivers license numbers, or a facility where such identifiers are assigned.
type IAM ¶
type IAM struct {
HL7 HL7Name `hl7:",name=IAM,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - IAM"`
AllergenTypeCode *CWE `hl7:"2,len=705,table=0127,display=Allergen Type Code"`
AllergenCodeMnemonicDescription CWE `hl7:"3,required,len=705,display=Allergen Code/Mnemonic/Description"`
AllergySeverityCode *CWE `hl7:"4,len=705,table=0128,display=Allergy Severity Code"`
AllergyReactionCode []ST `hl7:"5,len=15,display=Allergy Reaction Code"`
AllergyActionCode CNE `hl7:"6,required,len=250,table=0206,display=Allergy Action Code"`
AllergyUniqueIdentifier *EI `hl7:"7,conditional,len=427,display=Allergy Unique Identifier"`
ActionReason ST `hl7:"8,len=60,display=Action Reason"`
SensitivityToCausativeAgentCode *CWE `hl7:"9,len=705,table=0436,display=Sensitivity to Causative Agent Code"`
AllergenGroupCodeMnemonicDescription *CWE `hl7:"10,len=705,display=Allergen Group Code/Mnemonic/Description"`
OnsetDate DT `hl7:"11,len=8,format=YMD,display=Onset Date"`
OnsetDateText ST `hl7:"12,len=60,display=Onset Date Text"`
ReportedDateTime DTM `hl7:"13,len=8,format=YMDHM,display=Reported Date/Time"`
ReportedBy *XPN `hl7:"14,len=250,display=Reported By"`
RelationshipToPatientCode *CWE `hl7:"15,len=705,table=0063,display=Relationship to Patient Code"`
AlertDeviceCode *CWE `hl7:"16,len=705,table=0437,display=Alert Device Code"`
AllergyClinicalStatusCode *CWE `hl7:"17,len=705,table=0438,display=Allergy Clinical Status Code"`
StatusedByPerson *XCN `hl7:"18,len=250,display=Statused by Person"`
StatusedByOrganization *XON `hl7:"19,len=250,display=Statused by Organization"`
StatusedAtDateTime DTM `hl7:"20,len=8,format=YMDHM,display=Statused at Date/Time"`
}
Patient Adverse Reaction Information
The IAM segment contains person/patient adverse reaction information of various types. Most of this information will be derived from user-defined tables. Each IAM segment describes a single person/patient adverse reaction. This segment is used in lieu of the AL1 - Patient Allergy Information Segment to support action code/unique identifier mode update definition of repeating segments as defined in 2.10.4.2 in chapter 2, section 2.4.10, "Protocol for interpreting repeating segments or segment groups in an update Message." The AL1 segment is used to support Snapshot mode update definition as defined in 2.10.4.1.
type ICD ¶
type ICD struct {
HL7 HL7Name `hl7:",name=ICD,len=38,type=d"`
CertificationPatientType IS `` /* 202-byte string literal not displayed */
CertificationRequired ID `` /* 156-byte string literal not displayed */
DateTimeCertificationRequired DTM `hl7:"3,len=24,format=YMDHM,display=The date/time by which the certification must be obtained."`
}
Insurance Certification Definition
This data type specifies whether insurance certification is required for particular patient types, and the time window for obtaining the certification.
type ID ¶
type ID = string
Coded values for HL7 tables
The value of such a field follows the formatting rules for an ST field except that it is drawn from a table of legal values. There shall be an HL7 table number associated with ID data types. An example of an ID field is OBR-25-result status. This data type should be used only for HL7 tables (see section 2.5.3.6, "Table"). The reverse is not true, since in some circumstances it is more appropriate to use the CNE or CWE data type for HL7 tables.
Maximum Length: Varies - dependent on length of longest code in code set.
type IIM ¶
type IIM struct {
HL7 HL7Name `hl7:",name=IIM,type=s"`
PrimaryKeyValue CWE `hl7:"1,required,len=250,display=Primary Key Value - IIM"`
ServiceItemCode CWE `hl7:"2,required,len=250,display=Service Item Code"`
InventoryLotNumber ST `hl7:"3,len=250,display=Inventory Lot Number"`
InventoryExpirationDate DTM `hl7:"4,len=24,format=YMDHM,display=Inventory Expiration Date"`
InventoryManufacturerName *CWE `hl7:"5,len=250,display=Inventory Manufacturer Name"`
InventoryLocation *CWE `hl7:"6,len=250,display=Inventory Location"`
InventoryReceivedDate DTM `hl7:"7,len=24,format=YMDHM,display=Inventory Received Date"`
InventoryReceivedQuantity NM `hl7:"8,len=12,display=Inventory Received Quantity"`
InventoryReceivedQuantityUnit *CWE `hl7:"9,len=250,display=Inventory Received Quantity Unit"`
InventoryReceivedItemCost *MO `hl7:"10,len=12,display=Inventory Received Item Cost"`
InventoryOnHandDate DTM `hl7:"11,len=24,format=YMDHM,display=Inventory On Hand Date"`
InventoryOnHandQuantity NM `hl7:"12,len=12,display=Inventory On Hand Quantity"`
InventoryOnHandQuantityUnit *CWE `hl7:"13,len=250,display=Inventory On Hand Quantity Unit"`
ProcedureCode *CNE `hl7:"14,len=705,table=0088,display=Procedure Code"`
ProcedureCodeModifier []CNE `hl7:"15,len=705,table=0340,display=Procedure Code Modifier"`
}
Inventory Item Master
The Inventory Item Master segment (IIM) contains information about the stock of product that can be used to fulfill an ordered test/service. All of the fields in this segment describe the test/service and other basic attributes pertaining to Service Item defined within an Other Observation/Service Item master file. This segment is related to centrally stocked or supply management concerns.
type ILT ¶
type ILT struct {
HL7 HL7Name `hl7:",name=ILT,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set Id - ILT"`
InventoryLotNumber ST `hl7:"2,required,len=250,display=Inventory Lot Number"`
InventoryExpirationDate DTM `hl7:"3,len=24,format=YMDHM,display=Inventory Expiration Date"`
InventoryReceivedDate DTM `hl7:"4,len=24,format=YMDHM,display=Inventory Received Date"`
InventoryReceivedQuantity NM `hl7:"5,len=12,display=Inventory Received Quantity"`
InventoryReceivedQuantityUnit *CWE `hl7:"6,len=250,display=Inventory Received Quantity Unit"`
InventoryReceivedItemCost *MO `hl7:"7,len=12,display=Inventory Received Item Cost"`
InventoryOnHandDate DTM `hl7:"8,len=24,format=YMDHM,display=Inventory On Hand Date"`
InventoryOnHandQuantity NM `hl7:"9,len=12,display=Inventory On Hand Quantity"`
InventoryOnHandQuantityUnit *CWE `hl7:"10,len=250,display=Inventory On Hand Quantity Unit"`
}
Material Lot Segment
The Material Lot segment (ILT) contains material information specific to a lot within an inventory location associated with the item in the IVT segment. This segment is similar to the IIM segment used with the limited inventory item master message.
type IN1 ¶
type IN1 struct {
HL7 HL7Name `hl7:",name=IN1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - IN1"`
InsurancePlanID CWE `hl7:"2,required,len=250,table=0072,display=Insurance Plan ID"`
InsuranceCompanyID []CX `hl7:"3,required,len=250,display=Insurance Company ID"`
InsuranceCompanyName []XON `hl7:"4,len=250,display=Insurance Company Name"`
InsuranceCompanyAddress []XAD `hl7:"5,len=250,display=Insurance Company Address"`
InsuranceCoContactPerson []XPN `hl7:"6,len=250,display=Insurance Co Contact Person"`
InsuranceCoPhoneNumber []XTN `hl7:"7,len=250,display=Insurance Co Phone Number"`
GroupNumber ST `hl7:"8,len=12,display=Group Number"`
GroupName []XON `hl7:"9,len=250,display=Group Name"`
InsuredsGroupEmpID []CX `hl7:"10,len=250,display=Insured's Group Emp ID"`
InsuredsGroupEmpName []XON `hl7:"11,len=250,display=Insured's Group Emp Name"`
PlanEffectiveDate DT `hl7:"12,len=8,format=YMD,display=Plan Effective Date"`
PlanExpirationDate DT `hl7:"13,len=8,format=YMD,display=Plan Expiration Date"`
AuthorizationInformation *AUI `hl7:"14,len=239,display=Authorization Information"`
PlanType IS `hl7:"15,len=3,table=0086,display=Plan Type"`
NameOfInsured []XPN `hl7:"16,len=250,display=Name Of Insured"`
InsuredsRelationshipToPatient *CWE `hl7:"17,len=250,table=0063,display=Insured's Relationship To Patient"`
InsuredsDateOfBirth DTM `hl7:"18,len=24,format=YMDHM,display=Insured's Date Of Birth"`
InsuredsAddress []XAD `hl7:"19,len=250,display=Insured's Address"`
AssignmentOfBenefits IS `hl7:"20,len=2,table=0135,display=Assignment Of Benefits"`
CoordinationOfBenefits IS `hl7:"21,len=2,table=0173,display=Coordination Of Benefits"`
CoordOfBenPriority ST `hl7:"22,len=2,display=Coord Of Ben. Priority"`
NoticeOfAdmissionFlag ID `hl7:"23,len=1,table=0136,display=Notice Of Admission Flag"`
NoticeOfAdmissionDate DT `hl7:"24,len=8,format=YMD,display=Notice Of Admission Date"`
ReportOfEligibilityFlag ID `hl7:"25,len=1,table=0136,display=Report Of Eligibility Flag"`
ReportOfEligibilityDate DT `hl7:"26,len=8,format=YMD,display=Report Of Eligibility Date"`
ReleaseInformationCode IS `hl7:"27,len=2,table=0093,display=Release Information Code"`
PreAdmitCertPAC ST `hl7:"28,len=15,display=Pre-Admit Cert (PAC)"`
VerificationDateTime DTM `hl7:"29,len=24,format=YMDHM,display=Verification Date/Time"`
VerificationBy []XCN `hl7:"30,len=250,display=Verification By"`
TypeOfAgreementCode IS `hl7:"31,len=2,table=0098,display=Type Of Agreement Code"`
BillingStatus IS `hl7:"32,len=2,table=0022,display=Billing Status"`
LifetimeReserveDays NM `hl7:"33,len=4,display=Lifetime Reserve Days"`
DelayBeforeLRDay NM `hl7:"34,len=4,display=Delay Before L.R. Day"`
CompanyPlanCode IS `hl7:"35,len=20,table=0042,display=Company Plan Code"`
PolicyNumber ST `hl7:"36,len=15,display=Policy Number"`
PolicyDeductible *CP `hl7:"37,len=12,display=Policy Deductible"`
PolicyLimitAmount ST `hl7:"38,display=Policy Limit - Amount"`
PolicyLimitDays NM `hl7:"39,len=4,display=Policy Limit - Days"`
RoomRateSemiPrivate ST `hl7:"40,display=Room Rate - Semi-Private"`
RoomRatePrivate ST `hl7:"41,display=Room Rate - Private"`
InsuredsEmploymentStatus *CWE `hl7:"42,len=250,table=0066,display=Insured's Employment Status"`
InsuredsAdministrativeSex IS `hl7:"43,len=1,table=0001,display=Insured's Administrative Sex"`
InsuredsEmployersAddress []XAD `hl7:"44,len=250,display=Insured's Employer's Address"`
VerificationStatus ST `hl7:"45,len=2,display=Verification Status"`
PriorInsurancePlanID IS `hl7:"46,len=8,table=0072,display=Prior Insurance Plan ID"`
CoverageType IS `hl7:"47,len=3,table=0309,display=Coverage Type"`
Handicap IS `hl7:"48,len=2,table=0295,display=Handicap"`
InsuredsIDNumber []CX `hl7:"49,len=250,display=Insured's ID Number"`
SignatureCode IS `hl7:"50,len=1,table=0535,display=Signature Code"`
SignatureCodeDate DT `hl7:"51,len=8,format=YMD,display=Signature Code Date"`
InsuredsBirthPlace ST `hl7:"52,len=250,display=Insured's Birth Place"`
VIPIndicator IS `hl7:"53,len=2,table=0099,display=VIP Indicator"`
}
Insurance
The IN1 segment contains insurance policy coverage information necessary to produce properly pro-rated and patient and insurance bills.
type IN2 ¶
type IN2 struct {
HL7 HL7Name `hl7:",name=IN2,type=s"`
InsuredsEmployeeID []CX `hl7:"1,len=250,display=Insured's Employee ID"`
InsuredsSocialSecurityNumber ST `hl7:"2,len=11,display=Insured's Social Security Number"`
InsuredsEmployersNameAndID []XCN `hl7:"3,len=250,display=Insured's Employer's Name and ID"`
EmployerInformationData IS `hl7:"4,len=1,table=0139,display=Employer Information Data"`
MailClaimParty []IS `hl7:"5,len=1,table=0137,display=Mail Claim Party"`
MedicareHealthInsCardNumber ST `hl7:"6,len=15,display=Medicare Health Ins Card Number"`
MedicaidCaseName []XPN `hl7:"7,len=250,display=Medicaid Case Name"`
MedicaidCaseNumber ST `hl7:"8,len=15,display=Medicaid Case Number"`
MilitarySponsorName []XPN `hl7:"9,len=250,display=Military Sponsor Name"`
MilitaryIDNumber ST `hl7:"10,len=20,display=Military ID Number"`
DependentOfMilitaryRecipient *CWE `hl7:"11,len=250,table=0342,display=Dependent Of Military Recipient"`
MilitaryOrganization ST `hl7:"12,len=25,display=Military Organization"`
MilitaryStation ST `hl7:"13,len=25,display=Military Station"`
MilitaryService IS `hl7:"14,len=14,table=0140,display=Military Service"`
MilitaryRankGrade IS `hl7:"15,len=2,table=0141,display=Military Rank/Grade"`
MilitaryStatus IS `hl7:"16,len=3,table=0142,display=Military Status"`
MilitaryRetireDate DT `hl7:"17,len=8,format=YMD,display=Military Retire Date"`
MilitaryNonAvailCertOnFile ID `hl7:"18,len=1,table=0136,display=Military Non-Avail Cert On File"`
BabyCoverage ID `hl7:"19,len=1,table=0136,display=Baby Coverage"`
CombineBabyBill ID `hl7:"20,len=1,table=0136,display=Combine Baby Bill"`
BloodDeductible ST `hl7:"21,len=1,display=Blood Deductible"`
SpecialCoverageApprovalName []XPN `hl7:"22,len=250,display=Special Coverage Approval Name"`
SpecialCoverageApprovalTitle ST `hl7:"23,len=30,display=Special Coverage Approval Title"`
NonCoveredInsuranceCode []IS `hl7:"24,len=8,table=0143,display=Non-Covered Insurance Code"`
PayorID []CX `hl7:"25,len=250,display=Payor ID"`
PayorSubscriberID []CX `hl7:"26,len=250,display=Payor Subscriber ID"`
EligibilitySource IS `hl7:"27,len=1,table=0144,display=Eligibility Source"`
RoomCoverageTypeAmount []RMC `hl7:"28,len=82,display=Room Coverage Type/Amount"`
PolicyTypeAmount []PTA `hl7:"29,len=56,display=Policy Type/Amount"`
DailyDeductible *DDI `hl7:"30,len=25,display=Daily Deductible"`
LivingDependency IS `hl7:"31,len=2,table=0223,display=Living Dependency"`
AmbulatoryStatus []IS `hl7:"32,len=2,table=0009,display=Ambulatory Status"`
Citizenship []CWE `hl7:"33,len=705,table=0171,display=Citizenship"`
PrimaryLanguage *CWE `hl7:"34,len=705,table=0296,display=Primary Language"`
LivingArrangement IS `hl7:"35,len=2,table=0220,display=Living Arrangement"`
PublicityCode *CWE `hl7:"36,len=705,table=0215,display=Publicity Code"`
ProtectionIndicator ID `hl7:"37,len=1,table=0136,display=Protection Indicator"`
StudentIndicator IS `hl7:"38,len=2,table=0231,display=Student Indicator"`
Religion *CWE `hl7:"39,len=705,table=0006,display=Religion"`
MothersMaidenName []XPN `hl7:"40,len=250,display=Mother's Maiden Name"`
Nationality *CWE `hl7:"41,len=705,table=0212,display=Nationality"`
EthnicGroup []CWE `hl7:"42,len=705,table=0189,display=Ethnic Group"`
MaritalStatus []CWE `hl7:"43,len=705,table=0002,display=Marital Status"`
InsuredsEmploymentStartDate DT `hl7:"44,len=8,format=YMD,display=Insured's Employment Start Date"`
EmploymentStopDate DT `hl7:"45,len=8,format=YMD,display=Employment Stop Date"`
JobTitle ST `hl7:"46,len=20,display=Job Title"`
JobCodeClass *JCC `hl7:"47,len=20,display=Job Code/Class"`
JobStatus IS `hl7:"48,len=2,table=0311,display=Job Status"`
EmployerContactPersonName []XPN `hl7:"49,len=250,display=Employer Contact Person Name"`
EmployerContactPersonPhoneNumber []XTN `hl7:"50,len=250,display=Employer Contact Person Phone Number"`
EmployerContactReason IS `hl7:"51,len=2,table=0222,display=Employer Contact Reason"`
InsuredsContactPersonsName []XPN `hl7:"52,len=250,display=Insured's Contact Person's Name"`
InsuredsContactPersonPhoneNumber []XTN `hl7:"53,len=250,display=Insured's Contact Person Phone Number"`
InsuredsContactPersonReason []IS `hl7:"54,len=2,table=0222,display=Insured's Contact Person Reason"`
RelationshipToThePatientStartDate DT `hl7:"55,len=8,format=YMD,display=Relationship to the Patient Start Date"`
RelationshipToThePatientStopDate []DT `hl7:"56,len=8,format=YMD,display=Relationship to the Patient Stop Date"`
InsuranceCoContactReason IS `hl7:"57,len=2,table=0232,display=Insurance Co. Contact Reason"`
InsuranceCoContactPhoneNumber []XTN `hl7:"58,len=250,display=Insurance Co Contact Phone Number"`
PolicyScope IS `hl7:"59,len=2,table=0312,display=Policy Scope"`
PolicySource IS `hl7:"60,len=2,table=0313,display=Policy Source"`
PatientMemberNumber *CX `hl7:"61,len=250,display=Patient Member Number"`
GuarantorsRelationshipToInsured *CWE `hl7:"62,len=250,table=0063,display=Guarantor's Relationship To Insured"`
InsuredsPhoneNumberHome []XTN `hl7:"63,len=250,display=Insured's Phone Number - Home"`
InsuredsEmployerPhoneNumber []XTN `hl7:"64,len=250,display=Insured's Employer Phone Number"`
MilitaryHandicappedProgram *CWE `hl7:"65,len=250,table=0343,display=Military Handicapped Program"`
SuspendFlag ID `hl7:"66,len=1,table=0136,display=Suspend Flag"`
CopayLimitFlag ID `hl7:"67,len=1,table=0136,display=Copay Limit Flag"`
StoplossLimitFlag ID `hl7:"68,len=1,table=0136,display=Stoploss Limit Flag"`
InsuredOrganizationNameAndID []XON `hl7:"69,len=250,display=Insured Organization Name and ID"`
InsuredEmployerOrganizationNameAndID []XON `hl7:"70,len=250,display=Insured Employer Organization Name and ID"`
Race []CWE `hl7:"71,len=705,table=0005,display=Race"`
CMSPatientsRelationshipToInsured *CWE `hl7:"72,len=705,table=0344,display=CMS Patient's Relationship to Insured"`
}
Insurance Additional Information
The IN2 segment contains additional insurance policy coverage and benefit information necessary for proper billing and reimbursement. Fields used by this segment are defined by CMS or other regulatory agencies.
type IN3 ¶
type IN3 struct {
HL7 HL7Name `hl7:",name=IN3,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - IN3"`
CertificationNumber *CX `hl7:"2,len=250,display=Certification Number"`
CertifiedBy []XCN `hl7:"3,len=250,display=Certified By"`
CertificationRequired ID `hl7:"4,len=1,table=0136,display=Certification Required"`
Penalty *MOP `hl7:"5,len=23,display=Penalty"`
CertificationDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Certification Date/Time"`
CertificationModifyDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Certification Modify Date/Time"`
Operator []XCN `hl7:"8,len=250,display=Operator"`
CertificationBeginDate DT `hl7:"9,len=8,format=YMD,display=Certification Begin Date"`
CertificationEndDate DT `hl7:"10,len=8,format=YMD,display=Certification End Date"`
Days *DTN `hl7:"11,len=6,display=Days"`
NonConcurCodeDescription *CWE `hl7:"12,len=250,table=0233,display=Non-Concur Code/Description"`
NonConcurEffectiveDateTime DTM `hl7:"13,len=24,format=YMDHM,display=Non-Concur Effective Date/Time"`
PhysicianReviewer []XCN `hl7:"14,len=250,table=0010,display=Physician Reviewer"`
CertificationContact ST `hl7:"15,len=48,display=Certification Contact"`
CertificationContactPhoneNumber []XTN `hl7:"16,len=250,display=Certification Contact Phone Number"`
AppealReason *CWE `hl7:"17,len=250,table=0345,display=Appeal Reason"`
CertificationAgency *CWE `hl7:"18,len=250,table=0346,display=Certification Agency"`
CertificationAgencyPhoneNumber []XTN `hl7:"19,len=250,display=Certification Agency Phone Number"`
PreCertificationRequirement []ICD `hl7:"20,len=40,display=Pre-Certification Requirement"`
CaseManager ST `hl7:"21,len=48,display=Case Manager"`
SecondOpinionDate DT `hl7:"22,len=8,format=YMD,display=Second Opinion Date"`
SecondOpinionStatus IS `hl7:"23,len=1,table=0151,display=Second Opinion Status"`
SecondOpinionDocumentationReceived []IS `hl7:"24,len=1,table=0152,display=Second Opinion Documentation Received"`
SecondOpinionPhysician []XCN `hl7:"25,len=250,table=0010,display=Second Opinion Physician"`
}
Insurance Additional Information, Certification
The IN3 segment contains additional insurance information for certifying the need for patient care. Fields used by this segment are defined by CMS, or other regulatory agencies.
type INR_U06 ¶
type INR_U06 struct {
HL7 HL7Name `hl7:",name=INR_U06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
INV []INV `hl7:"5,required,display=Inventory Detail"`
ROL *ROL `hl7:"6,display=Role"`
}
Automated Equipment Inventory Request
This message is used to request information about inventory items from one application to another (e.g., Laboratory Automation System to automated equipment). The equipment specified in the EQU segment should respond with the information about inventory item requested in the INV segment (or all items).
type INU_U05 ¶
type INU_U05 struct {
HL7 HL7Name `hl7:",name=INU_U05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
INV []INV `hl7:"5,required,display=Inventory Detail"`
ROL *ROL `hl7:"6,display=Role"`
}
Automated Equipment Inventory Update
This message is used to send information about inventory items from one application to another (e.g., automated Equipment to a Laboratory Automation System).
type INV ¶
type INV struct {
HL7 HL7Name `hl7:",name=INV,type=s"`
SubstanceIdentifier CWE `hl7:"1,required,len=705,table=0451,display=Substance Identifier"`
SubstanceStatus []CWE `hl7:"2,required,len=705,table=0383,display=Substance Status"`
SubstanceType *CWE `hl7:"3,len=705,table=0384,display=Substance Type"`
InventoryContainerIdentifier *CWE `hl7:"4,len=705,display=Inventory Container Identifier"`
ContainerCarrierIdentifier *CWE `hl7:"5,len=705,display=Container Carrier Identifier"`
PositionOnCarrier *CWE `hl7:"6,len=705,display=Position on Carrier"`
InitialQuantity NM `hl7:"7,len=20,display=Initial Quantity"`
CurrentQuantity NM `hl7:"8,len=20,display=Current Quantity"`
AvailableQuantity NM `hl7:"9,len=20,display=Available Quantity"`
ConsumptionQuantity NM `hl7:"10,len=20,display=Consumption Quantity"`
QuantityUnits *CWE `hl7:"11,len=705,display=Quantity Units"`
ExpirationDateTime DTM `hl7:"12,len=24,format=YMDHM,display=Expiration Date/Time"`
FirstUsedDateTime DTM `hl7:"13,len=24,format=YMDHM,display=First Used Date/Time"`
OnBoardStabilityDuration TQ `hl7:"14,len=200,display=On Board Stability Duration"`
TestFluidIdentifier []CWE `hl7:"15,len=705,display=Test/Fluid Identifier"`
ManufacturerLotNumber ST `hl7:"16,len=200,display=Manufacturer Lot Number"`
ManufacturerIdentifier *CWE `hl7:"17,len=705,table=0385,display=Manufacturer Identifier"`
SupplierIdentifier *CWE `hl7:"18,len=705,table=0386,display=Supplier Identifier"`
OnBoardStabilityTime *CQ `hl7:"19,len=722,display=On Board Stability Time"`
TargetValue *CQ `hl7:"20,len=722,display=Target Value"`
}
Inventory Detail
The inventory detail segment is the data necessary to track the inventory of substances (e.g. reagent, tips, waste) on equipment.
type IPC ¶
type IPC struct {
HL7 HL7Name `hl7:",name=IPC,type=s"`
AccessionIdentifier EI `hl7:"1,required,len=427,display=Accession Identifier"`
RequestedProcedureID EI `hl7:"2,required,len=22,display=Requested Procedure ID"`
StudyInstanceUID EI `hl7:"3,required,len=70,display=Study Instance UID"`
ScheduledProcedureStepID EI `hl7:"4,required,len=22,display=Scheduled Procedure Step ID"`
Modality *CWE `hl7:"5,len=16,display=Modality"`
ProtocolCode []CWE `hl7:"6,len=250,display=Protocol Code"`
ScheduledStationName *EI `hl7:"7,len=22,display=Scheduled Station Name"`
ScheduledProcedureStepLocation []CWE `hl7:"8,len=250,display=Scheduled Procedure Step Location"`
ScheduledStationAETitle ST `hl7:"9,len=16,display=Scheduled Station AE Title"`
}
Imaging Procedure Control Segment
The IPC segment contains information about tasks that need to be performed in order to fulfill the request for imaging service. The information includes location, type and instance identification of equipment (acquisition modality) and stages (procedure steps).
type IPR ¶
type IPR struct {
HL7 HL7Name `hl7:",name=IPR,type=s"`
Identifier EI `hl7:"1,required,len=73,display=IPR Identifier"`
ProviderCrossReferenceIdentifier EI `hl7:"2,required,len=73,display=Provider Cross Reference Identifier"`
PayerCrossReferenceIdentifier EI `hl7:"3,required,len=73,display=Payer Cross Reference Identifier"`
Status CWE `hl7:"4,required,len=177,table=0571,display=IPR Status"`
DateTime DTM `hl7:"5,required,len=26,format=YMDHM,display=IPR Date/Time"`
AdjudicatedPaidAmount *CP `hl7:"6,len=254,display=Adjudicated/Paid Amount"`
ExpectedPaymentDateTime DTM `hl7:"7,len=26,format=YMDHM,display=Expected Payment Date/Time"`
Checksum ST `hl7:"8,required,len=10,display=IPR Checksum"`
}
Invoice Processing Results
The Invoice Processing Results (IPR) segment provides summary information about an adjudicated Product/Service Group or Product/Service Line Item.
type ISD ¶
type ISD struct {
HL7 HL7Name `hl7:",name=ISD,type=s"`
ReferenceInteractionNumber NM `hl7:"1,required,len=20,display=Reference Interaction Number"`
InteractionTypeIdentifier *CWE `hl7:"2,len=705,table=0368,display=Interaction Type Identifier"`
InteractionActiveState CWE `hl7:"3,required,len=705,table=0387,display=Interaction Active State"`
}
Interaction Status Detail
The interaction detail segment contains information about the status of specific interaction (e.g., processing see section Glossary) on the specific equipment.
type ITM ¶
type ITM struct {
HL7 HL7Name `hl7:",name=ITM,type=s"`
ItemIdentifier EI `hl7:"1,required,len=250,display=Item Identifier"`
ItemDescription ST `hl7:"2,len=999,display=Item Description"`
ItemStatus *CWE `hl7:"3,len=250,table=0776,display=Item Status"`
ItemType *CWE `hl7:"4,len=250,table=0778,display=Item Type"`
ItemCategory *CWE `hl7:"5,len=250,display=Item Category"`
SubjectToExpirationIndicator *CNE `hl7:"6,len=4,table=0532,display=Subject to Expiration Indicator"`
ManufacturerIdentifier *EI `hl7:"7,len=250,display=Manufacturer Identifier"`
ManufacturerName ST `hl7:"8,len=999,display=Manufacturer Name"`
ManufacturerCatalogNumber ST `hl7:"9,len=20,display=Manufacturer Catalog Number"`
ManufacturerLabelerIdentificationCode *CWE `hl7:"10,len=4,display=Manufacturer Labeler Identification Code"`
PatientChargeableIndicator *CNE `hl7:"11,len=4,table=0532,display=Patient Chargeable Indicator"`
TransactionCode *CWE `hl7:"12,len=250,table=0132,display=Transaction Code"`
TransactionAmountUnit *CP `hl7:"13,len=12,display=Transaction amount - unit"`
StockedItemIndicator *CNE `hl7:"14,len=4,table=0532,display=Stocked Item Indicator"`
SupplyRiskCodes *CWE `hl7:"15,len=250,table=0871,display=Supply Risk Codes"`
ApprovingRegulatoryAgency []XON `hl7:"16,len=250,table=0790,display=Approving Regulatory Agency"`
LatexIndicator *CNE `hl7:"17,len=4,table=0532,display=Latex Indicator"`
RulingAct []CWE `hl7:"18,len=250,table=0793,display=Ruling Act"`
ItemNaturalAccountCode IS `hl7:"19,len=30,table=0320,display=Item Natural Account Code"`
ApprovedToBuyQuantity NM `hl7:"20,len=6,display=Approved To Buy Quantity"`
ApprovedToBuyPrice *MO `hl7:"21,len=10,display=Approved To Buy Price"`
TaxableItemIndicator *CNE `hl7:"22,len=4,table=0532,display=Taxable Item Indicator"`
FreightChargeIndicator *CNE `hl7:"23,len=4,table=0532,display=Freight Charge Indicator"`
ItemSetIndicator *CNE `hl7:"24,len=4,table=0532,display=Item Set Indicator"`
ItemSetIdentifier *EI `hl7:"25,len=250,display=Item Set Identifier"`
TrackDepartmentUsageIndicator *CNE `hl7:"26,len=4,table=0532,display=Track Department Usage Indicator"`
ProcedureCode *CNE `hl7:"27,len=705,table=0088,display=Procedure Code"`
ProcedureCodeModifier []CNE `hl7:"28,len=705,table=0340,display=Procedure Code Modifier"`
SpecialHandlingCode *CWE `hl7:"29,len=705,table=0376,display=Special Handling Code"`
}
Material Item
The Material Item segment (ITM) contains information about inventory supply items (stocked or non-stocked).
type IVC ¶
type IVC struct {
HL7 HL7Name `hl7:",name=IVC,type=s"`
ProviderInvoiceNumber EI `hl7:"1,required,len=74,display=Provider Invoice Number"`
PayerInvoiceNumber *EI `hl7:"2,len=74,display=Payer Invoice Number"`
ContractAgreementNumber *EI `hl7:"3,len=74,display=Contract/Agreement Number"`
InvoiceControl IS `hl7:"4,required,len=2,table=0553,display=Invoice Control"`
InvoiceReason IS `hl7:"5,required,len=4,table=0554,display=Invoice Reason"`
InvoiceType IS `hl7:"6,required,len=2,table=0555,display=Invoice Type"`
InvoiceDateTime DTM `hl7:"7,required,len=24,format=YMDHM,display=Invoice Date/Time"`
InvoiceAmount CP `hl7:"8,required,len=254,display=Invoice Amount"`
PaymentTerms ST `hl7:"9,len=80,display=Payment Terms"`
ProviderOrganization XON `hl7:"10,required,len=183,display=Provider Organization"`
PayerOrganization XON `hl7:"11,required,len=183,display=Payer Organization"`
Attention *XCN `hl7:"12,len=637,display=Attention"`
LastInvoiceIndicator ID `hl7:"13,len=1,table=0136,display=Last Invoice Indicator"`
InvoiceBookingPeriod DTM `hl7:"14,len=24,format=YMDHM,display=Invoice Booking Period"`
Origin ST `hl7:"15,len=250,display=Origin"`
InvoiceFixedAmount *CP `hl7:"16,len=254,display=Invoice Fixed Amount"`
SpecialCosts *CP `hl7:"17,len=254,display=Special Costs"`
AmountForDoctorsTreatment *CP `hl7:"18,len=254,display=Amount for Doctors Treatment"`
ResponsiblePhysician *XCN `hl7:"19,len=250,display=Responsible Physician"`
CostCenter *CX `hl7:"20,len=250,display=Cost Center"`
InvoicePrepaidAmount *CP `hl7:"21,len=254,display=Invoice Prepaid Amount"`
TotalInvoiceAmountWithoutPrepaidAmount *CP `hl7:"22,len=254,display=Total Invoice Amount without Prepaid Amount"`
TotalAmountOfVAT *CP `hl7:"23,conditional,len=254,display=Total-Amount of VAT"`
VATRatesApplied []NM `hl7:"24,len=1024,display=VAT-Rates applied"`
BenefitGroup IS `hl7:"25,required,len=4,table=0556,display=Benefit Group"`
ProviderTaxID ST `hl7:"26,len=20,display=Provider Tax ID"`
PayerTaxID ST `hl7:"27,len=20,display=Payer Tax ID"`
ProviderTaxStatus IS `hl7:"28,len=4,table=0572,display=Provider Tax status"`
PayerTaxStatus IS `hl7:"29,len=4,table=0572,display=Payer Tax status"`
SalesTaxID ST `hl7:"30,len=20,display=Sales Tax ID"`
}
Invoice
The Invoice segment is used for HealthCare Services Invoices and contains header style information for an invoice including invoice numbers, Provider Organization and Payer Organization identification.
type IVT ¶
type IVT struct {
HL7 HL7Name `hl7:",name=IVT,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set Id – IVT"`
InventoryLocationIdentifier EI `hl7:"2,required,len=250,display=Inventory Location Identifier"`
InventoryLocationName ST `hl7:"3,len=999,display=Inventory Location Name"`
SourceLocationIdentifier *EI `hl7:"4,len=250,display=Source Location Identifier"`
SourceLocationName ST `hl7:"5,len=999,display=Source Location Name"`
ItemStatus *CWE `hl7:"6,len=250,table=0625,display=Item Status"`
BinLocationIdentifier []EI `hl7:"7,len=250,display=Bin Location Identifier"`
OrderPackaging *CWE `hl7:"8,len=250,display=Order Packaging"`
IssuePackaging *CWE `hl7:"9,len=250,display=Issue Packaging"`
DefaultInventoryAssetAccount *EI `hl7:"10,len=16,display=Default Inventory Asset Account"`
PatientChargeableIndicator *CNE `hl7:"11,len=4,table=0532,display=Patient Chargeable Indicator"`
TransactionCode *CWE `hl7:"12,len=250,table=0132,display=Transaction Code"`
TransactionAmountUnit *CP `hl7:"13,len=12,display=Transaction amount - unit"`
ItemImportanceCode *CWE `hl7:"14,len=250,table=0634,display=Item Importance Code"`
StockedItemIndicator *CNE `hl7:"15,len=4,table=0532,display=Stocked Item Indicator"`
ConsignmentItemIndicator *CNE `hl7:"16,len=4,table=0532,display=Consignment Item Indicator"`
ReusableItemIndicator *CNE `hl7:"17,len=4,table=0532,display=Reusable Item Indicator"`
ReusableCost *CP `hl7:"18,len=12,display=Reusable Cost"`
SubstituteItemIdentifier []EI `hl7:"19,len=250,display=Substitute Item Identifier"`
LatexFreeSubstituteItemIdentifier *EI `hl7:"20,len=250,display=Latex-Free Substitute Item Identifier"`
RecommendedReorderTheory *CWE `hl7:"21,len=250,table=0642,display=Recommended Reorder Theory"`
RecommendedSafetyStockDays NM `hl7:"22,len=4,display=Recommended Safety Stock Days"`
RecommendedMaximumDaysInventory NM `hl7:"23,len=4,display=Recommended Maximum Days Inventory"`
RecommendedOrderPoint NM `hl7:"24,len=8,display=Recommended Order Point"`
RecommendedOrderAmount NM `hl7:"25,len=8,display=Recommended Order Amount"`
OperatingRoomParLevelIndicator *CNE `hl7:"26,len=4,table=0532,display=Operating Room Par Level Indicator"`
}
Material Location
The Material Location segment (IVT) contains information specific to an inventory location for the inventory supply item in the Material Item (ITM) segment.
type JCC ¶
type JCC struct {
HL7 HL7Name `hl7:",name=JCC,len=292,type=d"`
JobCode IS `` /* 201-byte string literal not displayed */
JobClass IS `` /* 175-byte string literal not displayed */
JobDescriptionText TX `` /* 151-byte string literal not displayed */
}
Job Code/Class
type LA1 ¶
type LA1 struct {
HL7 HL7Name `hl7:",name=LA1,len=790,type=d"`
PointOfCare IS `` /* 342-byte string literal not displayed */
Room IS `` /* 224-byte string literal not displayed */
Bed IS `` /* 213-byte string literal not displayed */
Facility *HD `` /* 236-byte string literal not displayed */
LocationStatus IS `` /* 227-byte string literal not displayed */
PatientLocationType IS `` /* 415-byte string literal not displayed */
Building IS `` /* 247-byte string literal not displayed */
Floor IS `` /* 241-byte string literal not displayed */
Address *AD `hl7:"9,len=415,display=This component specifies the address of a location."`
}
Location with Address Variation 1
Specifies a location and its address.
type LA2 ¶
type LA2 struct {
HL7 HL7Name `hl7:",name=LA2,len=790,type=d"`
PointOfCare IS `` /* 343-byte string literal not displayed */
Room IS `` /* 224-byte string literal not displayed */
Bed IS `` /* 215-byte string literal not displayed */
Facility *HD `` /* 236-byte string literal not displayed */
LocationStatus IS `` /* 227-byte string literal not displayed */
PatientLocationType IS `` /* 417-byte string literal not displayed */
Building IS `` /* 247-byte string literal not displayed */
Floor IS `` /* 241-byte string literal not displayed */
StreetAddress ST `` /* 266-byte string literal not displayed */
OtherDesignation ST `` /* 229-byte string literal not displayed */
City ST `` /* 284-byte string literal not displayed */
StateOrProvince ST `` /* 209-byte string literal not displayed */
ZipOrPostalCode ST `` /* 352-byte string literal not displayed */
Country ID `` /* 373-byte string literal not displayed */
AddressType ID `` /* 144-byte string literal not displayed */
OtherGeographicDesignation ST `` /* 146-byte string literal not displayed */
}
Location with Address Variation 2
Specifies a location and its address.
type LAN ¶
type LAN struct {
HL7 HL7Name `hl7:",name=LAN,type=s"`
SetID SI `hl7:"1,seq,required,len=60,display=Set ID – LAN"`
LanguageCode CWE `hl7:"2,required,len=250,table=0296,display=Language Code"`
LanguageAbilityCode []CWE `hl7:"3,len=250,table=0403,display=Language Ability Code"`
LanguageProficiencyCode *CWE `hl7:"4,len=250,table=0404,display=Language Proficiency Code"`
}
Language Detail
The LAN segment adds detailed language information to the staff member identified by the STF segment. An LAN segment may optionally follow an STF segment. An LAN segment must always have been preceded by a corresponding STF segment.
type LCC ¶
type LCC struct {
HL7 HL7Name `hl7:",name=LCC,type=s"`
PrimaryKeyValue PL `hl7:"1,required,len=200,display=Primary Key Value - LCC"`
LocationDepartment CWE `hl7:"2,required,len=250,table=0264,display=Location Department"`
AccommodationType []CWE `hl7:"3,len=250,table=0129,display=Accommodation Type"`
ChargeCode []CWE `hl7:"4,required,len=250,table=0132,display=Charge Code"`
}
Location Charge Code
The Technical Steward for the LCC segment is PA.
The optional LCC segment identifies how a patient location room can be billed by a certain department. A department can use different charge codes for the same room or bed, so there can be multiple LCC segments following an LDP segment.
type LCH ¶
type LCH struct {
HL7 HL7Name `hl7:",name=LCH,type=s"`
PrimaryKeyValue PL `hl7:"1,required,len=200,display=Primary Key Value - LCH"`
SegmentActionCode ID `hl7:"2,len=3,table=0206,display=Segment Action Code"`
SegmentUniqueKey *EI `hl7:"3,len=80,display=Segment Unique Key"`
LocationCharacteristicID CWE `hl7:"4,required,len=250,table=0324,display=Location Characteristic ID"`
LocationCharacteristicValue CWE `hl7:"5,required,len=250,display=Location Characteristic Value-LCH"`
}
Location Characteristic
The Technical Steward for the LCH segment is Patient Administration.
The LCH segment is used to identify location characteristics which determine which patients will be assigned to the room or bed. It contains the location characteristics of the room or bed identified in the preceding LOC segment. There should be one LCH segment for each attribute.
type LDP ¶
type LDP struct {
HL7 HL7Name `hl7:",name=LDP,type=s"`
PrimaryKeyValue PL `hl7:"1,required,len=200,display=Primary Key Value - LDP"`
LocationDepartment CWE `hl7:"2,required,len=250,table=0264,display=Location Department"`
LocationService []IS `hl7:"3,len=3,table=0069,display=Location Service"`
SpecialtyType []CWE `hl7:"4,len=250,table=0265,display=Specialty Type"`
ValidPatientClasses []IS `hl7:"5,len=1,table=0004,display=Valid Patient Classes"`
ActiveInactiveFlag ID `hl7:"6,len=1,table=0183,display=Active/Inactive Flag"`
ActivationDate DTM `hl7:"7,len=24,format=YMDHM,display=Activation Date LDP"`
InactivationDate DTM `hl7:"8,len=24,format=YMDHM,display=Inactivation Date - LDP"`
InactivatedReason ST `hl7:"9,len=80,display=Inactivated Reason"`
VisitingHours []VH `hl7:"10,len=80,display=Visiting Hours"`
ContactPhone *XTN `hl7:"11,len=250,display=Contact Phone"`
LocationCostCenter *CWE `hl7:"12,len=250,table=0462,display=Location Cost Center"`
}
Location Department
The Technical Steward for the LDP segment is Patient Administration.
The LDP segment identifies how a patient location room is being used by a certain department. Multiple departments can use the same patient location, so there can be multiple LDP segments following an LOC segment. There must be at least one LDP segment for each LOC segment. This is not intended to include any current occupant information.
type LOC ¶
type LOC struct {
HL7 HL7Name `hl7:",name=LOC,type=s"`
PrimaryKeyValue PL `hl7:"1,required,len=200,display=Primary Key Value - LOC"`
LocationDescription ST `hl7:"2,len=48,display=Location Description"`
LocationType []IS `hl7:"3,required,len=2,table=0260,display=Location Type - LOC"`
OrganizationName []XON `hl7:"4,len=250,display=Organization Name - LOC"`
LocationAddress []XAD `hl7:"5,len=250,display=Location Address"`
LocationPhone []XTN `hl7:"6,len=250,display=Location Phone"`
LicenseNumber []CWE `hl7:"7,len=250,table=0461,display=License Number"`
LocationEquipment []IS `hl7:"8,len=3,table=0261,display=Location Equipment"`
LocationServiceCode IS `hl7:"9,len=1,table=0442,display=Location Service Code"`
}
Location Identification
The Technical Steward for the LOC segment is Patient Administration.
The LOC segment can identify any patient location referenced by information systems. This segment gives physical set up information about the location. This is not intended to include any current occupant or current use information. There should be one LOC segment for each patient location. If desired, there can also be one LOC segment for each nursing unit and room.
type LRL ¶
type LRL struct {
HL7 HL7Name `hl7:",name=LRL,type=s"`
PrimaryKeyValue PL `hl7:"1,required,len=200,display=Primary Key Value - LRL"`
SegmentActionCode ID `hl7:"2,len=3,table=0206,display=Segment Action Code"`
SegmentUniqueKey *EI `hl7:"3,len=80,display=Segment Unique Key"`
LocationRelationshipID CWE `hl7:"4,required,len=250,table=0325,display=Location Relationship ID"`
OrganizationalLocationRelationshipValue []XON `hl7:"5,conditional,len=250,display=Organizational Location Relationship Value"`
PatientLocationRelationshipValue *PL `hl7:"6,conditional,len=80,display=Patient Location Relationship Value"`
}
Location Relationship
The Technical Steward for the LRL segment is Patient Administration.
The LRL segment is used to identify one location's relationship to another location, the nearest lab, pharmacy, etc.
type LSR_U13 ¶
type LSR_U13 struct {
HL7 HL7Name `hl7:",name=LSR_U13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
EQP []EQP `hl7:"5,required,display=Equipment/log Service"`
ROL *ROL `hl7:"6,display=Role"`
}
Automated Equipment Log/Service Request
This message is used to request log and/or service events from one application to another (e.g., Laboratory Automation System to automated equipment).
type LSU_U12 ¶
type LSU_U12 struct {
HL7 HL7Name `hl7:",name=LSU_U12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
EQP []EQP `hl7:"5,required,display=Equipment/log Service"`
ROL *ROL `hl7:"6,display=Role"`
}
Automated Equipment Log/Service Update
This message is used to send log and/or service events from one application to another (e.g., automated equipment to Laboratory Automation System).
type MDM_T01 ¶
type MDM_T01 struct {
HL7 HL7Name `hl7:",name=MDM_T01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T01_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Original Document Notification
This is a notification of the creation of a document without the accompanying content.
type MDM_T01_CommonOrder ¶
type MDM_T01_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T01_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T01_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T01_Timing ¶
type MDM_T01_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T01_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T02 ¶
type MDM_T02 struct {
HL7 HL7Name `hl7:",name=MDM_T02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T02_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
Obxnte []MDM_T02_Obxnte `hl7:",required,display=Obxnte"`
}
Original Document Notification and Content
This is a notification of the creation of a document with the accompanying content.
type MDM_T02_CommonOrder ¶
type MDM_T02_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T02_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T02_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T02_Obxnte ¶
type MDM_T02_Obxnte struct {
HL7 HL7Name `hl7:",name=MDM_T02_Obxnte,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Obxnte
type MDM_T02_Timing ¶
type MDM_T02_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T02_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T03 ¶
type MDM_T03 struct {
HL7 HL7Name `hl7:",name=MDM_T03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T03_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Document Status Change Notification
This is a notification of a change in a status of a document without the accompanying content.
type MDM_T03_CommonOrder ¶
type MDM_T03_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T03_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T03_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T03_Timing ¶
type MDM_T03_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T03_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T04 ¶
type MDM_T04 struct {
HL7 HL7Name `hl7:",name=MDM_T04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T04_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
Obxnte []MDM_T04_Obxnte `hl7:",required,display=Obxnte"`
}
Document Status Change Notification and Content
This is a notification of a change in a status of a document with the accompanying content.
type MDM_T04_CommonOrder ¶
type MDM_T04_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T04_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T04_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T04_Obxnte ¶
type MDM_T04_Obxnte struct {
HL7 HL7Name `hl7:",name=MDM_T04_Obxnte,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Obxnte
type MDM_T04_Timing ¶
type MDM_T04_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T04_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T05 ¶
type MDM_T05 struct {
HL7 HL7Name `hl7:",name=MDM_T05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T05_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Document Addendum Notification
This is a notification of an addendum to a document without the accompanying content.
type MDM_T05_CommonOrder ¶
type MDM_T05_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T05_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T05_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T05_Timing ¶
type MDM_T05_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T05_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T06 ¶
type MDM_T06 struct {
HL7 HL7Name `hl7:",name=MDM_T06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T06_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
Obxnte []MDM_T06_Obxnte `hl7:",required,display=Obxnte"`
}
Document Addendum Notification and Content
This is a notification of an addendum to a document with the accompanying content.
type MDM_T06_CommonOrder ¶
type MDM_T06_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T06_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T06_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T06_Obxnte ¶
type MDM_T06_Obxnte struct {
HL7 HL7Name `hl7:",name=MDM_T06_Obxnte,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Obxnte
type MDM_T06_Timing ¶
type MDM_T06_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T06_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T07 ¶
type MDM_T07 struct {
HL7 HL7Name `hl7:",name=MDM_T07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T07_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Document Edit Notification
This is a notification of an edit to a document without the accompanying content ¶
Note: The only valid use of this trigger event is for documents whose availability status is “Unavailable,” i.e., the document has not been made available for patient care.
type MDM_T07_CommonOrder ¶
type MDM_T07_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T07_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T07_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T07_Timing ¶
type MDM_T07_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T07_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T08 ¶
type MDM_T08 struct {
HL7 HL7Name `hl7:",name=MDM_T08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T08_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
Obxnte []MDM_T08_Obxnte `hl7:",required,display=Obxnte"`
}
Document Edit Notification and Content
This is a notification of an edit to a document with the accompanying content.
Note: The only valid use of this trigger event is for documents whose availability status is "Unavailable," i.e., the document has not been made available for patient care.
type MDM_T08_CommonOrder ¶
type MDM_T08_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T08_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T08_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T08_Obxnte ¶
type MDM_T08_Obxnte struct {
HL7 HL7Name `hl7:",name=MDM_T08_Obxnte,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Obxnte
type MDM_T08_Timing ¶
type MDM_T08_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T08_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T09 ¶
type MDM_T09 struct {
HL7 HL7Name `hl7:",name=MDM_T09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T09_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Document Replacement Notification
This is a notification of replacement to a document without the accompanying content.
Note: This trigger event is generally used when the original document availability status is “Available.”
type MDM_T09_CommonOrder ¶
type MDM_T09_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T09_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T09_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T09_Timing ¶
type MDM_T09_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T09_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T10 ¶
type MDM_T10 struct {
HL7 HL7Name `hl7:",name=MDM_T10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T10_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
Obxnte []MDM_T10_Obxnte `hl7:",required,display=Obxnte"`
}
Document Replacement Notification and Content
This is a notification of replacement to a document with the accompanying content.
type MDM_T10_CommonOrder ¶
type MDM_T10_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T10_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T10_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T10_Obxnte ¶
type MDM_T10_Obxnte struct {
HL7 HL7Name `hl7:",name=MDM_T10_Obxnte,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Obxnte
type MDM_T10_Timing ¶
type MDM_T10_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T10_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MDM_T11 ¶
type MDM_T11 struct {
HL7 HL7Name `hl7:",name=MDM_T11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
CommonOrder []MDM_T11_CommonOrder `hl7:",display=Common Order"`
TXA *TXA `hl7:"12,required,display=Transcription Document Header"`
}
Document Cancel Notification
This is a notification of a cancellation of a document. This trigger event should be used only for an original document with an availability status of “Unavailable.” When a document has been made available for patient care, the process should be to replace the original document, which then becomes obsolete. The replacement document describes why the erroneous information exists.
type MDM_T11_CommonOrder ¶
type MDM_T11_CommonOrder struct {
HL7 HL7Name `hl7:",name=MDM_T11_CommonOrder,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
Timing []MDM_T11_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
CommonOrder
type MDM_T11_Timing ¶
type MDM_T11_Timing struct {
HL7 HL7Name `hl7:",name=MDM_T11_Timing,type=tg"`
TQ1 *TQ1 `hl7:"8,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"9,display=Timing/Quantity Relationship"`
}
Timing
type MFA ¶
type MFA struct {
HL7 HL7Name `hl7:",name=MFA,type=s"`
RecordLevelEventCode ID `hl7:"1,required,len=3,table=0180,display=Record-Level Event Code"`
MFNControlID ST `hl7:"2,conditional,len=20,display=MFN Control ID"`
EventCompletionDateTime DTM `hl7:"3,len=24,format=YMDHM,display=Event Completion Date/Time"`
MFNRecordLevelErrorReturn CWE `hl7:"4,required,len=250,table=0181,display=MFN Record Level Error Return"`
PrimaryKeyValue []VARIES `hl7:"5,required,len=250,display=Primary Key Value - MFA"`
PrimaryKeyValueType []ID `hl7:"6,required,len=3,table=0355,display=Primary Key Value Type - MFA"`
}
Master File Acknowledgment
The Technical Steward for the MFA segment is Infrastructure and Messaging.
type MFE ¶
type MFE struct {
HL7 HL7Name `hl7:",name=MFE,type=s"`
RecordLevelEventCode ID `hl7:"1,required,len=3,table=0180,display=Record-Level Event Code"`
MFNControlID ST `hl7:"2,conditional,len=20,display=MFN Control ID"`
EffectiveDateTime DTM `hl7:"3,len=26,format=YMDHM,display=Effective Date/Time"`
PrimaryKeyValue []VARIES `hl7:"4,required,len=200,display=Primary Key Value - MFE"`
PrimaryKeyValueType []ID `hl7:"5,required,len=3,table=0355,display=Primary Key Value Type"`
EnteredDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Entered Date/Time"`
EnteredBy *XCN `hl7:"7,len=3220,display=Entered By"`
}
Master File Entry
The Technical Steward for the MFE segment is Infrastructure and Messaging.
type MFI ¶
type MFI struct {
HL7 HL7Name `hl7:",name=MFI,type=s"`
MasterFileIdentifier CWE `hl7:"1,required,len=250,table=0175,display=Master File Identifier"`
MasterFileApplicationIdentifier []HD `hl7:"2,len=180,table=0361,display=Master File Application Identifier"`
FileLevelEventCode ID `hl7:"3,required,len=3,table=0178,display=File-Level Event Code"`
EnteredDateTime DTM `hl7:"4,len=24,format=YMDHM,display=Entered Date/Time"`
EffectiveDateTime DTM `hl7:"5,len=24,format=YMDHM,display=Effective Date/Time"`
ResponseLevelCode ID `hl7:"6,required,len=2,table=0179,display=Response Level Code"`
}
Master File Identification
The Technical Steward for the MFI segment is Infrastructure and Messaging.
type MFK_M01 ¶
type MFK_M01 struct {
HL7 HL7Name `hl7:",name=MFK_M01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"4,display=Error"`
MFI *MFI `hl7:"5,required,display=Master File Identification"`
MFA []MFA `hl7:"6,display=Master File Acknowledgment"`
}
Master File Application Acknowledgment
MFN_M01/MFK_M01 is retained for backward compatibility only as of v2.5 and later. It is recommended that the specific non-deprecated master file messages that follow be used as they apply to new implementations (such as MFN_M02, MFN_M08, MFN_M09, etc.).
type MFK_M02 ¶
type MFK_M02 struct {
HL7 HL7Name `hl7:",name=MFK_M02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Staff/Practitioner Master File Application Acknowledgment
The staff identification (STF), practitioner detail (PRA), practitioner organization unit segment (ORG), professional affiliation (AFF), language detail (LAN), educational detail (EDU), and certificate detail (CER) segments can be used to transmit master files information between systems. The STF segment provides general information about personnel; the PRA, ORG, AFF, LAN, EDU, CER and NTE segments provide detailed information for a staff member.
type MFK_M03 ¶
type MFK_M03 struct {
HL7 HL7Name `hl7:",name=MFK_M03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"4,display=Error"`
MFI *MFI `hl7:"5,required,display=Master File Identification"`
MFA []MFA `hl7:"6,display=Master File Acknowledgment"`
}
Test/Observation Master File Application Acknowledgment
MFN_M03/MFK_M03 is retained for backward compatibility only as of v2.4 and later. It is recommended that the specific master file messages which follow (MFN_M08, MFN_M09, MFN_M10, MFN_M11, and MFN_M12) be used as they apply to new implementations.
type MFK_M04 ¶
type MFK_M04 struct {
HL7 HL7Name `hl7:",name=MFK_M04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Charge Description Master File Application Acknowledgment
The charge description (CDM) master file segment should be used in conjunction with the general master file segments. Interfacing systems often need not only to communicate data about a patient's detailed charges, but also to communicate the charge identification entries by which an application knows how to handle a particular charge code. The charge description master is a master file. The CDM segment below is a specially designed master file segment for interfacing charge description masters. In the following message, the MFI-master file identifier should equal "CDM." When the CDM segment is used in an MFN message, the abstract definition is as follows.
type MFK_M05 ¶
type MFK_M05 struct {
HL7 HL7Name `hl7:",name=MFK_M05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Patient Location Master File Application Acknowledgment
This section is specifically concerned with describing a master file message that should be used to transmit information which identifies the inventory of healthcare patient locations, such as nursing units, rooms, beds, clinics, exam rooms, etc. In a network environment, this segment can be used to define patient locations to other applications. The segment also includes the readiness states and support locations for the patient locations.
type MFK_M06 ¶
type MFK_M06 struct {
HL7 HL7Name `hl7:",name=MFK_M06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Clinical Study with Phases and Schedules Master File Application Acknowledgment
MFK message for Clinical Study with phases and schedules
type MFK_M07 ¶
type MFK_M07 struct {
HL7 HL7Name `hl7:",name=MFK_M07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Clinical Study without Phases but with Schedules Master File Application Acknowledgment
MFK message for Clinical Study without phases but with schedules
type MFK_M08 ¶
type MFK_M08 struct {
HL7 HL7Name `hl7:",name=MFK_M08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Test/Observation (Numeric) Master File Application Acknowledgment
type MFK_M09 ¶
type MFK_M09 struct {
HL7 HL7Name `hl7:",name=MFK_M09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Test/Observation (Categorical) Master File Application Acknowledgment
type MFK_M10 ¶
type MFK_M10 struct {
HL7 HL7Name `hl7:",name=MFK_M10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Test/Observation Batteries Master File Application Acknowledgment
type MFK_M11 ¶
type MFK_M11 struct {
HL7 HL7Name `hl7:",name=MFK_M11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
}
Test/Calculated Observations Master File Application Acknowledgment
type MFK_M12 ¶
type MFK_M12 struct {
HL7 HL7Name `hl7:",name=MFK_M12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Additional Basic Observation/Service Attributes Master File Application Acknowledgment
type MFK_M13 ¶
type MFK_M13 struct {
HL7 HL7Name `hl7:",name=MFK_M13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
General Master File Application Acknowledgment
The MFN General master file notification transaction is used where the master file is a simple one that contains only a key and the text value of that key. Both values are carried in MFE-4 - Primary Key Value - MFE. The specific master file being updated is identified by MFI-1 - Master File Identifier and MFI-2 - Master Files Application Identifier.
The MFA segment carries acknowledgment information for the corresponding MFE segment (identified by MFA-5 - Primary Key Value - MFA). Fields MFE-4 - Primary Key Value - MFE and MFA-5 - Primary Key Value - MFA provide the link between the corresponding segments.
type MFK_M14 ¶
type MFK_M14 struct {
HL7 HL7Name `hl7:",name=MFK_M14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Site Defined Master File Application Acknowledgment
The MFN Site defined master file notification transaction is used where the master file is not a simple one (as defined for MFN^M13) and is not a transaction type currently defined by HL7, but rather requires one or more HL7 and/or 'Z' segments to carry the master file information.
The master file record identified by the MFE segment is contained in Z-segments immediately following the MFE segment, and is denoted by "..." in the MFN abstract message definition given above. This record may be either a flat record contained in a single segment, or a complex record needing more than a single segment to carry its data and (usually hierarchical) structure.
The definition of this transaction and the associated abstract message structure code (as defined in MSH-9 - Message Type, denoted by MFN_Znn above) are subject to site negotiation. Refer to Chapter 2, section 2.17, "Local Extension" for additional information on 'Z' abstract message structure code definition.
type MFK_M15 ¶
type MFK_M15 struct {
HL7 HL7Name `hl7:",name=MFK_M15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Inventory Item Master File Application Acknowledgment
This section is concerned with describing a master file message that should be used to communicate information that relates to the inventory of items that can be used to perform an ordered service. While an order specifies a service that is represented in an Other Observation/Service Item master file, this message is concerned with communicating attributes of those orderable items (for example lot number and expiration date) that are represented in the Other Observation/Service Item master file. These attributes are more granular than can be represented in the Other Observation/Service Item master file as there may be multiple items in inventory that meet the characteristics of the Service Item but have different specific characteristics, e.g., multiple lots of a vaccine.
type MFK_M16 ¶
type MFK_M16 struct {
HL7 HL7Name `hl7:",name=MFK_M16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
Enhanced Inventory Item Master File Application Acknowledgment
This section describes a master file message designed to communicate information that relates to the sharing of material item master catalog and material item-inventory information between materials management systems and other systems such as surgical and immunization systems. The synchronization of the "item master" between systems and across the enterprise enables the success of the subsequent interfacing of transactions such as: material item requisitions (pre and post case), accounts payable invoices for the payment of material items, journal entries generated from the issue of items to departments or other inventory locations, and patient charges that allow a customer to improve patient care through the better management of materials. To face budget challenges, healthcare organizations need materials management systems that integrate with finance to automate logistics, eliminate paperwork and analyze data to improve efficiency and reduce overall costs. This process is a major contributor to improving the customers' bottom line by helping to eliminate materials waste, streamline ordering, ensure accurate payment of materials purchased, ensure accurate billing for materials used, and an accurate presentation of the financial statements of a healthcare facility.
type MFK_M17 ¶
type MFK_M17 struct {
HL7 HL7Name `hl7:",name=MFK_M17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
MFI *MFI `hl7:"6,required,display=Master File Identification"`
MFA []MFA `hl7:"7,display=Master File Acknowledgment"`
}
DRG Master File Application Acknowledgment
This section is specifically concerned with describing a master file message that should be used to transmit information which identifies the DRG basic information, such as relative weight, lower and upper trim points, etc.
type MFN_M01 ¶
type MFN_M01 struct {
HL7 HL7Name `hl7:",name=MFN_M01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MFI *MFI `hl7:"3,required,display=Master File Identification"`
Mf []MFN_M01_Mf `hl7:",required,display=Mf"`
}
Master File Notification
MFN_M01 is retained for backward compatibility only as of v2.5 and later. It is recommended that the specific non-deprecated master file messages that follow be used as they apply to new implementations (such as MFN_M02, MFN_M08, MFN_M09, etc.).
type MFN_M01_Mf ¶
type MFN_M01_Mf struct {
HL7 HL7Name `hl7:",name=MFN_M01_Mf,type=tg"`
MFE *MFE `hl7:"4,required,display=Master File Entry"`
}
Mf
type MFN_M02 ¶
type MFN_M02 struct {
HL7 HL7Name `hl7:",name=MFN_M02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfStaff []MFN_M02_MfStaff `hl7:",required,display=Mf Staff"`
}
Staff/Practitioner Master File Notification
The staff identification (STF), practitioner detail (PRA), practitioner organization unit segment (ORG), professional affiliation (AFF), language detail (LAN), educational detail (EDU), and certificate detail (CER) segments can be used to transmit master files information between systems. The STF segment provides general information about personnel; the PRA, ORG, AFF, LAN, EDU, CER and NTE segments provide detailed information for a staff member.
type MFN_M02_MfStaff ¶
type MFN_M02_MfStaff struct {
HL7 HL7Name `hl7:",name=MFN_M02_MfStaff,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
STF *STF `hl7:"6,required,display=Staff Identification"`
PRA []PRA `hl7:"7,display=Practitioner Detail"`
ORG []ORG `hl7:"8,display=Practitioner Organization Unit"`
AFF []AFF `hl7:"9,display=Professional Affiliation"`
LAN []LAN `hl7:"10,display=Language Detail"`
EDU []EDU `hl7:"11,display=Educational Detail"`
CER []CER `hl7:"12,display=Certificate Detail"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
MfStaff
type MFN_M03 ¶
type MFN_M03 struct {
HL7 HL7Name `hl7:",name=MFN_M03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MFI *MFI `hl7:"3,required,display=Master File Identification"`
MfTest []MFN_M03_MfTest `hl7:",required,display=Mf Test"`
}
Test/Observation Master File Notification
MFN_M03 is retained for backward compatibility only as of v2.4 and later. It is recommended that the specific master file messages which follow (MFN_M08, MFN_M09, MFN_M10, MFN_M11, and MFN_M12) be used as they apply to new implementations.
type MFN_M03_MfTest ¶
type MFN_M03_MfTest struct {
HL7 HL7Name `hl7:",name=MFN_M03_MfTest,type=tg"`
MFE *MFE `hl7:"4,required,display=Master File Entry"`
OM1 *OM1 `hl7:"5,required,display=General Segment"`
}
MfTest
type MFN_M04 ¶
type MFN_M04 struct {
HL7 HL7Name `hl7:",name=MFN_M04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfCdm []MFN_M04_MfCdm `hl7:",required,display=Mf Cdm"`
}
Charge Description Master File Notification
The charge description (CDM) master file segment should be used in conjunction with the general master file segments. Interfacing systems often need not only to communicate data about a patient's detailed charges, but also to communicate the charge identification entries by which an application knows how to handle a particular charge code. The charge description master is a master file. The CDM segment below is a specially designed master file segment for interfacing charge description masters. In the following message, the MFI-master file identifier should equal "CDM." When the CDM segment is used in an MFN message, the abstract definition is as follows.
type MFN_M04_MfCdm ¶
type MFN_M04_MfCdm struct {
HL7 HL7Name `hl7:",name=MFN_M04_MfCdm,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
CDM *CDM `hl7:"6,required,display=Charge Description Master"`
PRC []PRC `hl7:"7,display=Pricing"`
}
MfCdm
type MFN_M05 ¶
type MFN_M05 struct {
HL7 HL7Name `hl7:",name=MFN_M05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfLocation []MFN_M05_MfLocation `hl7:",required,display=Mf Location"`
}
Patient Location Master File Notification
This section is specifically concerned with describing a master file message that should be used to transmit information which identifies the inventory of healthcare patient locations, such as nursing units, rooms, beds, clinics, exam rooms, etc. In a network environment, this segment can be used to define patient locations to other applications. The segment also includes the readiness states and support locations for the patient locations.
The LOC, LCH, LRL, LDP, and LCC segments must be preceded by the MFI and MFE segments, as described in Section 8.5, "GENERAL MASTER FILE SEGMENTS." In the following message, the MFI-1 - Master File Identifier field should equal "LOC"
type MFN_M05_MfLocDept ¶
type MFN_M05_MfLocDept struct {
HL7 HL7Name `hl7:",name=MFN_M05_MfLocDept,type=tg"`
LDP *LDP `hl7:"9,required,display=Location Department"`
LCH []LCH `hl7:"10,display=Location Characteristic"`
LCC []LCC `hl7:"11,display=Location Charge Code"`
}
MfLocDept
type MFN_M05_MfLocation ¶
type MFN_M05_MfLocation struct {
HL7 HL7Name `hl7:",name=MFN_M05_MfLocation,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
LOC *LOC `hl7:"6,required,display=Location Identification"`
LCH []LCH `hl7:"7,display=Location Characteristic"`
LRL []LRL `hl7:"8,display=Location Relationship"`
MfLocDept []MFN_M05_MfLocDept `hl7:",required,display=Mf Loc Dept"`
}
MfLocation
type MFN_M06 ¶
type MFN_M06 struct {
HL7 HL7Name `hl7:",name=MFN_M06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfClinStudy []MFN_M06_MfClinStudy `hl7:",required,display=Mf Clin Study"`
}
Clinical Study with Phases and Schedules Master File Notification
MFN message for Clinical Study with phases and schedules
type MFN_M06_MfClinStudy ¶
type MFN_M06_MfClinStudy struct {
HL7 HL7Name `hl7:",name=MFN_M06_MfClinStudy,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
CM0 *CM0 `hl7:"6,required,display=Clinical Study Master"`
MfPhaseSchedDetail []MFN_M06_MfPhaseSchedDetail `hl7:",display=Mf Phase Sched Detail"`
}
MfClinStudy
type MFN_M06_MfPhaseSchedDetail ¶
type MFN_M06_MfPhaseSchedDetail struct {
HL7 HL7Name `hl7:",name=MFN_M06_MfPhaseSchedDetail,type=tg"`
CM1 *CM1 `hl7:"7,required,display=Clinical Study Phase Master"`
CM2 []CM2 `hl7:"8,display=Clinical Study Schedule Master"`
}
MfPhaseSchedDetail
type MFN_M07 ¶
type MFN_M07 struct {
HL7 HL7Name `hl7:",name=MFN_M07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfClinStudySched []MFN_M07_MfClinStudySched `hl7:",required,display=Mf Clin Study Sched"`
}
Clinical Study Without Phases But With Schedules Master File Notification
MFN message for Clinical Study without phases but with schedules
type MFN_M07_MfClinStudySched ¶
type MFN_M07_MfClinStudySched struct {
HL7 HL7Name `hl7:",name=MFN_M07_MfClinStudySched,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
CM0 *CM0 `hl7:"6,required,display=Clinical Study Master"`
CM2 []CM2 `hl7:"7,display=Clinical Study Schedule Master"`
}
MfClinStudySched
type MFN_M08 ¶
type MFN_M08 struct {
HL7 HL7Name `hl7:",name=MFN_M08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfTestNumeric []MFN_M08_MfTestNumeric `hl7:",required,display=Mf Test Numeric"`
}
Test/Observation (Numeric) Master File Notification
type MFN_M08_MfTestNumeric ¶
type MFN_M08_MfTestNumeric struct {
HL7 HL7Name `hl7:",name=MFN_M08_MfTestNumeric,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
OM1 *OM1 `hl7:"6,required,display=General Segment"`
OM2 *OM2 `hl7:"7,display=Numeric Observation"`
OM3 *OM3 `hl7:"8,display=Categorical Service/Test/Observation"`
OM4 *OM4 `hl7:"9,display=Observations That Require Specimens"`
}
MfTestNumeric
type MFN_M09 ¶
type MFN_M09 struct {
HL7 HL7Name `hl7:",name=MFN_M09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfTestCategorical []MFN_M09_MfTestCategorical `hl7:",required,display=Mf Test Categorical"`
}
Test/Observation (Categorical) Master File Notification
type MFN_M09_MfTestCatDetail ¶
type MFN_M09_MfTestCatDetail struct {
HL7 HL7Name `hl7:",name=MFN_M09_MfTestCatDetail,type=tg"`
OM3 *OM3 `hl7:"7,required,display=Categorical Service/Test/Observation"`
OM4 []OM4 `hl7:"8,display=Observations That Require Specimens"`
}
MfTestCatDetail
type MFN_M09_MfTestCategorical ¶
type MFN_M09_MfTestCategorical struct {
HL7 HL7Name `hl7:",name=MFN_M09_MfTestCategorical,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
OM1 *OM1 `hl7:"6,required,display=General Segment"`
MfTestCatDetail *MFN_M09_MfTestCatDetail `hl7:",display=Mf Test Cat Detail"`
}
MfTestCategorical
type MFN_M10 ¶
type MFN_M10 struct {
HL7 HL7Name `hl7:",name=MFN_M10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfTestBatteries []MFN_M10_MfTestBatteries `hl7:",required,display=Mf Test Batteries"`
}
Test/Observation Batteries Master File Notification
type MFN_M10_MfTestBattDetail ¶
type MFN_M10_MfTestBattDetail struct {
HL7 HL7Name `hl7:",name=MFN_M10_MfTestBattDetail,type=tg"`
OM5 *OM5 `hl7:"7,required,display=Observation Batteries (Sets)"`
OM4 []OM4 `hl7:"8,display=Observations That Require Specimens"`
}
MfTestBattDetail
type MFN_M10_MfTestBatteries ¶
type MFN_M10_MfTestBatteries struct {
HL7 HL7Name `hl7:",name=MFN_M10_MfTestBatteries,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
OM1 *OM1 `hl7:"6,required,display=General Segment"`
MfTestBattDetail *MFN_M10_MfTestBattDetail `hl7:",display=Mf Test Batt Detail"`
}
MfTestBatteries
type MFN_M11 ¶
type MFN_M11 struct {
HL7 HL7Name `hl7:",name=MFN_M11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfTestCalculated []MFN_M11_MfTestCalculated `hl7:",required,display=Mf Test Calculated"`
}
Test/Calculated Observations Master File Notification
type MFN_M11_MfTestCalcDetail ¶
type MFN_M11_MfTestCalcDetail struct {
HL7 HL7Name `hl7:",name=MFN_M11_MfTestCalcDetail,type=tg"`
OM6 *OM6 `hl7:"7,required,display=Observations that are Calculated from Other Observations"`
OM2 *OM2 `hl7:"8,required,display=Numeric Observation"`
}
MfTestCalcDetail
type MFN_M11_MfTestCalculated ¶
type MFN_M11_MfTestCalculated struct {
HL7 HL7Name `hl7:",name=MFN_M11_MfTestCalculated,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
OM1 *OM1 `hl7:"6,required,display=General Segment"`
MfTestCalcDetail *MFN_M11_MfTestCalcDetail `hl7:",display=Mf Test Calc Detail"`
}
MfTestCalculated
type MFN_M12 ¶
type MFN_M12 struct {
HL7 HL7Name `hl7:",name=MFN_M12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfObsAttributes []MFN_M12_MfObsAttributes `hl7:",required,display=Mf Obs Attributes"`
}
Additional Basic Observation/Service Attributes Master File Notification
type MFN_M12_MfObsAttributes ¶
type MFN_M12_MfObsAttributes struct {
HL7 HL7Name `hl7:",name=MFN_M12_MfObsAttributes,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
OM1 *OM1 `hl7:"6,required,display=General Segment"`
OM7 *OM7 `hl7:"7,display=Additional Basic Attributes"`
}
MfObsAttributes
type MFN_M13 ¶
type MFN_M13 struct {
HL7 HL7Name `hl7:",name=MFN_M13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MFE []MFE `hl7:"5,required,display=Master File Entry"`
}
General Master File Notification
The MFN General master file notification transaction is used where the master file is a simple one that contains only a key and the text value of that key. Both values are carried in MFE-4 - Primary Key Value - MFE. The specific master file being updated is identified by MFI-1 - Master File Identifier and MFI-2 - Master Files Application Identifier.
type MFN_M14 ¶
type MFN_M14 struct {
HL7 HL7Name `hl7:",name=MFN_M14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfSiteDefined []MFN_M14_MfSiteDefined `hl7:",required,display=Mf Site Defined"`
}
Site Defined Master File Notification
The MFN Site defined master file notification transaction is used where the master file is not a simple one (as defined for MFN_M13) and is not a transaction type currently defined by HL7, but rather requires one or more HL7 and/or 'Z' segments to carry the master file information.
type MFN_M14_MfSiteDefined ¶
type MFN_M14_MfSiteDefined struct {
HL7 HL7Name `hl7:",name=MFN_M14_MfSiteDefined,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
}
MfSiteDefined
type MFN_M15 ¶
type MFN_M15 struct {
HL7 HL7Name `hl7:",name=MFN_M15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfInvItem []MFN_M15_MfInvItem `hl7:",required,display=Mf Inv Item"`
}
Inventory Item Master File Notification
This section is concerned with describing a master file message that should be used to communicate information that relates to the inventory of items that can be used to perform an ordered service. While an order specifies a service that is represented in an Other Observation/Service Item master file, this message is concerned with communicating attributes of those orderable items (for example lot number and expiration date) that are represented in the Other Observation/Service Item master file. These attributes are more granular than can be represented in the Other Observation/Service Item master file as there may be multiple items in inventory that meet the characteristics of the Service Item but have different specific characteristics, e.g., multiple lots of a vaccine.
type MFN_M15_MfInvItem ¶
type MFN_M15_MfInvItem struct {
HL7 HL7Name `hl7:",name=MFN_M15_MfInvItem,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
IIM *IIM `hl7:"6,required,display=Inventory Item Master"`
}
MfInvItem
type MFN_M16 ¶
type MFN_M16 struct {
HL7 HL7Name `hl7:",name=MFN_M16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MaterialItemRecord []MFN_M16_MaterialItemRecord `hl7:",required,display=Material Item Record"`
}
Enhanced Inventory Item Master File Notification
This section describes a master file message designed to communicate information that relates to the sharing of material item master catalog and material item-inventory information between materials management systems and other systems such as surgical and immunization systems. The synchronization of the "item master" between systems and across the enterprise enables the success of the subsequent interfacing of transactions such as: material item requisitions (pre and post case), accounts payable invoices for the payment of material items, journal entries generated from the issue of items to departments or other inventory locations, and patient charges that allow a customer to improve patient care through the better management of materials. To face budget challenges, healthcare organizations need materials management systems that integrate with finance to automate logistics, eliminate paperwork and analyze data to improve efficiency and reduce overall costs. This process is a major contributor to improving the customers' bottom line by helping to eliminate materials waste, streamline ordering, ensure accurate payment of materials purchased, ensure accurate billing for materials used, and an accurate presentation of the financial statements of a healthcare facility.
type MFN_M16_MaterialItemRecord ¶
type MFN_M16_MaterialItemRecord struct {
HL7 HL7Name `hl7:",name=MFN_M16_MaterialItemRecord,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
ITM *ITM `hl7:"6,required,display=Material Item"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
Sterilization []MFN_M16_Sterilization `hl7:",display=Sterilization"`
PurchasingVendor []MFN_M16_PurchasingVendor `hl7:",display=Purchasing Vendor"`
MaterialLocation []MFN_M16_MaterialLocation `hl7:",display=Material Location"`
}
MaterialItemRecord
type MFN_M16_MaterialLocation ¶
type MFN_M16_MaterialLocation struct {
HL7 HL7Name `hl7:",name=MFN_M16_MaterialLocation,type=tg"`
IVT *IVT `hl7:"13,required,display=Material Location"`
ILT []ILT `hl7:"14,display=Material Lot Segment"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
MaterialLocation
type MFN_M16_Packaging ¶
type MFN_M16_Packaging struct {
HL7 HL7Name `hl7:",name=MFN_M16_Packaging,type=tg"`
PKG *PKG `hl7:"11,required,display=Packaging Segment"`
PCE []PCE `hl7:"12,display=Patient Charge Cost Center Exception"`
}
Packaging
type MFN_M16_PurchasingVendor ¶
type MFN_M16_PurchasingVendor struct {
HL7 HL7Name `hl7:",name=MFN_M16_PurchasingVendor,type=tg"`
VND *VND `hl7:"10,required,display=Purchasing Vendor"`
Packaging []MFN_M16_Packaging `hl7:",display=Packaging"`
}
PurchasingVendor
type MFN_M16_Sterilization ¶
type MFN_M16_Sterilization struct {
HL7 HL7Name `hl7:",name=MFN_M16_Sterilization,type=tg"`
STZ *STZ `hl7:"8,required,display=Sterilization Parameter"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Sterilization
type MFN_M17 ¶
type MFN_M17 struct {
HL7 HL7Name `hl7:",name=MFN_M17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MFI *MFI `hl7:"4,required,display=Master File Identification"`
MfDrg []MFN_M17_MfDrg `hl7:",required,display=Mf Drg"`
}
DRG Master File
This section is specifically concerned with describing a master file message that should be used to transmit information which identifies the DRG basic information, such as relative weight, lower and upper trim points, etc.
The DMI segment must be preceded by the MFI and MFE segments, as described in Section 8.5, GENERAL MASTER FILE SEGMENTS. In the following message, the MFI-1 - Master File Identifier field should equal "DMI".
type MFN_M17_MfDrg ¶
type MFN_M17_MfDrg struct {
HL7 HL7Name `hl7:",name=MFN_M17_MfDrg,type=tg"`
MFE *MFE `hl7:"5,required,display=Master File Entry"`
DMI *DMI `hl7:"6,required,display=DRG Master File Information"`
}
MfDrg
type MFQ_M01 ¶
type MFQ_M01 struct {
HL7 HL7Name `hl7:",name=MFQ_M01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query for master file record
The MFQ/MFR transaction is retained for backward compatibility as of v2.5 and later.
type MFR_M01 ¶
type MFR_M01 struct {
HL7 HL7Name `hl7:",name=MFR_M01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
MFI *MFI `hl7:"9,required,display=Master File Identification"`
MfQuery []MFR_M01_MfQuery `hl7:",required,display=Mf Query"`
DSC *DSC `hl7:"11,display=Continuation Pointer"`
}
Master files response
The MFQ/MFR transaction is retained for backward compatibility as of v2.5 and later. See conformance based queries as defined in Chapter 5. Refer to Section 8.4.5 for an example of a master file conformance based query.
type MFR_M01_MfQuery ¶
type MFR_M01_MfQuery struct {
HL7 HL7Name `hl7:",name=MFR_M01_MfQuery,type=tg"`
MFE *MFE `hl7:"10,required,display=Master File Entry"`
}
MfQuery
type MFR_M04 ¶
type MFR_M04 struct {
HL7 HL7Name `hl7:",name=MFR_M04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
MFI *MFI `hl7:"9,required,display=Master File Identification"`
MfQuery []MFR_M04_MfQuery `hl7:",required,display=Mf Query"`
DSC *DSC `hl7:"13,display=Continuation Pointer"`
}
Master files response
Master Files Query Response: The MFQ//MFR transaction is retained for backward compatibility as of v2.5.
type MFR_M04_MfQuery ¶
type MFR_M04_MfQuery struct {
HL7 HL7Name `hl7:",name=MFR_M04_MfQuery,type=tg"`
MFE *MFE `hl7:"10,required,display=Master File Entry"`
CDM *CDM `hl7:"11,required,display=Charge Description Master"`
PRC []PRC `hl7:"12,display=Pricing"`
}
MfQuery
type MFR_M05 ¶
type MFR_M05 struct {
HL7 HL7Name `hl7:",name=MFR_M05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
MFI *MFI `hl7:"9,required,display=Master File Identification"`
MfQuery []MFR_M05_MfQuery `hl7:",required,display=Mf Query"`
DSC *DSC `hl7:"17,display=Continuation Pointer"`
}
Master files response
The MFQ//MFR transactiomfrn is retained for backward compatibility as of v2.5.
type MFR_M05_MfLocation ¶
type MFR_M05_MfLocation struct {
HL7 HL7Name `hl7:",name=MFR_M05_MfLocation,type=tg"`
LDP *LDP `hl7:"14,required,display=Location Department"`
LCH []LCH `hl7:"15,display=Location Characteristic"`
LCC []LCC `hl7:"16,display=Location Charge Code"`
}
MfLocation
type MFR_M05_MfQuery ¶
type MFR_M05_MfQuery struct {
HL7 HL7Name `hl7:",name=MFR_M05_MfQuery,type=tg"`
MFE *MFE `hl7:"10,required,display=Master File Entry"`
LOC *LOC `hl7:"11,required,display=Location Identification"`
LCH []LCH `hl7:"12,display=Location Characteristic"`
LRL []LRL `hl7:"13,display=Location Relationship"`
MfLocation []MFR_M05_MfLocation `hl7:",required,display=Mf Location"`
}
MfQuery
type MFR_M06 ¶
type MFR_M06 struct {
HL7 HL7Name `hl7:",name=MFR_M06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"4,display=Error"`
QAK *QAK `hl7:"5,display=Query Acknowledgment"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
MFI *MFI `hl7:"8,required,display=Master File Identification"`
MfQuery []MFR_M06_MfQuery `hl7:",required,display=Mf Query"`
DSC *DSC `hl7:"13,display=Continuation Pointer"`
}
Master files response
The MFQ//MFR transactiomfrn is retained for backward compatibility as of v2.5.
type MFR_M06_MfClinicalStudy ¶
type MFR_M06_MfClinicalStudy struct {
HL7 HL7Name `hl7:",name=MFR_M06_MfClinicalStudy,type=tg"`
CM1 *CM1 `hl7:"11,required,display=Clinical Study Phase Master"`
CM2 []CM2 `hl7:"12,display=Clinical Study Schedule Master"`
}
MfClinicalStudy
type MFR_M06_MfQuery ¶
type MFR_M06_MfQuery struct {
HL7 HL7Name `hl7:",name=MFR_M06_MfQuery,type=tg"`
MFE *MFE `hl7:"9,required,display=Master File Entry"`
CM0 *CM0 `hl7:"10,required,display=Clinical Study Master"`
MfClinicalStudy []MFR_M06_MfClinicalStudy `hl7:",display=Mf Clinical Study"`
}
MfQuery
type MFR_M07 ¶
type MFR_M07 struct {
HL7 HL7Name `hl7:",name=MFR_M07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"4,display=Error"`
QAK *QAK `hl7:"5,display=Query Acknowledgment"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
MFI *MFI `hl7:"8,required,display=Master File Identification"`
MfQuery []MFR_M07_MfQuery `hl7:",required,display=Mf Query"`
DSC *DSC `hl7:"12,display=Continuation Pointer"`
}
Master files response
Master Files Query Response: The MFQ//MFR transaction is retained for backward compatibility as of v2.5.
type MFR_M07_MfQuery ¶
type MFR_M07_MfQuery struct {
HL7 HL7Name `hl7:",name=MFR_M07_MfQuery,type=tg"`
MFE *MFE `hl7:"9,required,display=Master File Entry"`
CM0 *CM0 `hl7:"10,required,display=Clinical Study Master"`
CM2 []CM2 `hl7:"11,display=Clinical Study Schedule Master"`
}
MfQuery
type MO ¶
type MO struct {
HL7 HL7Name `hl7:",name=MO,len=20,type=d"`
Quantity NM `hl7:"1,len=16,display=The first component is a quantity."`
Denomination ID `` /* 304-byte string literal not displayed */
}
Money
This data type specifies an amount of money and the denomination in which it is expressed.
type MOC ¶
type MOC struct {
HL7 HL7Name `hl7:",name=MOC,len=726,type=d"`
MonetaryAmount *MO `hl7:"1,len=20,display=The amount and denomination of money associated with the charge code."`
ChargeCode *CWE `hl7:"2,len=705,display=The code identifying the charge to the ordering entity for the services performed."`
}
Money and Code
Transmits monetary information and the associated charge code for services performed.
type MOP ¶
type MOP struct {
HL7 HL7Name `hl7:",name=MOP,len=23,type=d"`
MoneyOrPercentageIndicator ID `hl7:"1,required,len=2,table=0148,display=Specifies whether the amount is currency or a percentage."`
MoneyOrPercentageQuantity NM `hl7:"2,required,len=16,display=Specifies the currency or percentage quantity."`
CurrencyDenomination ID `` /* 339-byte string literal not displayed */
}
Money or Percentage
This data type specifies an amount that may be either currency or a percentage. It is a variation on the MO data type that is limited to currency.
type MRG ¶
type MRG struct {
HL7 HL7Name `hl7:",name=MRG,type=s"`
PriorPatientIdentifierList []CX `hl7:"1,required,len=250,display=Prior Patient Identifier List"`
PriorAlternatePatientID []CX `hl7:"2,len=250,display=Prior Alternate Patient ID"`
PriorPatientAccountNumber *CX `hl7:"3,len=250,display=Prior Patient Account Number"`
PriorPatientID CX `hl7:"4,len=250,display=Prior Patient ID"`
PriorVisitNumber *CX `hl7:"5,len=250,display=Prior Visit Number"`
PriorAlternateVisitID *CX `hl7:"6,len=250,display=Prior Alternate Visit ID"`
PriorPatientName []XPN `hl7:"7,len=250,display=Prior Patient Name"`
}
Merge Patient Information
The MRG segment provides receiving applications with information necessary to initiate the merging of patient data as well as groups of records. It is intended that this segment be used throughout the Standard to allow the merging of registration, accounting, and clinical records within specific applications.
type MSA ¶
type MSA struct {
HL7 HL7Name `hl7:",name=MSA,type=s"`
AcknowledgmentCode ID `hl7:"1,required,len=2,table=0008,display=Acknowledgment Code"`
MessageControlID ST `hl7:"2,required,len=199,display=Message Control ID"`
TextMessage ST `hl7:"3,len=80,display=Text Message"`
ExpectedSequenceNumber NM `hl7:"4,len=15,display=Expected Sequence Number"`
DelayedAcknowledgmentType ST `hl7:"5,display=Delayed Acknowledgment Type"`
ErrorCondition CE `hl7:"6,len=250,table=0357,display=Error Condition"`
MessageWaitingNumber NM `hl7:"7,len=5,display=Message Waiting Number"`
MessageWaitingPriority ID `hl7:"8,len=1,table=0520,display=Message Waiting Priority"`
}
Message Acknowledgment
The MSA segment contains information sent while acknowledging another message.
type MSG ¶
type MSG struct {
HL7 HL7Name `hl7:",name=MSG,len=0,type=d"`
MessageCode ID `` /* 148-byte string literal not displayed */
TriggerEvent ID `` /* 147-byte string literal not displayed */
MessageStructure ID `` /* 168-byte string literal not displayed */
}
Message Type
This field contains the message type, trigger event, and the message structure ID for the message.
func (MSG) MessageStructureID ¶
type MSH ¶
type MSH struct {
HL7 HL7Name `hl7:",name=MSH,type=s"`
FieldSeparator ST `hl7:"1,noescape,fieldsep,omit,required,len=1,display=Field Separator"`
EncodingCharacters ST `hl7:"2,noescape,fieldchars,required,len=4,display=Encoding Characters"`
SendingApplication *HD `hl7:"3,len=227,table=0361,display=Sending Application"`
SendingFacility *HD `hl7:"4,len=227,table=0362,display=Sending Facility"`
ReceivingApplication *HD `hl7:"5,len=227,table=0361,display=Receiving Application"`
ReceivingFacility *HD `hl7:"6,len=227,table=0362,display=Receiving Facility"`
DateTimeOfMessage DTM `hl7:"7,required,len=24,format=YMDHM,display=Date/Time Of Message"`
Security ST `hl7:"8,len=40,display=Security"`
MessageType MSG `hl7:"9,required,len=15,display=Message Type"`
MessageControlID ST `hl7:"10,required,len=199,display=Message Control ID"`
ProcessingID PT `hl7:"11,required,len=3,display=Processing ID"`
VersionID VID `hl7:"12,required,len=60,display=Version ID"`
SequenceNumber NM `hl7:"13,len=15,display=Sequence Number"`
ContinuationPointer ST `hl7:"14,len=180,display=Continuation Pointer"`
AcceptAcknowledgmentType ID `hl7:"15,len=2,table=0155,display=Accept Acknowledgment Type"`
ApplicationAcknowledgmentType ID `hl7:"16,len=2,table=0155,display=Application Acknowledgment Type"`
CountryCode ID `hl7:"17,len=3,table=0399,display=Country Code"`
CharacterSet []ID `hl7:"18,len=16,table=0211,display=Character Set"`
PrincipalLanguageOfMessage *CWE `hl7:"19,len=250,display=Principal Language Of Message"`
AlternateCharacterSetHandlingScheme ID `hl7:"20,len=20,table=0356,display=Alternate Character Set Handling Scheme"`
MessageProfileIdentifier []EI `hl7:"21,len=427,display=Message Profile Identifier"`
SendingResponsibleOrganization *XON `hl7:"22,len=567,display=Sending Responsible Organization"`
ReceivingResponsibleOrganization *XON `hl7:"23,len=567,display=Receiving Responsible Organization"`
SendingNetworkAddress *HD `hl7:"24,len=227,display=Sending Network Address"`
ReceivingNetworkAddress *HD `hl7:"25,len=227,display=Receiving Network Address"`
}
Message Header
The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message.
func (MSH) MessageStructureID ¶
MessageStructureID returns the code for the message structure. Implements the interface for decoders.
type NA ¶
type NA struct {
HL7 HL7Name `hl7:",name=NA,len=65536,type=d"`
Value1 NM `hl7:"1,required,len=16,display=Value1"`
Value2 NM `hl7:"2,len=16,display=Value2"`
Value3 NM `hl7:"3,len=16,display=Value3"`
Value4 NM `hl7:"4,len=16,display=Value4"`
}
Numeric Array
This data type is used to represent a series (array) of numeric values. A field of this type may contain a one-dimensional array (vector or row) of numbers. Also, by allowing the field to repeat, a two-dimensional array (table) of numbers may be transmitted using this format, with each row of the table represented as one repetition of the field. Arrays that have one or more values not present may be transmitted using this data type. "Not present" values are represented as two adjacent component delimiters. If the absent values occur at the end of a row, the trailing component delimiters may be omitted. If an entire row of a table has no values, no component delimiters are necessary (in this case, there will be two adjacent repetition delimiters).
type NCK ¶
type NCK struct {
HL7 HL7Name `hl7:",name=NCK,type=s"`
SystemDateTime DTM `hl7:"1,required,len=24,format=YMDHM,display=System Date/Time"`
}
System Clock
The NCK segment is used to allow the various applications on the network to synchronize their system clocks (system date and time).
type NDL ¶
type NDL struct {
HL7 HL7Name `hl7:",name=NDL,len=831,type=d"`
Name *CNN `hl7:"1,len=406,display=This component specifies the name of the person performing a service."`
StartDateTime DTM `` /* 134-byte string literal not displayed */
EndDateTime DTM `` /* 132-byte string literal not displayed */
PointOfCare IS `` /* 350-byte string literal not displayed */
Room IS `` /* 175-byte string literal not displayed */
Bed IS `` /* 208-byte string literal not displayed */
Facility *HD `` /* 229-byte string literal not displayed */
LocationStatus IS `` /* 227-byte string literal not displayed */
PatientLocationType IS `` /* 397-byte string literal not displayed */
Building IS `` /* 241-byte string literal not displayed */
Floor IS `` /* 235-byte string literal not displayed */
}
Name with Date and Location
Specifies the name of the person performing a service, when the person performed the service and where the person performed the service. Retained for backward compatibility as of v2.6.
type NDS ¶
type NDS struct {
HL7 HL7Name `hl7:",name=NDS,type=s"`
NotificationReferenceNumber NM `hl7:"1,required,len=20,display=Notification Reference Number"`
NotificationDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Notification Date/Time"`
NotificationAlertSeverity CWE `hl7:"3,required,len=705,table=0367,display=Notification Alert Severity"`
NotificationCode CWE `hl7:"4,required,len=705,display=Notification Code"`
}
Notification Detail
The equipment notification detail segment is the data necessary to maintain an adequate audit trail as well as notifications of events, (e.g., alarms that have occurred on a particular piece of equipment.
type NK1 ¶
type NK1 struct {
HL7 HL7Name `hl7:",name=NK1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - NK1"`
Name []XPN `hl7:"2,len=250,display=Name"`
Relationship *CWE `hl7:"3,len=705,table=0063,display=Relationship"`
Address []XAD `hl7:"4,len=250,display=Address"`
PhoneNumber []XTN `hl7:"5,len=250,display=Phone Number"`
BusinessPhoneNumber []XTN `hl7:"6,len=250,display=Business Phone Number"`
ContactRole *CWE `hl7:"7,len=705,table=0131,display=Contact Role"`
StartDate DT `hl7:"8,len=8,format=YMD,display=Start Date"`
EndDate DT `hl7:"9,len=8,format=YMD,display=End Date"`
NextOfKinAssociatedPartiesJobTitle ST `hl7:"10,len=60,display=Next of Kin / Associated Parties Job Title"`
NextOfKinAssociatedPartiesJobCodeClass *JCC `hl7:"11,len=20,display=Next of Kin / Associated Parties Job Code/Class"`
NextOfKinAssociatedPartiesEmployeeNumber *CX `hl7:"12,len=250,display=Next of Kin / Associated Parties Employee Number"`
OrganizationName []XON `hl7:"13,len=250,display=Organization Name - NK1"`
MaritalStatus *CWE `hl7:"14,len=705,table=0002,display=Marital Status"`
AdministrativeSex IS `hl7:"15,len=1,table=0001,display=Administrative Sex"`
DateTimeOfBirth DTM `hl7:"16,len=24,format=YMDHM,display=Date/Time of Birth"`
LivingDependency []IS `hl7:"17,len=2,table=0223,display=Living Dependency"`
AmbulatoryStatus []IS `hl7:"18,len=2,table=0009,display=Ambulatory Status"`
Citizenship []CWE `hl7:"19,len=705,table=0171,display=Citizenship"`
PrimaryLanguage *CWE `hl7:"20,len=705,table=0296,display=Primary Language"`
LivingArrangement IS `hl7:"21,len=2,table=0220,display=Living Arrangement"`
PublicityCode *CWE `hl7:"22,len=705,table=0215,display=Publicity Code"`
ProtectionIndicator ID `hl7:"23,len=1,table=0136,display=Protection Indicator"`
StudentIndicator IS `hl7:"24,len=2,table=0231,display=Student Indicator"`
Religion *CWE `hl7:"25,len=705,table=0006,display=Religion"`
MothersMaidenName []XPN `hl7:"26,len=250,display=Mother's Maiden Name"`
Nationality *CWE `hl7:"27,len=705,table=0212,display=Nationality"`
EthnicGroup []CWE `hl7:"28,len=705,table=0189,display=Ethnic Group"`
ContactReason []CWE `hl7:"29,len=705,table=0222,display=Contact Reason"`
ContactPersonsName []XPN `hl7:"30,len=250,display=Contact Person's Name"`
ContactPersonsTelephoneNumber []XTN `hl7:"31,len=250,display=Contact Person's Telephone Number"`
ContactPersonsAddress []XAD `hl7:"32,len=250,display=Contact Person's Address"`
NextOfKinAssociatedPartysIdentifiers []CX `hl7:"33,len=250,display=Next of Kin/Associated Party's Identifiers"`
JobStatus IS `hl7:"34,len=2,table=0311,display=Job Status"`
Race []CWE `hl7:"35,len=705,table=0005,display=Race"`
Handicap IS `hl7:"36,len=2,table=0295,display=Handicap"`
ContactPersonSocialSecurityNumber ST `hl7:"37,len=16,display=Contact Person Social Security Number"`
NextOfKinBirthPlace ST `hl7:"38,len=250,display=Next of Kin Birth Place"`
VIPIndicator IS `hl7:"39,len=2,table=0099,display=VIP Indicator"`
}
Next of Kin / Associated Parties
The NK1 segment contains information about the patient's other related parties. Any associated parties may be identified. Utilizing NK1-1 - set ID, multiple NK1 segments can be sent to patient accounts.
type NM ¶
type NM = string
Numeric
A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an optional decimal point. In the absence of a sign, the number is assumed to be positive. If there is no decimal point the number is assumed to be an integer.
type NMD_N02 ¶
type NMD_N02 struct {
HL7 HL7Name `hl7:",name=NMD_N02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
ClockAndStatsWithNotes []NMD_N02_ClockAndStatsWithNotes `hl7:",required,display=Clock And Stats With Notes"`
}
Application Management Data
The N02 event signifies when an unsolicited update (UU) Application Management Data message (NMD) is created by on application to transmit application management information to other applications. In this case, the initiating application sends an NMD message as an unsolicited update (UU) containing application management information to a receiving application, which responds with a generic acknowledgement message (ACK).
type NMD_N02_AppStats ¶
type NMD_N02_AppStats struct {
HL7 HL7Name `hl7:",name=NMD_N02_AppStats,type=tg"`
NST *NST `hl7:"6,required,display=Application control level statistics"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
}
AppStats
type NMD_N02_AppStatus ¶
type NMD_N02_AppStatus struct {
HL7 HL7Name `hl7:",name=NMD_N02_AppStatus,type=tg"`
NSC *NSC `hl7:"8,required,display=Application Status Change"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
AppStatus
type NMD_N02_Clock ¶
type NMD_N02_Clock struct {
HL7 HL7Name `hl7:",name=NMD_N02_Clock,type=tg"`
NCK *NCK `hl7:"4,required,display=System Clock"`
NTE []NTE `hl7:"5,display=Notes and Comments"`
}
Clock
type NMD_N02_ClockAndStatsWithNotes ¶
type NMD_N02_ClockAndStatsWithNotes struct {
HL7 HL7Name `hl7:",name=NMD_N02_ClockAndStatsWithNotes,type=tg"`
Clock *NMD_N02_Clock `hl7:",display=Clock"`
AppStats *NMD_N02_AppStats `hl7:",display=App Stats"`
AppStatus *NMD_N02_AppStatus `hl7:",display=App Status"`
}
ClockAndStatsWithNotes
type NMQ_N01 ¶
type NMQ_N01 struct {
HL7 HL7Name `hl7:",name=NMQ_N01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QryWithDetail *NMQ_N01_QryWithDetail `hl7:",display=Qry With Detail"`
ClockAndStatistics []NMQ_N01_ClockAndStatistics `hl7:",required,display=Clock And Statistics"`
}
Application Management Query
Note: The MFQ/MFR transaction is retained for backward compatibility as of v2.5.
The N01 event signifies when the NMQ (Application Management Query) message is used by one application to make application control-level requests for information or action to another application. It has three segments, the NCK segment (system clock), the NST segment (application control-level statistics), and the NSC segment (application control-level status change). At least one of these three segments must be present in the NMQ message. If a segment is present in the NMQ message, the corresponding segment needs to be present in the NMR message to return the requested data or status.
type NMQ_N01_ClockAndStatistics ¶
type NMQ_N01_ClockAndStatistics struct {
HL7 HL7Name `hl7:",name=NMQ_N01_ClockAndStatistics,type=tg"`
NCK *NCK `hl7:"6,display=System Clock"`
NST *NST `hl7:"7,display=Application control level statistics"`
NSC *NSC `hl7:"8,display=Application Status Change"`
}
ClockAndStatistics
type NMQ_N01_QryWithDetail ¶
type NMQ_N01_QryWithDetail struct {
HL7 HL7Name `hl7:",name=NMQ_N01_QryWithDetail,type=tg"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
QryWithDetail
type NMR_N01 ¶
type NMR_N01 struct {
HL7 HL7Name `hl7:",name=NMR_N01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QRD *QRD `hl7:"6,display=Original-Style Query Definition"`
ClockAndStatsWithNotesAlt []NMR_N01_ClockAndStatsWithNotesAlt `hl7:",required,display=Clock And Stats With Notes Alt"`
}
Application Management Response
Note: The MFQ/MFR transaction is retained for backward compatibility as of v2.5.
The N01 event signifies when the NMQ (Application Management Query) message is used by one application to make application control-level requests for information or action to another application. It has three segments, the NCK segment (system clock), the NST segment (application control-level statistics), and the NSC segment (application control-level status change). At least one of these three segments must be present in the NMQ message. If a segment is present in the NMQ message, the corresponding segment needs to be present in the NMR message to return the requested data or status.
type NMR_N01_ClockAndStatsWithNotesAlt ¶
type NMR_N01_ClockAndStatsWithNotesAlt struct {
HL7 HL7Name `hl7:",name=NMR_N01_ClockAndStatsWithNotesAlt,type=tg"`
NCK *NCK `hl7:"7,display=System Clock"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
NST *NST `hl7:"9,display=Application control level statistics"`
NTE2 []NTE `hl7:"10,display=Notes and Comments"`
NSC *NSC `hl7:"11,display=Application Status Change"`
NTE3 []NTE `hl7:"12,display=Notes and Comments"`
}
ClockAndStatsWithNotesAlt
type NPU ¶
type NPU struct {
HL7 HL7Name `hl7:",name=NPU,type=s"`
BedLocation PL `hl7:"1,required,len=80,display=Bed Location"`
BedStatus IS `hl7:"2,len=1,table=0116,display=Bed Status"`
}
Bed Status Update
The NPU segment allows the updating of census (bed status) data without sending patient-specific data. An example might include changing the status of a bed from "housekeeping" to "unoccupied."
type NR ¶
type NR struct {
HL7 HL7Name `hl7:",name=NR,len=33,type=d"`
LowValue NM `hl7:"1,len=16,display=The number specifying the lower limit or boundary of the range."`
HighValue NM `hl7:"2,len=16,display=The number specifying the high limit or boundary of the range."`
}
Numeric Range
Specifies the interval between the lowest and the highest values in a series of data. In the case where a numeric range is unbounded on one side, the component of the unbounded side is null. Whether the end points are included in the range is defined in the usage note for the field.
type NSC ¶
type NSC struct {
HL7 HL7Name `hl7:",name=NSC,type=s"`
ApplicationChangeType IS `hl7:"1,required,len=4,table=0409,display=Application Change Type"`
CurrentCPU ST `hl7:"2,len=30,display=Current CPU"`
CurrentFileserver ST `hl7:"3,len=30,display=Current Fileserver"`
CurrentApplication *HD `hl7:"4,len=30,display=Current Application"`
CurrentFacility *HD `hl7:"5,len=30,display=Current Facility"`
NewCPU ST `hl7:"6,len=30,display=New CPU"`
NewFileserver ST `hl7:"7,len=30,display=New Fileserver"`
NewApplication *HD `hl7:"8,len=30,display=New Application"`
NewFacility *HD `hl7:"9,len=30,display=New Facility"`
}
Application Status Change
The NSC segment is used to inform (NMR query response) or announce (NMD unsolicited update) the start-up, shut-down, and/or migration (to a different CPU or file-server/file-system) of a particular application.
type NST ¶
type NST struct {
HL7 HL7Name `hl7:",name=NST,type=s"`
StatisticsAvailable ID `hl7:"1,required,len=1,table=0136,display=Statistics Available"`
SourceIdentifier ST `hl7:"2,len=30,display=Source Identifier"`
SourceType ID `hl7:"3,len=3,table=0332,display=Source Type"`
StatisticsStart DTM `hl7:"4,conditional,len=24,format=YMDHM,display=Statistics Start"`
StatisticsEnd DTM `hl7:"5,conditional,len=24,format=YMDHM,display=Statistics End"`
ReceiveCharacterCount NM `hl7:"6,len=10,display=Receive Character Count"`
SendCharacterCount NM `hl7:"7,len=10,display=Send Character Count"`
MessagesReceived NM `hl7:"8,len=10,display=Messages Received"`
MessagesSent NM `hl7:"9,len=10,display=Messages Sent"`
ChecksumErrorsReceived NM `hl7:"10,len=10,display=Checksum Errors Received"`
LengthErrorsReceived NM `hl7:"11,len=10,display=Length Errors Received"`
OtherErrorsReceived NM `hl7:"12,len=10,display=Other Errors Received"`
ConnectTimeouts NM `hl7:"13,len=10,display=Connect Timeouts"`
ReceiveTimeouts NM `hl7:"14,len=10,display=Receive Timeouts"`
ApplicationControlLevelErrors NM `hl7:"15,len=10,display=Application control-level Errors"`
}
Application control level statistics
The NST segment allows application control-level statistical information to be passed between the various systems on the network. Some fields in this segment refer to portions of lower level protocols; they contain information that can be used by application management applications monitoring the state of various network links.
type NTE ¶
type NTE struct {
HL7 HL7Name `hl7:",name=NTE,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - NTE"`
SourceOfComment ID `hl7:"2,len=8,table=0105,display=Source of Comment"`
Comment []FT `hl7:"3,len=65536,display=Comment"`
CommentType *CWE `hl7:"4,len=250,table=0364,display=Comment Type"`
EnteredBy *XCN `hl7:"5,len=3220,display=Entered By"`
EnteredDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Entered Date/Time"`
EffectiveStartDate DTM `hl7:"7,len=24,format=YMDHM,display=Effective Start Date"`
ExpirationDate DTM `hl7:"8,len=24,format=YMDHM,display=Expiration Date"`
}
Notes and Comments
The NTE segment is defined here for inclusion in messages defined in other chapters. It is commonly used for sending notes and comments.
type OBR ¶
type OBR struct {
HL7 HL7Name `hl7:",name=OBR,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - OBR"`
PlacerOrderNumber *EI `hl7:"2,conditional,len=427,display=Placer Order Number"`
FillerOrderNumber *EI `hl7:"3,conditional,len=427,display=Filler Order Number"`
UniversalServiceIdentifier CWE `hl7:"4,required,len=705,display=Universal Service Identifier"`
Priority ID `hl7:"5,len=2,display=Priority"`
RequestedDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Requested Date/Time"`
ObservationDateTime DTM `hl7:"7,conditional,len=24,format=YMDHM,display=Observation Date/Time"`
ObservationEndDateTime DTM `hl7:"8,len=24,format=YMDHM,display=Observation End Date/Time"`
CollectionVolume *CQ `hl7:"9,len=722,display=Collection Volume"`
CollectorIdentifier []XCN `hl7:"10,len=3220,display=Collector Identifier"`
SpecimenActionCode ID `hl7:"11,len=1,table=0065,display=Specimen Action Code"`
DangerCode *CWE `hl7:"12,len=705,display=Danger Code"`
RelevantClinicalInformation ST `hl7:"13,len=300,display=Relevant Clinical Information"`
SpecimenReceivedDateTime DTM `hl7:"14,len=24,format=YMDHM,display=Specimen Received Date/Time"`
SpecimenSource SPS `hl7:"15,len=300,display=Specimen Source"`
OrderingProvider []XCN `hl7:"16,len=3220,display=Ordering Provider"`
OrderCallbackPhoneNumber []XTN `hl7:"17,max=2,len=2743,display=Order Callback Phone Number"`
PlacerField1 ST `hl7:"18,len=199,display=Placer Field 1"`
PlacerField2 ST `hl7:"19,len=199,display=Placer Field 2"`
FillerField1 ST `hl7:"20,len=199,display=Filler Field 1"`
FillerField2 ST `hl7:"21,len=199,display=Filler Field 2"`
ResultsRptStatusChngDateTime DTM `hl7:"22,conditional,len=24,format=YMDHM,display=Results Rpt/Status Chng - Date/Time"`
ChargeToPractice *MOC `hl7:"23,len=504,display=Charge to Practice"`
DiagnosticServSectID ID `hl7:"24,len=10,table=0074,display=Diagnostic Serv Sect ID"`
ResultStatus ID `hl7:"25,conditional,len=1,table=0123,display=Result Status"`
ParentResult *PRL `hl7:"26,len=977,display=Parent Result"`
QuantityTiming []TQ `hl7:"27,len=705,display=Quantity/Timing"`
ResultCopiesTo []XCN `hl7:"28,len=3220,display=Result Copies To"`
Parent *EIP `hl7:"29,len=855,display=Parent"`
TransportationMode ID `hl7:"30,len=20,table=0124,display=Transportation Mode"`
ReasonForStudy []CWE `hl7:"31,len=705,display=Reason for Study"`
PrincipalResultInterpreter NDL `hl7:"32,len=831,display=Principal Result Interpreter"`
AssistantResultInterpreter []NDL `hl7:"33,len=831,display=Assistant Result Interpreter"`
Technician []NDL `hl7:"34,len=831,display=Technician"`
Transcriptionist []NDL `hl7:"35,len=831,display=Transcriptionist"`
ScheduledDateTime DTM `hl7:"36,len=24,format=YMDHM,display=Scheduled Date/Time"`
NumberOfSampleContainers NM `hl7:"37,len=16,display=Number of Sample Containers"`
TransportLogisticsOfCollectedSample []CWE `hl7:"38,len=705,display=Transport Logistics of Collected Sample"`
CollectorsComment []CWE `hl7:"39,len=705,display=Collector's Comment"`
TransportArrangementResponsibility *CWE `hl7:"40,len=705,display=Transport Arrangement Responsibility"`
TransportArranged ID `hl7:"41,len=30,table=0224,display=Transport Arranged"`
EscortRequired ID `hl7:"42,len=1,table=0225,display=Escort Required"`
PlannedPatientTransportComment []CWE `hl7:"43,len=705,display=Planned Patient Transport Comment"`
ProcedureCode *CNE `hl7:"44,len=705,table=0088,display=Procedure Code"`
ProcedureCodeModifier []CNE `hl7:"45,len=705,table=0340,display=Procedure Code Modifier"`
PlacerSupplementalServiceInformation []CWE `hl7:"46,len=705,table=0441,display=Placer Supplemental Service Information"`
FillerSupplementalServiceInformation []CWE `hl7:"47,len=705,table=0441,display=Filler Supplemental Service Information"`
MedicallyNecessaryDuplicateProcedureReason *CWE `hl7:"48,conditional,len=705,table=0476,display=Medically Necessary Duplicate Procedure Reason"`
ResultHandling IS `hl7:"49,len=2,table=0507,display=Result Handling"`
ParentUniversalServiceIdentifier *CWE `hl7:"50,len=705,display=Parent Universal Service Identifier"`
}
Observation Request
General (taken from ASTM E1238)
The Observation Request (OBR) segment is used to transmit information specific to an order for a diagnostic study or observation, physical exam, or assessment.
type OBX ¶
type OBX struct {
HL7 HL7Name `hl7:",name=OBX,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID – OBX"`
ValueType ID `hl7:"2,conditional,len=3,table=0125,display=Value Type"`
ObservationIdentifier CWE `hl7:"3,required,len=705,display=Observation Identifier"`
ObservationSubID ST `hl7:"4,conditional,len=20,display=Observation Sub-ID"`
ObservationValue []VARIES `hl7:"5,conditional,len=99999,display=Observation Value"`
Units *CWE `hl7:"6,len=705,display=Units"`
ReferencesRange ST `hl7:"7,len=60,display=References Range"`
AbnormalFlags []IS `hl7:"8,len=5,table=0078,display=Abnormal Flags"`
Probability NM `hl7:"9,len=5,display=Probability"`
NatureOfAbnormalTest []ID `hl7:"10,len=2,table=0080,display=Nature of Abnormal Test"`
ObservationResultStatus ID `hl7:"11,required,len=1,table=0085,display=Observation Result Status"`
EffectiveDateOfReferenceRange DTM `hl7:"12,len=24,format=YMDHM,display=Effective Date of Reference Range"`
UserDefinedAccessChecks ST `hl7:"13,len=20,display=User Defined Access Checks"`
DateTimeOfTheObservation DTM `hl7:"14,len=24,format=YMDHM,display=Date/Time of the Observation"`
ProducersID *CWE `hl7:"15,len=705,display=Producer's ID"`
ResponsibleObserver []XCN `hl7:"16,len=3220,display=Responsible Observer"`
ObservationMethod []CWE `hl7:"17,len=705,display=Observation Method"`
EquipmentInstanceIdentifier []EI `hl7:"18,len=427,display=Equipment Instance Identifier"`
DateTimeOfTheAnalysis DTM `hl7:"19,len=24,format=YMDHM,display=Date/Time of the Analysis"`
ObservationSite []CWE `hl7:"20,len=705,table=0163,display=Observation Site"`
ObservationInstanceIdentifier *EI `hl7:"21,len=427,display=Observation Instance Identifier"`
MoodCode *CNE `hl7:"22,conditional,len=705,table=0725,display=Mood Code"`
PerformingOrganizationName *XON `hl7:"23,len=570,display=Performing Organization Name"`
PerformingOrganizationAddress *XAD `hl7:"24,len=2915,display=Performing Organization Address"`
PerformingOrganizationMedicalDirector *XCN `hl7:"25,len=3220,display=Performing Organization Medical Director"`
}
Observation/Result
The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a report. The OBX segment can also contain encapsulated data, e.g., a CDA document or a DICOM image.
type OCD ¶
type OCD struct {
HL7 HL7Name `hl7:",name=OCD,len=714,type=d"`
OccurrenceCode CNE `` /* 138-byte string literal not displayed */
OccurrenceDate DT `hl7:"2,required,len=8,format=YMD,display=The date the event- relating to a bill that may affect payer processing- occurred."`
}
Occurrence Code and Date
The code and associated date defining a significant event relating to a bill that may affect payer processing.
type ODS ¶
type ODS struct {
HL7 HL7Name `hl7:",name=ODS,type=s"`
Type ID `hl7:"1,required,len=1,table=0159,display=Type"`
ServicePeriod []CWE `hl7:"2,max=10,len=250,display=Service Period"`
DietSupplementOrPreferenceCode []CWE `hl7:"3,required,max=20,len=250,display=Diet- Supplement- or Preference Code"`
TextInstruction []ST `hl7:"4,max=2,len=80,display=Text Instruction"`
}
Dietary Orders, Supplements, and Preferences
The ORC sequence items of interest to ODS are ORC-1-order control, ORC-2-placer order number, ORC-3-filler order number, ORC-7-quantity/timing, ORC-9-date/time of transaction, ORC-10-entered by, and ORC-11-verified by. For ORC-1-order control, the values may be New (NW), Cancel (CA), Discontinue Order Request (DC), Change (XO), Hold Order Request (HD), and Release Previous Hold (RL). The HD and RL codes could stop service for a specified length of time. ORC-7-quantity/timing should be used to specify whether an order is continuous or for one service period only. It is also useful for supplements which are part of a diet but only delivered, say, every day at night.
type ODT ¶
type ODT struct {
HL7 HL7Name `hl7:",name=ODT,type=s"`
TrayType CWE `hl7:"1,required,len=250,table=0160,display=Tray Type"`
ServicePeriod []CWE `hl7:"2,max=10,len=250,display=Service Period"`
TextInstruction ST `hl7:"3,len=80,display=Text Instruction"`
}
Diet Tray Instructions
This segment addresses tray instructions. These are independent of diet codes, supplements, and preferences and therefore get separate order numbers.
type OM1 ¶
type OM1 struct {
HL7 HL7Name `hl7:",name=OM1,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,required,len=4,display=Sequence Number - Test/Observation Master File"`
ProducersServiceTestObservationID CWE `hl7:"2,required,len=250,display=Producer's Service/Test/Observation ID"`
PermittedDataTypes []ID `hl7:"3,len=12,table=0125,display=Permitted Data Types"`
SpecimenRequired ID `hl7:"4,required,len=1,table=0136,display=Specimen Required"`
ProducerID CWE `hl7:"5,required,len=250,display=Producer ID"`
ObservationDescription TX `hl7:"6,len=200,display=Observation Description"`
OtherServiceTestObservationIDsForTheObservation *CWE `hl7:"7,len=250,display=Other Service/Test/Observation IDs for the Observation"`
OtherNames []ST `hl7:"8,required,len=200,display=Other Names"`
PreferredReportNameForTheObservation ST `hl7:"9,len=30,display=Preferred Report Name for the Observation"`
PreferredShortNameOrMnemonicForObservation ST `hl7:"10,len=8,display=Preferred Short Name or Mnemonic for Observation"`
PreferredLongNameForTheObservation ST `hl7:"11,len=200,display=Preferred Long Name for the Observation"`
Orderability ID `hl7:"12,len=1,table=0136,display=Orderability"`
IdentityOfInstrumentUsedToPerformThisStudy []CWE `hl7:"13,len=250,display=Identity of Instrument Used to Perform this Study"`
CodedRepresentationOfMethod []CWE `hl7:"14,len=250,display=Coded Representation of Method"`
PortableDeviceIndicator ID `hl7:"15,len=1,table=0136,display=Portable Device Indicator"`
ObservationProducingDepartmentSection []CWE `hl7:"16,len=250,display=Observation Producing Department/Section"`
TelephoneNumberOfSection *XTN `hl7:"17,len=250,display=Telephone Number of Section"`
NatureOfServiceTestObservation IS `hl7:"18,required,len=1,table=0174,display=Nature of Service/Test/Observation"`
ReportSubheader *CWE `hl7:"19,len=250,display=Report Subheader"`
ReportDisplayOrder ST `hl7:"20,len=20,display=Report Display Order"`
DateTimeStampForAnyChangeInDefinitionForTheObservation DTM `hl7:"21,len=24,format=YMDHM,display=Date/Time Stamp for any change in Definition for the Observation"`
EffectiveDateTimeOfChange DTM `hl7:"22,len=24,format=YMDHM,display=Effective Date/Time of Change"`
TypicalTurnAroundTime NM `hl7:"23,len=20,display=Typical Turn-Around Time"`
ProcessingTime NM `hl7:"24,len=20,display=Processing Time"`
ProcessingPriority []ID `hl7:"25,len=40,table=0168,display=Processing Priority"`
ReportingPriority ID `hl7:"26,len=5,table=0169,display=Reporting Priority"`
OutsideSiteSWhereObservationMayBePerformed []CWE `hl7:"27,len=250,display=Outside Site(s) Where Observation may be Performed"`
AddressOfOutsideSiteS []XAD `hl7:"28,len=250,display=Address of Outside Site(s)"`
PhoneNumberOfOutsideSite *XTN `hl7:"29,len=250,display=Phone Number of Outside Site"`
ConfidentialityCode *CWE `hl7:"30,len=250,table=0177,display=Confidentiality Code"`
ObservationsRequiredToInterpretTheObservation *CWE `hl7:"31,len=250,display=Observations Required to Interpret the Observation"`
InterpretationOfObservations TX `hl7:"32,len=65536,display=Interpretation of Observations"`
ContraindicationsToObservations *CWE `hl7:"33,len=250,display=Contraindications to Observations"`
ReflexTestsObservations []CWE `hl7:"34,len=250,display=Reflex Tests/Observations"`
RulesThatTriggerReflexTesting TX `hl7:"35,len=80,display=Rules that Trigger Reflex Testing"`
FixedCannedMessage *CWE `hl7:"36,len=250,display=Fixed Canned Message"`
PatientPreparation TX `hl7:"37,len=200,display=Patient Preparation"`
ProcedureMedication *CWE `hl7:"38,len=250,display=Procedure Medication"`
FactorsThatMayAffectTheObservation TX `hl7:"39,len=200,display=Factors that may Affect the Observation"`
ServiceTestObservationPerformanceSchedule []ST `hl7:"40,len=60,display=Service/Test/Observation Performance Schedule"`
DescriptionOfTestMethods TX `hl7:"41,len=65536,display=Description of Test Methods"`
KindOfQuantityObserved *CWE `hl7:"42,len=250,table=0254,display=Kind of Quantity Observed"`
PointVersusInterval *CWE `hl7:"43,len=250,table=0255,display=Point Versus Interval"`
ChallengeInformation TX `hl7:"44,len=200,display=Challenge Information"`
RelationshipModifier *CWE `hl7:"45,len=250,table=0258,display=Relationship Modifier"`
TargetAnatomicSiteOfTest *CWE `hl7:"46,len=250,display=Target Anatomic Site Of Test"`
ModalityOfImagingMeasurement *CWE `hl7:"47,len=250,table=0259,display=Modality Of Imaging Measurement"`
}
General Segment
The Technical Steward for the OM1 segment is Orders and Observations.
The OM1 segment contains the attributes that apply to the definition of most observations. This segment also contains the field attributes that specify what additional segments might also be defined for this observation.
type OM2 ¶
type OM2 struct {
HL7 HL7Name `hl7:",name=OM2,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,len=4,display=Sequence Number - Test/Observation Master File"`
UnitsOfMeasure *CWE `hl7:"2,len=250,display=Units of Measure"`
RangeOfDecimalPrecision []NM `hl7:"3,len=10,display=Range of Decimal Precision"`
CorrespondingSIUnitsOfMeasure *CWE `hl7:"4,len=250,display=Corresponding SI Units of Measure"`
SIConversionFactor TX `hl7:"5,len=60,display=SI Conversion Factor"`
ReferenceNormalRangeForOrdinalAndContinuousObservations []RFR `hl7:"6,len=250,display=Reference (Normal) Range for Ordinal and Continuous Observations"`
CriticalRangeForOrdinalAndContinuousObservations []RFR `hl7:"7,len=205,display=Critical Range for Ordinal and Continuous Observations"`
AbsoluteRangeForOrdinalAndContinuousObservations *RFR `hl7:"8,len=250,display=Absolute Range for Ordinal and Continuous Observations"`
DeltaCheckCriteria []DLT `hl7:"9,len=250,display=Delta Check Criteria"`
MinimumMeaningfulIncrements NM `hl7:"10,len=20,display=Minimum Meaningful Increments"`
}
Numeric Observation
The Technical Steward for the OM2 segment is Orders and Observations.
This segment contains the attributes of observations with continuous values (including those with data types of numeric, date, or time stamp). It can be applied to observation batteries of type A and C (see OM1-18 - Nature of Service/Test/Observation).
type OM3 ¶
type OM3 struct {
HL7 HL7Name `hl7:",name=OM3,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,len=4,display=Sequence Number - Test/Observation Master File"`
PreferredCodingSystem *CWE `hl7:"2,len=250,display=Preferred Coding System"`
ValidCodedAnswers []CWE `hl7:"3,len=250,display=Valid Coded 'Answers'"`
NormalTextCodesForCategoricalObservations []CWE `hl7:"4,len=250,display=Normal Text/Codes for Categorical Observations"`
AbnormalTextCodesForCategoricalObservations []CWE `hl7:"5,len=250,display=Abnormal Text/Codes for Categorical Observations"`
CriticalTextCodesForCategoricalObservations []CWE `hl7:"6,len=250,display=Critical Text/Codes for Categorical Observations"`
ValueType ID `hl7:"7,len=3,table=0125,display=Value Type"`
}
Categorical Service/Test/Observation
The Technical Steward for the OM3 segment is Orders and Observations.
This segment applies to free text and other non-numeric data types.
type OM4 ¶
type OM4 struct {
HL7 HL7Name `hl7:",name=OM4,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,len=4,display=Sequence Number - Test/Observation Master File"`
DerivedSpecimen ID `hl7:"2,len=1,table=0170,display=Derived Specimen"`
ContainerDescription TX `hl7:"3,len=60,display=Container Description"`
ContainerVolume NM `hl7:"4,len=20,display=Container Volume"`
ContainerUnits *CWE `hl7:"5,len=250,display=Container Units"`
Specimen *CWE `hl7:"6,len=250,display=Specimen"`
Additive *CWE `hl7:"7,len=705,table=0371,display=Additive"`
Preparation TX `hl7:"8,len=10240,display=Preparation"`
SpecialHandlingRequirements TX `hl7:"9,len=10240,display=Special Handling Requirements"`
NormalCollectionVolume *CQ `hl7:"10,len=20,display=Normal Collection Volume"`
MinimumCollectionVolume *CQ `hl7:"11,len=20,display=Minimum Collection Volume"`
SpecimenRequirements TX `hl7:"12,len=10240,display=Specimen Requirements"`
SpecimenPriorities []ID `hl7:"13,len=1,table=0027,display=Specimen Priorities"`
SpecimenRetentionTime *CQ `hl7:"14,len=20,display=Specimen Retention Time"`
}
Observations That Require Specimens
The Technical Steward for the OM4 segment is Orders and Observations.
This segment applies to observations/batteries that require a specimen for their performance. When an observation or battery requires multiple specimens for their performance (e.g., creatinine clearance requires a 24-hour urine specimen and a serum specimen), multiple segments may be included, one for each specimen type.
type OM5 ¶
type OM5 struct {
HL7 HL7Name `hl7:",name=OM5,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,len=4,display=Sequence Number - Test/Observation Master File"`
TestObservationsIncludedWithinAnOrderedTestBattery []CWE `hl7:"2,len=250,display=Test/Observations Included Within an Ordered Test Battery"`
ObservationIDSuffixes ST `hl7:"3,len=250,display=Observation ID Suffixes"`
}
Observation Batteries (Sets)
The Technical Steward for the OM5 segment is Orders and Observations.
This segment contains the information about batteries and supersets (a nature code of F, P or S, as described in OM1-18 - Nature of Service/Test/Observation).
type OM6 ¶
type OM6 struct {
HL7 HL7Name `hl7:",name=OM6,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,len=4,display=Sequence Number - Test/Observation Master File"`
DerivationRule TX `hl7:"2,len=10240,display=Derivation Rule"`
}
Observations that are Calculated from Other Observations
The Technical Steward for the OM6 segment is Orders and Observations.
This segment contains the information about quantities that are derived from one or more other quantities or direct observations by mathematical or logical means.
type OM7 ¶
type OM7 struct {
HL7 HL7Name `hl7:",name=OM7,type=s"`
SequenceNumberTestObservationMasterFile NM `hl7:"1,required,len=4,display=Sequence Number - Test/Observation Master File"`
UniversalServiceIdentifier CWE `hl7:"2,required,len=705,display=Universal Service Identifier"`
CategoryIdentifier []CWE `hl7:"3,len=250,table=0412,display=Category Identifier"`
CategoryDescription TX `hl7:"4,len=200,display=Category Description"`
CategorySynonym []ST `hl7:"5,len=200,display=Category Synonym"`
EffectiveTestServiceStartDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Effective Test/Service Start Date/Time"`
EffectiveTestServiceEndDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Effective Test/Service End Date/Time"`
TestServiceDefaultDurationQuantity NM `hl7:"8,len=5,display=Test/Service Default Duration Quantity"`
TestServiceDefaultDurationUnits *CWE `hl7:"9,len=250,display=Test/Service Default Duration Units"`
TestServiceDefaultFrequency IS `hl7:"10,len=60,display=Test/Service Default Frequency"`
ConsentIndicator ID `hl7:"11,len=1,table=0136,display=Consent Indicator"`
ConsentIdentifier *CWE `hl7:"12,len=250,table=0413,display=Consent Identifier"`
ConsentEffectiveStartDateTime DTM `hl7:"13,len=24,format=YMDHM,display=Consent Effective Start Date/Time"`
ConsentEffectiveEndDateTime DTM `hl7:"14,len=24,format=YMDHM,display=Consent Effective End Date/Time"`
ConsentIntervalQuantity NM `hl7:"15,len=5,display=Consent Interval Quantity"`
ConsentIntervalUnits *CWE `hl7:"16,conditional,len=250,table=0414,display=Consent Interval Units"`
ConsentWaitingPeriodQuantity NM `hl7:"17,len=5,display=Consent Waiting Period Quantity"`
ConsentWaitingPeriodUnits *CWE `hl7:"18,conditional,len=250,table=0414,display=Consent Waiting Period Units"`
EffectiveDateTimeOfChange DTM `hl7:"19,len=24,format=YMDHM,display=Effective Date/Time of Change"`
EnteredBy *XCN `hl7:"20,len=3220,display=Entered By"`
OrderableAtLocation []PL `hl7:"21,len=200,display=Orderable-at Location"`
FormularyStatus IS `hl7:"22,len=1,table=0473,display=Formulary Status"`
SpecialOrderIndicator ID `hl7:"23,len=1,table=0136,display=Special Order Indicator"`
PrimaryKeyValueCDM []CWE `hl7:"24,len=250,table=0132,display=Primary Key Value - CDM"`
}
Additional Basic Attributes
The Technical Steward for the OM7 segment is Orders and Observations.
The OM7 segment contains additional basic attributes that apply to the definition of most observations/services.
type OMB_O27 ¶
type OMB_O27 struct {
HL7 HL7Name `hl7:",name=OMB_O27,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMB_O27_Patient `hl7:",display=Patient"`
Order []OMB_O27_Order `hl7:",required,display=Order"`
}
Blood Product Order
Blood product order messages present the need for additional information that is not included in standard HL7 order messages. Order messages must contain accompanying details regarding the blood product component, such as special processing requirements (e.g., irradiation and leukoreduction), and the amount of the blood product to be administered. Additionally, specific relevant clinical information can be included to allow the prospective review of the appropriateness of the blood product order.
Blood product orders use the OMB message with the BPO segment for the detail segment and the acknowledgment message.
type OMB_O27_Insurance ¶
type OMB_O27_Insurance struct {
HL7 HL7Name `hl7:",name=OMB_O27_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMB_O27_Observation ¶
type OMB_O27_Observation struct {
HL7 HL7Name `hl7:",name=OMB_O27_Observation,type=tg"`
OBX *OBX `hl7:"22,required,display=Observation/Result"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
}
Observation
type OMB_O27_Order ¶
type OMB_O27_Order struct {
HL7 HL7Name `hl7:",name=OMB_O27_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []OMB_O27_Timing `hl7:",display=Timing"`
BPO *BPO `hl7:"18,required,display=Blood product order"`
SPM *SPM `hl7:"19,display=Specimen"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
DG1 []DG1 `hl7:"21,display=Diagnosis"`
Observation []OMB_O27_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"24,display=Financial Transaction"`
BLG *BLG `hl7:"25,display=Billing"`
}
Order
type OMB_O27_Patient ¶
type OMB_O27_Patient struct {
HL7 HL7Name `hl7:",name=OMB_O27_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMB_O27_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMB_O27_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMB_O27_PatientVisit ¶
type OMB_O27_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMB_O27_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMB_O27_Timing ¶
type OMB_O27_Timing struct {
HL7 HL7Name `hl7:",name=OMB_O27_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type OMD_O03 ¶
type OMD_O03 struct {
HL7 HL7Name `hl7:",name=OMD_O03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMD_O03_Patient `hl7:",display=Patient"`
OrderDiet []OMD_O03_OrderDiet `hl7:",required,display=Order Diet"`
OrderTray []OMD_O03_OrderTray `hl7:",display=Order Tray"`
}
Dietary Order
A diet office needs to receive specific information, the most important being the diet order itself. Diet restrictions (often called diet codes) are the basic building blocks of a diet order. The diet order segments may be sent as part of the ORM and ORR message structure to support backwards compatibility, or may be sent as part of the OMD and ORD messages.
type OMD_O03_Diet ¶
type OMD_O03_Diet struct {
HL7 HL7Name `hl7:",name=OMD_O03_Diet,type=tg"`
ODS []ODS `hl7:"18,required,display=Dietary Orders- Supplements- and Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
Observation []OMD_O03_Observation `hl7:",display=Observation"`
}
Diet
type OMD_O03_Insurance ¶
type OMD_O03_Insurance struct {
HL7 HL7Name `hl7:",name=OMD_O03_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMD_O03_Observation ¶
type OMD_O03_Observation struct {
HL7 HL7Name `hl7:",name=OMD_O03_Observation,type=tg"`
OBX *OBX `hl7:"20,required,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
Observation
type OMD_O03_OrderDiet ¶
type OMD_O03_OrderDiet struct {
HL7 HL7Name `hl7:",name=OMD_O03_OrderDiet,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
TimingDiet []OMD_O03_TimingDiet `hl7:",display=Timing Diet"`
Diet *OMD_O03_Diet `hl7:",display=Diet"`
}
OrderDiet
type OMD_O03_OrderTray ¶
type OMD_O03_OrderTray struct {
HL7 HL7Name `hl7:",name=OMD_O03_OrderTray,type=tg"`
ORC *ORC `hl7:"22,required,display=Common Order"`
TimingTray []OMD_O03_TimingTray `hl7:",display=Timing Tray"`
ODT []ODT `hl7:"25,required,display=Diet Tray Instructions"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
OrderTray
type OMD_O03_Patient ¶
type OMD_O03_Patient struct {
HL7 HL7Name `hl7:",name=OMD_O03_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMD_O03_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMD_O03_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMD_O03_PatientVisit ¶
type OMD_O03_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMD_O03_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMD_O03_TimingDiet ¶
type OMD_O03_TimingDiet struct {
HL7 HL7Name `hl7:",name=OMD_O03_TimingDiet,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
TimingDiet
type OMD_O03_TimingTray ¶
type OMD_O03_TimingTray struct {
HL7 HL7Name `hl7:",name=OMD_O03_TimingTray,type=tg"`
TQ1 *TQ1 `hl7:"23,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"24,display=Timing/Quantity Relationship"`
}
TimingTray
type OMG_O19 ¶
type OMG_O19 struct {
HL7 HL7Name `hl7:",name=OMG_O19,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMG_O19_Patient `hl7:",display=Patient"`
Order []OMG_O19_Order `hl7:",required,display=Order"`
}
General Clinical Order
The function of this message is to initiate the transmission of information about a general clinical order that uses the OBR segment. Messages using the ORM message with the OBR segment are supported for backward compatibility. This includes placing new orders, cancellation of existing orders, discontinuation, holding, etc. OMG messages can originate also with a placer, filler, or an interested third party.
type OMG_O19_Container ¶
type OMG_O19_Container struct {
HL7 HL7Name `hl7:",name=OMG_O19_Container,type=tg"`
SAC *SAC `hl7:"28,required,display=Specimen Container Detail"`
OBX []OBX `hl7:"29,display=Observation/Result"`
}
Container
type OMG_O19_Insurance ¶
type OMG_O19_Insurance struct {
HL7 HL7Name `hl7:",name=OMG_O19_Insurance,type=tg"`
IN1 *IN1 `hl7:"11,required,display=Insurance"`
IN2 *IN2 `hl7:"12,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"13,display=Insurance Additional Information- Certification"`
}
Insurance
type OMG_O19_Observation ¶
type OMG_O19_Observation struct {
HL7 HL7Name `hl7:",name=OMG_O19_Observation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Observation
type OMG_O19_ObservationPrior ¶
type OMG_O19_ObservationPrior struct {
HL7 HL7Name `hl7:",name=OMG_O19_ObservationPrior,type=tg"`
OBX *OBX `hl7:"42,required,display=Observation/Result"`
NTE []NTE `hl7:"43,display=Notes and Comments"`
}
ObservationPrior
type OMG_O19_Order ¶
type OMG_O19_Order struct {
HL7 HL7Name `hl7:",name=OMG_O19_Order,type=tg"`
ORC *ORC `hl7:"16,required,display=Common Order"`
Timing []OMG_O19_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"19,required,display=Observation Request"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
ROL []ROL `hl7:"21,display=Role"`
CTD *CTD `hl7:"22,display=Contact Data"`
DG1 []DG1 `hl7:"23,display=Diagnosis"`
Observation []OMG_O19_Observation `hl7:",display=Observation"`
Specimen []OMG_O19_Specimen `hl7:",display=Specimen"`
PriorResult []OMG_O19_PriorResult `hl7:",display=Prior Result"`
FT1 []FT1 `hl7:"44,display=Financial Transaction"`
CTI []CTI `hl7:"45,display=Clinical Trial Identification"`
BLG *BLG `hl7:"46,display=Billing"`
}
Order
type OMG_O19_OrderPrior ¶
type OMG_O19_OrderPrior struct {
HL7 HL7Name `hl7:",name=OMG_O19_OrderPrior,type=tg"`
ORC *ORC `hl7:"35,display=Common Order"`
OBR *OBR `hl7:"36,required,display=Observation Request"`
TimingPrior []OMG_O19_TimingPrior `hl7:",display=Timing Prior"`
NTE []NTE `hl7:"39,display=Notes and Comments"`
ROL []ROL `hl7:"40,display=Role"`
CTD *CTD `hl7:"41,display=Contact Data"`
ObservationPrior []OMG_O19_ObservationPrior `hl7:",required,display=Observation Prior"`
}
OrderPrior
type OMG_O19_Patient ¶
type OMG_O19_Patient struct {
HL7 HL7Name `hl7:",name=OMG_O19_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
PatientVisit *OMG_O19_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMG_O19_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"14,display=Guarantor"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
}
Patient
type OMG_O19_PatientPrior ¶
type OMG_O19_PatientPrior struct {
HL7 HL7Name `hl7:",name=OMG_O19_PatientPrior,type=tg"`
PID *PID `hl7:"30,required,display=Patient Identification"`
PD1 *PD1 `hl7:"31,display=Patient Additional Demographic"`
}
PatientPrior
type OMG_O19_PatientVisit ¶
type OMG_O19_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMG_O19_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMG_O19_PatientVisitPrior ¶
type OMG_O19_PatientVisitPrior struct {
HL7 HL7Name `hl7:",name=OMG_O19_PatientVisitPrior,type=tg"`
PV1 *PV1 `hl7:"32,required,display=Patient Visit"`
PV2 *PV2 `hl7:"33,display=Patient Visit - Additional Information"`
}
PatientVisitPrior
type OMG_O19_PriorResult ¶
type OMG_O19_PriorResult struct {
HL7 HL7Name `hl7:",name=OMG_O19_PriorResult,type=tg"`
PatientPrior *OMG_O19_PatientPrior `hl7:",display=Patient Prior"`
PatientVisitPrior *OMG_O19_PatientVisitPrior `hl7:",display=Patient Visit Prior"`
AL1 []AL1 `hl7:"34,display=Patient Allergy Information"`
OrderPrior []OMG_O19_OrderPrior `hl7:",required,display=Order Prior"`
}
PriorResult
type OMG_O19_Specimen ¶
type OMG_O19_Specimen struct {
HL7 HL7Name `hl7:",name=OMG_O19_Specimen,type=tg"`
SPM *SPM `hl7:"26,required,display=Specimen"`
OBX []OBX `hl7:"27,display=Observation/Result"`
Container []OMG_O19_Container `hl7:",display=Container"`
}
Specimen
type OMG_O19_Timing ¶
type OMG_O19_Timing struct {
HL7 HL7Name `hl7:",name=OMG_O19_Timing,type=tg"`
TQ1 *TQ1 `hl7:"17,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"18,display=Timing/Quantity Relationship"`
}
Timing
type OMG_O19_TimingPrior ¶
type OMG_O19_TimingPrior struct {
HL7 HL7Name `hl7:",name=OMG_O19_TimingPrior,type=tg"`
TQ1 *TQ1 `hl7:"37,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"38,display=Timing/Quantity Relationship"`
}
TimingPrior
type OMI_O23 ¶
type OMI_O23 struct {
HL7 HL7Name `hl7:",name=OMI_O23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMI_O23_Patient `hl7:",display=Patient"`
Order []OMI_O23_Order `hl7:",required,display=Order"`
}
Imaging Order
This message is used in communication between the information systems involved in the fulfillment of the request directed to the imaging department, such as a Radiology Information System (RIS) and a Picture Archiving and Communication System (PACS). For the purpose of the following discussion these systems will be identified as Imaging Department Information Systems (IDIS). Information contained in the Imaging Procedure Control (IPC) segment allows multiple IDIS to share the context of Imaging Studies (collections of images acquired, processed, stored, and interpreted) in Image Management tasks.
type OMI_O23_Insurance ¶
type OMI_O23_Insurance struct {
HL7 HL7Name `hl7:",name=OMI_O23_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMI_O23_Observation ¶
type OMI_O23_Observation struct {
HL7 HL7Name `hl7:",name=OMI_O23_Observation,type=tg"`
OBX *OBX `hl7:"23,required,display=Observation/Result"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Observation
type OMI_O23_Order ¶
type OMI_O23_Order struct {
HL7 HL7Name `hl7:",name=OMI_O23_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []OMI_O23_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
ROL []ROL `hl7:"20,display=Role"`
CTD *CTD `hl7:"21,display=Contact Data"`
DG1 []DG1 `hl7:"22,display=Diagnosis"`
Observation []OMI_O23_Observation `hl7:",display=Observation"`
IPC []IPC `hl7:"25,required,display=Imaging Procedure Control Segment"`
}
Order
type OMI_O23_Patient ¶
type OMI_O23_Patient struct {
HL7 HL7Name `hl7:",name=OMI_O23_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMI_O23_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMI_O23_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMI_O23_PatientVisit ¶
type OMI_O23_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMI_O23_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMI_O23_Timing ¶
type OMI_O23_Timing struct {
HL7 HL7Name `hl7:",name=OMI_O23_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type OML_O21 ¶
type OML_O21 struct {
HL7 HL7Name `hl7:",name=OML_O21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OML_O21_Patient `hl7:",display=Patient"`
Order []OML_O21_Order `hl7:",required,display=Order"`
}
Laboratory Order
The following message structure may be used for the communication of laboratory and other order messages and must be used for lab automation messages where it is required that the Specimen/Container information is within the ORC/OBR segment group. While the ORM message with the OBR segment can be used for backwards compatibility for general lab messages, only the OML message should be used to take advantage of the specimen and container extensions required in laboratory automation.
The trigger event for this message is any change to a laboratory order. Such changes include submission of new orders, cancellations, updates, etc. OML messages can originate also with a placer, filler, or an interested third party.
In relationship to triggers O21, O33, and O35, this message/trigger (O21) should be used where an order with multiple samples and optionally multiple containers per order item are to be communicated.
type OML_O21_Container ¶
type OML_O21_Container struct {
HL7 HL7Name `hl7:",name=OML_O21_Container,type=tg"`
SAC *SAC `hl7:"30,required,display=Specimen Container Detail"`
OBX []OBX `hl7:"31,display=Observation/Result"`
}
Container
type OML_O21_Insurance ¶
type OML_O21_Insurance struct {
HL7 HL7Name `hl7:",name=OML_O21_Insurance,type=tg"`
IN1 *IN1 `hl7:"11,required,display=Insurance"`
IN2 *IN2 `hl7:"12,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"13,display=Insurance Additional Information- Certification"`
}
Insurance
type OML_O21_Observation ¶
type OML_O21_Observation struct {
HL7 HL7Name `hl7:",name=OML_O21_Observation,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
TCD *TCD `hl7:"26,display=Test Code Detail"`
NTE []NTE `hl7:"27,display=Notes and Comments"`
}
Observation
type OML_O21_ObservationPrior ¶
type OML_O21_ObservationPrior struct {
HL7 HL7Name `hl7:",name=OML_O21_ObservationPrior,type=tg"`
OBX *OBX `hl7:"43,required,display=Observation/Result"`
NTE []NTE `hl7:"44,display=Notes and Comments"`
}
ObservationPrior
type OML_O21_ObservationRequest ¶
type OML_O21_ObservationRequest struct {
HL7 HL7Name `hl7:",name=OML_O21_ObservationRequest,type=tg"`
OBR *OBR `hl7:"19,required,display=Observation Request"`
TCD *TCD `hl7:"20,display=Test Code Detail"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
ROL []ROL `hl7:"22,display=Role"`
CTD *CTD `hl7:"23,display=Contact Data"`
DG1 []DG1 `hl7:"24,display=Diagnosis"`
Observation []OML_O21_Observation `hl7:",display=Observation"`
Specimen []OML_O21_Specimen `hl7:",display=Specimen"`
PriorResult []OML_O21_PriorResult `hl7:",display=Prior Result"`
}
ObservationRequest
type OML_O21_Order ¶
type OML_O21_Order struct {
HL7 HL7Name `hl7:",name=OML_O21_Order,type=tg"`
ORC *ORC `hl7:"16,required,display=Common Order"`
Timing []OML_O21_Timing `hl7:",display=Timing"`
ObservationRequest *OML_O21_ObservationRequest `hl7:",display=Observation Request"`
FT1 []FT1 `hl7:"45,display=Financial Transaction"`
CTI []CTI `hl7:"46,display=Clinical Trial Identification"`
BLG *BLG `hl7:"47,display=Billing"`
}
Order
type OML_O21_OrderPrior ¶
type OML_O21_OrderPrior struct {
HL7 HL7Name `hl7:",name=OML_O21_OrderPrior,type=tg"`
ORC *ORC `hl7:"37,display=Common Order"`
OBR *OBR `hl7:"38,required,display=Observation Request"`
NTE []NTE `hl7:"39,display=Notes and Comments"`
ROL []ROL `hl7:"40,display=Role"`
TimingPrior []OML_O21_TimingPrior `hl7:",display=Timing Prior"`
ObservationPrior []OML_O21_ObservationPrior `hl7:",required,display=Observation Prior"`
}
OrderPrior
type OML_O21_Patient ¶
type OML_O21_Patient struct {
HL7 HL7Name `hl7:",name=OML_O21_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
PatientVisit *OML_O21_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OML_O21_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"14,display=Guarantor"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
}
Patient
type OML_O21_PatientPrior ¶
type OML_O21_PatientPrior struct {
HL7 HL7Name `hl7:",name=OML_O21_PatientPrior,type=tg"`
PID *PID `hl7:"32,required,display=Patient Identification"`
PD1 *PD1 `hl7:"33,display=Patient Additional Demographic"`
}
PatientPrior
type OML_O21_PatientVisit ¶
type OML_O21_PatientVisit struct {
HL7 HL7Name `hl7:",name=OML_O21_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type OML_O21_PatientVisitPrior ¶
type OML_O21_PatientVisitPrior struct {
HL7 HL7Name `hl7:",name=OML_O21_PatientVisitPrior,type=tg"`
PV1 *PV1 `hl7:"34,required,display=Patient Visit"`
PV2 *PV2 `hl7:"35,display=Patient Visit - Additional Information"`
}
PatientVisitPrior
type OML_O21_PriorResult ¶
type OML_O21_PriorResult struct {
HL7 HL7Name `hl7:",name=OML_O21_PriorResult,type=tg"`
PatientPrior *OML_O21_PatientPrior `hl7:",display=Patient Prior"`
PatientVisitPrior *OML_O21_PatientVisitPrior `hl7:",display=Patient Visit Prior"`
AL1 []AL1 `hl7:"36,display=Patient Allergy Information"`
OrderPrior []OML_O21_OrderPrior `hl7:",required,display=Order Prior"`
}
PriorResult
type OML_O21_Specimen ¶
type OML_O21_Specimen struct {
HL7 HL7Name `hl7:",name=OML_O21_Specimen,type=tg"`
SPM *SPM `hl7:"28,required,display=Specimen"`
OBX []OBX `hl7:"29,display=Observation/Result"`
Container []OML_O21_Container `hl7:",display=Container"`
}
Specimen
type OML_O21_Timing ¶
type OML_O21_Timing struct {
HL7 HL7Name `hl7:",name=OML_O21_Timing,type=tg"`
TQ1 *TQ1 `hl7:"17,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"18,display=Timing/Quantity Relationship"`
}
Timing
type OML_O21_TimingPrior ¶
type OML_O21_TimingPrior struct {
HL7 HL7Name `hl7:",name=OML_O21_TimingPrior,type=tg"`
TQ1 *TQ1 `hl7:"41,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"42,display=Timing/Quantity Relationship"`
}
TimingPrior
type OML_O33 ¶
type OML_O33 struct {
HL7 HL7Name `hl7:",name=OML_O33,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OML_O33_Patient `hl7:",display=Patient"`
Specimen []OML_O33_Specimen `hl7:",required,display=Specimen"`
}
Laboratory Order for Multiple Orders Related to a Single Specimen
The trigger event for this message is any change to a laboratory order. Such changes include submission of new orders, cancellations, updates, etc., where multiple orders are associated with a single sample which may be carried in multiple containers. OML messages can originate also with a placer, filler, or an interested third party.
This allows for a Specimen-centric message with multiple orders per specimen grouped by the specimen.
The following message structure may be used for the communication of laboratory and other order messages and must be used for lab automation messages where the message requires Specimen/container information to group a number of orders. While the ORM message with the OBR segment can be used for backwards compatibility for general lab messages, only the OML message should be used to take advantage of the specimen and container extensions required in laboratory automation.
In relationship to triggers O21, O33, and O35, this message/trigger (O33) should be used where a specimen, with optional multiple containers, may have multiple orders to be communicated.
type OML_O33_Insurance ¶
type OML_O33_Insurance struct {
HL7 HL7Name `hl7:",name=OML_O33_Insurance,type=tg"`
IN1 *IN1 `hl7:"11,required,display=Insurance"`
IN2 *IN2 `hl7:"12,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"13,display=Insurance Additional Information- Certification"`
}
Insurance
type OML_O33_Observation ¶
type OML_O33_Observation struct {
HL7 HL7Name `hl7:",name=OML_O33_Observation,type=tg"`
OBX *OBX `hl7:"27,required,display=Observation/Result"`
TCD *TCD `hl7:"28,display=Test Code Detail"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Observation
type OML_O33_ObservationPrior ¶
type OML_O33_ObservationPrior struct {
HL7 HL7Name `hl7:",name=OML_O33_ObservationPrior,type=tg"`
OBX *OBX `hl7:"41,required,display=Observation/Result"`
NTE []NTE `hl7:"42,display=Notes and Comments"`
}
ObservationPrior
type OML_O33_ObservationRequest ¶
type OML_O33_ObservationRequest struct {
HL7 HL7Name `hl7:",name=OML_O33_ObservationRequest,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
TCD *TCD `hl7:"23,display=Test Code Detail"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
ROL []ROL `hl7:"25,display=Role"`
DG1 []DG1 `hl7:"26,display=Diagnosis"`
Observation []OML_O33_Observation `hl7:",display=Observation"`
PriorResult []OML_O33_PriorResult `hl7:",display=Prior Result"`
}
ObservationRequest
type OML_O33_Order ¶
type OML_O33_Order struct {
HL7 HL7Name `hl7:",name=OML_O33_Order,type=tg"`
ORC *ORC `hl7:"19,required,display=Common Order"`
Timing []OML_O33_Timing `hl7:",display=Timing"`
ObservationRequest *OML_O33_ObservationRequest `hl7:",display=Observation Request"`
FT1 []FT1 `hl7:"43,display=Financial Transaction"`
CTI []CTI `hl7:"44,display=Clinical Trial Identification"`
BLG *BLG `hl7:"45,display=Billing"`
}
Order
type OML_O33_OrderPrior ¶
type OML_O33_OrderPrior struct {
HL7 HL7Name `hl7:",name=OML_O33_OrderPrior,type=tg"`
ORC *ORC `hl7:"35,display=Common Order"`
OBR *OBR `hl7:"36,required,display=Observation Request"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
ROL []ROL `hl7:"38,display=Role"`
TimingPrior []OML_O33_TimingPrior `hl7:",display=Timing Prior"`
ObservationPrior []OML_O33_ObservationPrior `hl7:",required,display=Observation Prior"`
}
OrderPrior
type OML_O33_Patient ¶
type OML_O33_Patient struct {
HL7 HL7Name `hl7:",name=OML_O33_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
PatientVisit *OML_O33_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OML_O33_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"14,display=Guarantor"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
}
Patient
type OML_O33_PatientPrior ¶
type OML_O33_PatientPrior struct {
HL7 HL7Name `hl7:",name=OML_O33_PatientPrior,type=tg"`
PID *PID `hl7:"30,required,display=Patient Identification"`
PD1 *PD1 `hl7:"31,display=Patient Additional Demographic"`
}
PatientPrior
type OML_O33_PatientVisit ¶
type OML_O33_PatientVisit struct {
HL7 HL7Name `hl7:",name=OML_O33_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type OML_O33_PatientVisitPrior ¶
type OML_O33_PatientVisitPrior struct {
HL7 HL7Name `hl7:",name=OML_O33_PatientVisitPrior,type=tg"`
PV1 *PV1 `hl7:"32,required,display=Patient Visit"`
PV2 *PV2 `hl7:"33,display=Patient Visit - Additional Information"`
}
PatientVisitPrior
type OML_O33_PriorResult ¶
type OML_O33_PriorResult struct {
HL7 HL7Name `hl7:",name=OML_O33_PriorResult,type=tg"`
PatientPrior *OML_O33_PatientPrior `hl7:",display=Patient Prior"`
PatientVisitPrior *OML_O33_PatientVisitPrior `hl7:",display=Patient Visit Prior"`
AL1 []AL1 `hl7:"34,display=Patient Allergy Information"`
OrderPrior []OML_O33_OrderPrior `hl7:",required,display=Order Prior"`
}
PriorResult
type OML_O33_Specimen ¶
type OML_O33_Specimen struct {
HL7 HL7Name `hl7:",name=OML_O33_Specimen,type=tg"`
SPM *SPM `hl7:"16,required,display=Specimen"`
OBX []OBX `hl7:"17,display=Observation/Result"`
SAC []SAC `hl7:"18,display=Specimen Container Detail"`
Order []OML_O33_Order `hl7:",required,display=Order"`
}
Specimen
type OML_O33_Timing ¶
type OML_O33_Timing struct {
HL7 HL7Name `hl7:",name=OML_O33_Timing,type=tg"`
TQ1 *TQ1 `hl7:"20,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"21,display=Timing/Quantity Relationship"`
}
Timing
type OML_O33_TimingPrior ¶
type OML_O33_TimingPrior struct {
HL7 HL7Name `hl7:",name=OML_O33_TimingPrior,type=tg"`
TQ1 *TQ1 `hl7:"39,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"40,display=Timing/Quantity Relationship"`
}
TimingPrior
type OML_O35 ¶
type OML_O35 struct {
HL7 HL7Name `hl7:",name=OML_O35,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OML_O35_Patient `hl7:",display=Patient"`
Specimen []OML_O35_Specimen `hl7:",required,display=Specimen"`
}
Laboratory Order for Multiple Orders Related to a Single Container of a Specimen
The trigger event for this message is any change to a laboratory order. Such changes include submission of new orders, cancellations, updates, etc., where multiple orders are associated with a single sample which may be carried in multiple containers. OML messages can originate also with a placer, filler, or an interested third party.
This allows for a Specimen-centric message with multiple orders per specimen grouped by the specimen. The following message structure may be used for the communication of laboratory and other order messages and must be used for lab automation messages where the message requires Specimen/container information to group a number of orders. While the ORM message with the OBR segment can be used for backwards compatibility for general lab messages, only the OML message should be used to take advantage of the specimen and container extensions required in laboratory automation.
In relationship to triggers O21, O33, and O35, this message/trigger (O35) should be used for laboratory orders where there is 1 or more Specimens with 1 to many containers and each container may have 1 to many orders with previous result(s) per container.
type OML_O35_Insurance ¶
type OML_O35_Insurance struct {
HL7 HL7Name `hl7:",name=OML_O35_Insurance,type=tg"`
IN1 *IN1 `hl7:"11,required,display=Insurance"`
IN2 *IN2 `hl7:"12,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"13,display=Insurance Additional Information- Certification"`
}
Insurance
type OML_O35_Observation ¶
type OML_O35_Observation struct {
HL7 HL7Name `hl7:",name=OML_O35_Observation,type=tg"`
OBX *OBX `hl7:"27,required,display=Observation/Result"`
TCD *TCD `hl7:"28,display=Test Code Detail"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Observation
type OML_O35_ObservationPrior ¶
type OML_O35_ObservationPrior struct {
HL7 HL7Name `hl7:",name=OML_O35_ObservationPrior,type=tg"`
OBX *OBX `hl7:"41,required,display=Observation/Result"`
NTE []NTE `hl7:"42,display=Notes and Comments"`
}
ObservationPrior
type OML_O35_ObservationRequest ¶
type OML_O35_ObservationRequest struct {
HL7 HL7Name `hl7:",name=OML_O35_ObservationRequest,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
TCD *TCD `hl7:"23,display=Test Code Detail"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
ROL []ROL `hl7:"25,display=Role"`
DG1 []DG1 `hl7:"26,display=Diagnosis"`
Observation []OML_O35_Observation `hl7:",display=Observation"`
PriorResult []OML_O35_PriorResult `hl7:",display=Prior Result"`
}
ObservationRequest
type OML_O35_Order ¶
type OML_O35_Order struct {
HL7 HL7Name `hl7:",name=OML_O35_Order,type=tg"`
ORC *ORC `hl7:"19,required,display=Common Order"`
Timing []OML_O35_Timing `hl7:",display=Timing"`
ObservationRequest *OML_O35_ObservationRequest `hl7:",display=Observation Request"`
FT1 []FT1 `hl7:"43,display=Financial Transaction"`
CTI []CTI `hl7:"44,display=Clinical Trial Identification"`
BLG *BLG `hl7:"45,display=Billing"`
}
Order
type OML_O35_OrderPrior ¶
type OML_O35_OrderPrior struct {
HL7 HL7Name `hl7:",name=OML_O35_OrderPrior,type=tg"`
ORC *ORC `hl7:"35,display=Common Order"`
OBR *OBR `hl7:"36,required,display=Observation Request"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
ROL []ROL `hl7:"38,display=Role"`
TimingPrior *OML_O35_TimingPrior `hl7:",required,display=Timing Prior"`
ObservationPrior []OML_O35_ObservationPrior `hl7:",required,display=Observation Prior"`
}
OrderPrior
type OML_O35_Patient ¶
type OML_O35_Patient struct {
HL7 HL7Name `hl7:",name=OML_O35_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
PatientVisit *OML_O35_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OML_O35_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"14,display=Guarantor"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
}
Patient
type OML_O35_PatientPrior ¶
type OML_O35_PatientPrior struct {
HL7 HL7Name `hl7:",name=OML_O35_PatientPrior,type=tg"`
PID *PID `hl7:"30,required,display=Patient Identification"`
PD1 *PD1 `hl7:"31,display=Patient Additional Demographic"`
}
PatientPrior
type OML_O35_PatientVisit ¶
type OML_O35_PatientVisit struct {
HL7 HL7Name `hl7:",name=OML_O35_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type OML_O35_PatientVisitPrior ¶
type OML_O35_PatientVisitPrior struct {
HL7 HL7Name `hl7:",name=OML_O35_PatientVisitPrior,type=tg"`
PV1 *PV1 `hl7:"32,required,display=Patient Visit"`
PV2 *PV2 `hl7:"33,display=Patient Visit - Additional Information"`
}
PatientVisitPrior
type OML_O35_PriorResult ¶
type OML_O35_PriorResult struct {
HL7 HL7Name `hl7:",name=OML_O35_PriorResult,type=tg"`
PatientPrior *OML_O35_PatientPrior `hl7:",display=Patient Prior"`
PatientVisitPrior *OML_O35_PatientVisitPrior `hl7:",display=Patient Visit Prior"`
AL1 []AL1 `hl7:"34,display=Patient Allergy Information"`
OrderPrior []OML_O35_OrderPrior `hl7:",required,display=Order Prior"`
}
PriorResult
type OML_O35_Specimen ¶
type OML_O35_Specimen struct {
HL7 HL7Name `hl7:",name=OML_O35_Specimen,type=tg"`
SPM *SPM `hl7:"16,required,display=Specimen"`
OBX []OBX `hl7:"17,display=Observation/Result"`
SpecimenContainer []OML_O35_SpecimenContainer `hl7:",required,display=Specimen Container"`
}
Specimen
type OML_O35_SpecimenContainer ¶
type OML_O35_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=OML_O35_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"18,required,display=Specimen Container Detail"`
Order []OML_O35_Order `hl7:",required,display=Order"`
}
SpecimenContainer
type OML_O35_Timing ¶
type OML_O35_Timing struct {
HL7 HL7Name `hl7:",name=OML_O35_Timing,type=tg"`
TQ1 *TQ1 `hl7:"20,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"21,display=Timing/Quantity Relationship"`
}
Timing
type OML_O35_TimingPrior ¶
type OML_O35_TimingPrior struct {
HL7 HL7Name `hl7:",name=OML_O35_TimingPrior,type=tg"`
TQ1 *TQ1 `hl7:"39,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"40,display=Timing/Quantity Relationship"`
}
TimingPrior
type OMN_O07 ¶
type OMN_O07 struct {
HL7 HL7Name `hl7:",name=OMN_O07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMN_O07_Patient `hl7:",display=Patient"`
Order []OMN_O07_Order `hl7:",required,display=Order"`
}
Non-Stock Requisition Order
Non-stock requisitions can use the ORM message with the RQD and RQ1 segments as the detail segment, or use the OMN and ORN messages.
type OMN_O07_Insurance ¶
type OMN_O07_Insurance struct {
HL7 HL7Name `hl7:",name=OMN_O07_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMN_O07_Observation ¶
type OMN_O07_Observation struct {
HL7 HL7Name `hl7:",name=OMN_O07_Observation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Observation
type OMN_O07_Order ¶
type OMN_O07_Order struct {
HL7 HL7Name `hl7:",name=OMN_O07_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []OMN_O07_Timing `hl7:",display=Timing"`
RQD *RQD `hl7:"18,required,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"19,display=Requisition Detail-1"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
Observation []OMN_O07_Observation `hl7:",display=Observation"`
BLG *BLG `hl7:"23,display=Billing"`
}
Order
type OMN_O07_Patient ¶
type OMN_O07_Patient struct {
HL7 HL7Name `hl7:",name=OMN_O07_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMN_O07_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMN_O07_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMN_O07_PatientVisit ¶
type OMN_O07_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMN_O07_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMN_O07_Timing ¶
type OMN_O07_Timing struct {
HL7 HL7Name `hl7:",name=OMN_O07_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type OMP_O09 ¶
type OMP_O09 struct {
HL7 HL7Name `hl7:",name=OMP_O09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMP_O09_Patient `hl7:",display=Patient"`
Order []OMP_O09_Order `hl7:",required,display=Order"`
}
Pharmacy/Treatment Order
Pharmacy/Treatment Orders should use OMP from V2.4 and onwards for pharmacy orders instead of ORM.
type OMP_O09_Component ¶
type OMP_O09_Component struct {
HL7 HL7Name `hl7:",name=OMP_O09_Component,type=tg"`
RXC *RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Component
type OMP_O09_Insurance ¶
type OMP_O09_Insurance struct {
HL7 HL7Name `hl7:",name=OMP_O09_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMP_O09_Observation ¶
type OMP_O09_Observation struct {
HL7 HL7Name `hl7:",name=OMP_O09_Observation,type=tg"`
OBX *OBX `hl7:"23,required,display=Observation/Result"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Observation
type OMP_O09_Order ¶
type OMP_O09_Order struct {
HL7 HL7Name `hl7:",name=OMP_O09_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []OMP_O09_Timing `hl7:",display=Timing"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Component []OMP_O09_Component `hl7:",display=Component"`
Observation []OMP_O09_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"25,display=Financial Transaction"`
BLG *BLG `hl7:"26,display=Billing"`
}
Order
type OMP_O09_Patient ¶
type OMP_O09_Patient struct {
HL7 HL7Name `hl7:",name=OMP_O09_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMP_O09_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMP_O09_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMP_O09_PatientVisit ¶
type OMP_O09_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMP_O09_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMP_O09_Timing ¶
type OMP_O09_Timing struct {
HL7 HL7Name `hl7:",name=OMP_O09_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type OMS_O05 ¶
type OMS_O05 struct {
HL7 HL7Name `hl7:",name=OMS_O05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *OMS_O05_Patient `hl7:",display=Patient"`
Order []OMS_O05_Order `hl7:",required,display=Order"`
}
Stock Requisition Order
Stock requisition orders use the ORM where RQD is the detail segment for backward compatibility or can use the OMS and ORS messages.
type OMS_O05_Insurance ¶
type OMS_O05_Insurance struct {
HL7 HL7Name `hl7:",name=OMS_O05_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type OMS_O05_Observation ¶
type OMS_O05_Observation struct {
HL7 HL7Name `hl7:",name=OMS_O05_Observation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Observation
type OMS_O05_Order ¶
type OMS_O05_Order struct {
HL7 HL7Name `hl7:",name=OMS_O05_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []OMS_O05_Timing `hl7:",display=Timing"`
RQD *RQD `hl7:"18,required,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"19,display=Requisition Detail-1"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
Observation []OMS_O05_Observation `hl7:",display=Observation"`
BLG *BLG `hl7:"23,display=Billing"`
}
Order
type OMS_O05_Patient ¶
type OMS_O05_Patient struct {
HL7 HL7Name `hl7:",name=OMS_O05_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *OMS_O05_PatientVisit `hl7:",display=Patient Visit"`
Insurance []OMS_O05_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type OMS_O05_PatientVisit ¶
type OMS_O05_PatientVisit struct {
HL7 HL7Name `hl7:",name=OMS_O05_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type OMS_O05_Timing ¶
type OMS_O05_Timing struct {
HL7 HL7Name `hl7:",name=OMS_O05_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type OPL_O37 ¶
type OPL_O37 struct {
HL7 HL7Name `hl7:",name=OPL_O37,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
ROL []ROL `hl7:"5,required,display=Role"`
Guarantor *OPL_O37_Guarantor `hl7:",display=Guarantor"`
Order []OPL_O37_Order `hl7:",required,display=Order"`
}
Population/Location-Based Laboratory Order
This message supports the use-case for submission of field level specimen and order data to diagnostic laboratories.
type OPL_O37_Container ¶
type OPL_O37_Container struct {
HL7 HL7Name `hl7:",name=OPL_O37_Container,type=tg"`
SAC *SAC `hl7:"18,required,display=Specimen Container Detail"`
OBX []OBX `hl7:"19,display=Observation/Result"`
}
Container
type OPL_O37_Guarantor ¶
type OPL_O37_Guarantor struct {
HL7 HL7Name `hl7:",name=OPL_O37_Guarantor,type=tg"`
GT1 *GT1 `hl7:"6,required,display=Guarantor"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
}
Guarantor
type OPL_O37_Insurance ¶
type OPL_O37_Insurance struct {
HL7 HL7Name `hl7:",name=OPL_O37_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type OPL_O37_ObservationRequest ¶
type OPL_O37_ObservationRequest struct {
HL7 HL7Name `hl7:",name=OPL_O37_ObservationRequest,type=tg"`
ORC *ORC `hl7:"20,required,display=Common Order"`
OBR *OBR `hl7:"21,required,display=Observation Request"`
ROL []ROL `hl7:"22,display=Role"`
Timing []OPL_O37_Timing `hl7:",display=Timing"`
TCD *TCD `hl7:"25,display=Test Code Detail"`
DG1 []DG1 `hl7:"26,display=Diagnosis"`
OBX []OBX `hl7:"27,display=Observation/Result"`
}
ObservationRequest
type OPL_O37_Order ¶
type OPL_O37_Order struct {
HL7 HL7Name `hl7:",name=OPL_O37_Order,type=tg"`
NK1 []NK1 `hl7:"8,required,display=Next of Kin / Associated Parties"`
Patient *OPL_O37_Patient `hl7:",display=Patient"`
Specimen []OPL_O37_Specimen `hl7:",required,display=Specimen"`
PriorResult *OPL_O37_PriorResult `hl7:",display=Prior Result"`
FT1 []FT1 `hl7:"40,display=Financial Transaction"`
CTI []CTI `hl7:"41,display=Clinical Trial Identification"`
BLG *BLG `hl7:"42,display=Billing"`
}
Order
type OPL_O37_OrderPrior ¶
type OPL_O37_OrderPrior struct {
HL7 HL7Name `hl7:",name=OPL_O37_OrderPrior,type=tg"`
OBR *OBR `hl7:"34,required,display=Observation Request"`
ORC *ORC `hl7:"35,display=Common Order"`
ROL []ROL `hl7:"36,display=Role"`
Timing *OPL_O37_Timing2 `hl7:",display=Timing"`
OBX []OBX `hl7:"39,required,display=Observation/Result"`
}
OrderPrior
type OPL_O37_Patient ¶
type OPL_O37_Patient struct {
HL7 HL7Name `hl7:",name=OPL_O37_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
PD1 *PD1 `hl7:"10,display=Patient Additional Demographic"`
OBX []OBX `hl7:"11,display=Observation/Result"`
Insurance []OPL_O37_Insurance `hl7:",display=Insurance"`
AL1 []AL1 `hl7:"15,display=Patient Allergy Information"`
}
Patient
type OPL_O37_PatientPrior ¶
type OPL_O37_PatientPrior struct {
HL7 HL7Name `hl7:",name=OPL_O37_PatientPrior,type=tg"`
PID *PID `hl7:"29,required,display=Patient Identification"`
PD1 *PD1 `hl7:"30,display=Patient Additional Demographic"`
}
PatientPrior
type OPL_O37_PatientVisitPrior ¶
type OPL_O37_PatientVisitPrior struct {
HL7 HL7Name `hl7:",name=OPL_O37_PatientVisitPrior,type=tg"`
PV1 *PV1 `hl7:"31,required,display=Patient Visit"`
PV2 *PV2 `hl7:"32,display=Patient Visit - Additional Information"`
}
PatientVisitPrior
type OPL_O37_PriorResult ¶
type OPL_O37_PriorResult struct {
HL7 HL7Name `hl7:",name=OPL_O37_PriorResult,type=tg"`
NK1 []NK1 `hl7:"28,required,display=Next of Kin / Associated Parties"`
PatientPrior *OPL_O37_PatientPrior `hl7:",display=Patient Prior"`
PatientVisitPrior *OPL_O37_PatientVisitPrior `hl7:",display=Patient Visit Prior"`
AL1 *AL1 `hl7:"33,display=Patient Allergy Information"`
OrderPrior []OPL_O37_OrderPrior `hl7:",required,display=Order Prior"`
}
PriorResult
type OPL_O37_Specimen ¶
type OPL_O37_Specimen struct {
HL7 HL7Name `hl7:",name=OPL_O37_Specimen,type=tg"`
SPM *SPM `hl7:"16,required,display=Specimen"`
OBX []OBX `hl7:"17,display=Observation/Result"`
Container []OPL_O37_Container `hl7:",display=Container"`
ObservationRequest []OPL_O37_ObservationRequest `hl7:",required,display=Observation Request"`
}
Specimen
type OPL_O37_Timing ¶
type OPL_O37_Timing struct {
HL7 HL7Name `hl7:",name=OPL_O37_Timing,type=tg"`
TQ1 *TQ1 `hl7:"23,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"24,display=Timing/Quantity Relationship"`
}
Timing
type OPL_O37_Timing2 ¶
type OPL_O37_Timing2 struct {
HL7 HL7Name `hl7:",name=OPL_O37_Timing2,type=tg"`
TQ1 *TQ1 `hl7:"37,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"38,display=Timing/Quantity Relationship"`
}
Timing
type OPR_O38 ¶
type OPR_O38 struct {
HL7 HL7Name `hl7:",name=OPR_O38,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *OPR_O38_Response `hl7:",display=Response"`
}
Population/Location-Based Laboratory Order Acknowledgment
The function of this message is to respond to an OPL message. An OPR message is the application acknowledgment to an OPL message.
type OPR_O38_ObservationRequest ¶
type OPR_O38_ObservationRequest struct {
HL7 HL7Name `hl7:",name=OPR_O38_ObservationRequest,type=tg"`
ORC *ORC `hl7:"12,required,display=Common Order"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
ROL []ROL `hl7:"14,display=Role"`
}
ObservationRequest
type OPR_O38_Order ¶
type OPR_O38_Order struct {
HL7 HL7Name `hl7:",name=OPR_O38_Order,type=tg"`
NK1 []NK1 `hl7:"7,required,display=Next of Kin / Associated Parties"`
PID *PID `hl7:"8,display=Patient Identification"`
Specimen []OPR_O38_Specimen `hl7:",display=Specimen"`
}
Order
type OPR_O38_Response ¶
type OPR_O38_Response struct {
HL7 HL7Name `hl7:",name=OPR_O38_Response,type=tg"`
Order []OPR_O38_Order `hl7:",required,display=Order"`
}
Response
type OPR_O38_Specimen ¶
type OPR_O38_Specimen struct {
HL7 HL7Name `hl7:",name=OPR_O38_Specimen,type=tg"`
SPM *SPM `hl7:"9,required,display=Specimen"`
OBX []OBX `hl7:"10,display=Observation/Result"`
SAC []SAC `hl7:"11,display=Specimen Container Detail"`
ObservationRequest []OPR_O38_ObservationRequest `hl7:",display=Observation Request"`
Timing []OPR_O38_Timing `hl7:",display=Timing"`
}
Specimen
type OPR_O38_Timing ¶
type OPR_O38_Timing struct {
HL7 HL7Name `hl7:",name=OPR_O38_Timing,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
Timing
type OPU_R25 ¶
type OPU_R25 struct {
HL7 HL7Name `hl7:",name=OPU_R25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE *NTE `hl7:"4,display=Notes and Comments"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"7,display=Observation/Result"`
NTE2 []NTE `hl7:"8,display=Notes and Comments"`
ROL []ROL `hl7:"9,required,display=Role"`
AccessionDetail []OPU_R25_AccessionDetail `hl7:",required,display=Accession Detail"`
}
Unsolicited Population/Location-Based Laboratory Observation
This message supports unsolicited population or location-based surveillance reporting to a central repository where the accession / visit may contain references to multiple patients, multiple specimens, non-patient specimens, and multiple orders per specimen.
type OPU_R25_AccessionDetail ¶
type OPU_R25_AccessionDetail struct {
HL7 HL7Name `hl7:",name=OPU_R25_AccessionDetail,type=tg"`
NK1 []NK1 `hl7:"10,required,display=Next of Kin / Associated Parties"`
Patient *OPU_R25_Patient `hl7:",display=Patient"`
Specimen []OPU_R25_Specimen `hl7:",required,display=Specimen"`
}
AccessionDetail
type OPU_R25_Container ¶
type OPU_R25_Container struct {
HL7 HL7Name `hl7:",name=OPU_R25_Container,type=tg"`
SAC *SAC `hl7:"18,required,display=Specimen Container Detail"`
INV *INV `hl7:"19,display=Inventory Detail"`
}
Container
type OPU_R25_Order ¶
type OPU_R25_Order struct {
HL7 HL7Name `hl7:",name=OPU_R25_Order,type=tg"`
OBR *OBR `hl7:"20,required,display=Observation Request"`
ORC *ORC `hl7:"21,display=Common Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
ROL []ROL `hl7:"23,display=Role"`
TimingQty []OPU_R25_TimingQty `hl7:",display=Timing Qty"`
Result []OPU_R25_Result `hl7:",required,display=Result"`
}
Order
type OPU_R25_Patient ¶
type OPU_R25_Patient struct {
HL7 HL7Name `hl7:",name=OPU_R25_Patient,type=tg"`
PID *PID `hl7:"11,required,display=Patient Identification"`
PD1 *PD1 `hl7:"12,display=Patient Additional Demographic"`
PatientObservation []OPU_R25_PatientObservation `hl7:",display=Patient Observation"`
}
Patient
type OPU_R25_PatientObservation ¶
type OPU_R25_PatientObservation struct {
HL7 HL7Name `hl7:",name=OPU_R25_PatientObservation,type=tg"`
OBX *OBX `hl7:"13,required,display=Observation/Result"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
PatientObservation
type OPU_R25_Result ¶
type OPU_R25_Result struct {
HL7 HL7Name `hl7:",name=OPU_R25_Result,type=tg"`
OBX *OBX `hl7:"26,required,display=Observation/Result"`
NTE []NTE `hl7:"27,display=Notes and Comments"`
}
Result
type OPU_R25_Specimen ¶
type OPU_R25_Specimen struct {
HL7 HL7Name `hl7:",name=OPU_R25_Specimen,type=tg"`
SPM *SPM `hl7:"15,required,display=Specimen"`
SpecimenObservation []OPU_R25_SpecimenObservation `hl7:",display=Specimen Observation"`
Container []OPU_R25_Container `hl7:",display=Container"`
Order []OPU_R25_Order `hl7:",required,display=Order"`
}
Specimen
type OPU_R25_SpecimenObservation ¶
type OPU_R25_SpecimenObservation struct {
HL7 HL7Name `hl7:",name=OPU_R25_SpecimenObservation,type=tg"`
OBX *OBX `hl7:"16,required,display=Observation/Result"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
SpecimenObservation
type OPU_R25_TimingQty ¶
type OPU_R25_TimingQty struct {
HL7 HL7Name `hl7:",name=OPU_R25_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
TimingQty
type ORB_O28 ¶
type ORB_O28 struct {
HL7 HL7Name `hl7:",name=ORB_O28,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORB_O28_Response `hl7:",display=Response"`
}
Blood Product Order Acknowledgment
Blood product order messages present the need for additional information that is not included in standard HL7 order messages. Order messages must contain accompanying details regarding the blood product component, such as special processing requirements (e.g., irradiation and leukoreduction), and the amount of the blood product to be administered. Additionally, specific relevant clinical information can be included to allow the prospective review of the appropriateness of the blood product order.
Blood product orders use the OMB message with the BPO segment for the detail segment and the acknowledgment message.
type ORB_O28_Order ¶
type ORB_O28_Order struct {
HL7 HL7Name `hl7:",name=ORB_O28_Order,type=tg"`
ORC *ORC `hl7:"8,required,display=Common Order"`
Timing *ORB_O28_Timing `hl7:",required,display=Timing"`
BPO *BPO `hl7:"11,display=Blood product order"`
}
Order
type ORB_O28_Patient ¶
type ORB_O28_Patient struct {
HL7 HL7Name `hl7:",name=ORB_O28_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
Order *ORB_O28_Order `hl7:",required,display=Order"`
}
Patient
type ORB_O28_Response ¶
type ORB_O28_Response struct {
HL7 HL7Name `hl7:",name=ORB_O28_Response,type=tg"`
Patient *ORB_O28_Patient `hl7:",display=Patient"`
}
Response
type ORB_O28_Timing ¶
type ORB_O28_Timing struct {
HL7 HL7Name `hl7:",name=ORB_O28_Timing,type=tg"`
TQ1 *TQ1 `hl7:"9,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"10,display=Timing/Quantity Relationship"`
}
Timing
type ORC ¶
type ORC struct {
HL7 HL7Name `hl7:",name=ORC,type=s"`
OrderControl ID `hl7:"1,required,len=2,table=0119,display=Order Control"`
PlacerOrderNumber *EI `hl7:"2,conditional,len=427,display=Placer Order Number"`
FillerOrderNumber *EI `hl7:"3,conditional,len=427,display=Filler Order Number"`
PlacerGroupNumber *EI `hl7:"4,len=22,display=Placer Group Number"`
OrderStatus ID `hl7:"5,len=2,table=0038,display=Order Status"`
ResponseFlag ID `hl7:"6,len=1,table=0121,display=Response Flag"`
QuantityTiming []TQ `hl7:"7,len=705,display=Quantity/Timing"`
Parent *EIP `hl7:"8,len=200,display=Parent"`
DateTimeOfTransaction DTM `hl7:"9,len=24,format=YMDHM,display=Date/Time of Transaction"`
EnteredBy []XCN `hl7:"10,len=3220,display=Entered By"`
VerifiedBy []XCN `hl7:"11,len=250,display=Verified By"`
OrderingProvider []XCN `hl7:"12,len=3220,display=Ordering Provider"`
EnterersLocation *PL `hl7:"13,len=80,display=Enterer's Location"`
CallBackPhoneNumber []XTN `hl7:"14,max=2,len=250,display=Call Back Phone Number"`
OrderEffectiveDateTime DTM `hl7:"15,len=24,format=YMDHM,display=Order Effective Date/Time"`
OrderControlCodeReason *CWE `hl7:"16,len=250,display=Order Control Code Reason"`
EnteringOrganization *CWE `hl7:"17,len=250,display=Entering Organization"`
EnteringDevice *CWE `hl7:"18,len=250,display=Entering Device"`
ActionBy []XCN `hl7:"19,len=250,display=Action By"`
AdvancedBeneficiaryNoticeCode *CWE `hl7:"20,len=250,table=0339,display=Advanced Beneficiary Notice Code"`
OrderingFacilityName []XON `hl7:"21,len=250,display=Ordering Facility Name"`
OrderingFacilityAddress []XAD `hl7:"22,len=250,display=Ordering Facility Address"`
OrderingFacilityPhoneNumber []XTN `hl7:"23,len=250,display=Ordering Facility Phone Number"`
OrderingProviderAddress []XAD `hl7:"24,len=250,display=Ordering Provider Address"`
OrderStatusModifier *CWE `hl7:"25,len=250,display=Order Status Modifier"`
AdvancedBeneficiaryNoticeOverrideReason *CWE `hl7:"26,conditional,len=60,table=0552,display=Advanced Beneficiary Notice Override Reason"`
FillersExpectedAvailabilityDateTime DTM `hl7:"27,len=24,format=YMDHM,display=Filler's Expected Availability Date/Time"`
ConfidentialityCode *CWE `hl7:"28,len=250,table=0177,display=Confidentiality Code"`
OrderType *CWE `hl7:"29,len=250,table=0482,display=Order Type"`
EntererAuthorizationMode *CNE `hl7:"30,len=250,table=0483,display=Enterer Authorization Mode"`
ParentUniversalServiceIdentifier *CWE `hl7:"31,len=250,display=Parent Universal Service Identifier"`
}
Common Order
The Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that are requested).
type ORD_O04 ¶
type ORD_O04 struct {
HL7 HL7Name `hl7:",name=ORD_O04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORD_O04_Response `hl7:",display=Response"`
}
Dietary Order Acknowledgement
A diet office needs to receive specific information, the most important being the diet order itself. Diet restrictions (often called diet codes) are the basic building blocks of a diet order. The diet order segments may be sent as part of the ORM and ORR message structure to support backwards compatibility, or may be sent as part of the OMD and ORD messages.
type ORD_O04_OrderDiet ¶
type ORD_O04_OrderDiet struct {
HL7 HL7Name `hl7:",name=ORD_O04_OrderDiet,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
TimingDiet []ORD_O04_TimingDiet `hl7:",display=Timing Diet"`
ODS []ODS `hl7:"12,display=Dietary Orders- Supplements- and Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
OrderDiet
type ORD_O04_OrderTray ¶
type ORD_O04_OrderTray struct {
HL7 HL7Name `hl7:",name=ORD_O04_OrderTray,type=tg"`
ORC *ORC `hl7:"14,required,display=Common Order"`
TimingTray []ORD_O04_TimingTray `hl7:",display=Timing Tray"`
ODT []ODT `hl7:"17,display=Diet Tray Instructions"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
OrderTray
type ORD_O04_Patient ¶
type ORD_O04_Patient struct {
HL7 HL7Name `hl7:",name=ORD_O04_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORD_O04_Response ¶
type ORD_O04_Response struct {
HL7 HL7Name `hl7:",name=ORD_O04_Response,type=tg"`
Patient *ORD_O04_Patient `hl7:",display=Patient"`
OrderDiet []ORD_O04_OrderDiet `hl7:",required,display=Order Diet"`
OrderTray []ORD_O04_OrderTray `hl7:",display=Order Tray"`
}
Response
type ORD_O04_TimingDiet ¶
type ORD_O04_TimingDiet struct {
HL7 HL7Name `hl7:",name=ORD_O04_TimingDiet,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
TimingDiet
type ORD_O04_TimingTray ¶
type ORD_O04_TimingTray struct {
HL7 HL7Name `hl7:",name=ORD_O04_TimingTray,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingTray
type ORF_R04 ¶
type ORF_R04 struct {
HL7 HL7Name `hl7:",name=ORF_R04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
QueryResponse []ORF_R04_QueryResponse `hl7:",required,display=Query Response"`
ERR []ERR `hl7:"20,display=Error"`
QAK *QAK `hl7:"21,display=Query Acknowledgment"`
DSC *DSC `hl7:"22,display=Continuation Pointer"`
}
Results of Observation Response
Retained for backwards compatibility only in version 2.4 and later
type ORF_R04_Observation ¶
type ORF_R04_Observation struct {
HL7 HL7Name `hl7:",name=ORF_R04_Observation,type=tg"`
OBX *OBX `hl7:"17,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Observation
type ORF_R04_Order ¶
type ORF_R04_Order struct {
HL7 HL7Name `hl7:",name=ORF_R04_Order,type=tg"`
ORC *ORC `hl7:"10,display=Common Order"`
OBR *OBR `hl7:"11,required,display=Observation Request"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
ROL []ROL `hl7:"13,display=Role"`
TimingQty []ORF_R04_TimingQty `hl7:",display=Timing Qty"`
CTD *CTD `hl7:"16,display=Contact Data"`
Observation []ORF_R04_Observation `hl7:",required,display=Observation"`
CTI []CTI `hl7:"19,display=Clinical Trial Identification"`
}
Order
type ORF_R04_Patient ¶
type ORF_R04_Patient struct {
HL7 HL7Name `hl7:",name=ORF_R04_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
OBX []OBX `hl7:"9,display=Observation/Result"`
}
Patient
type ORF_R04_QueryResponse ¶
type ORF_R04_QueryResponse struct {
HL7 HL7Name `hl7:",name=ORF_R04_QueryResponse,type=tg"`
Patient *ORF_R04_Patient `hl7:",display=Patient"`
Order []ORF_R04_Order `hl7:",required,display=Order"`
}
QueryResponse
type ORF_R04_TimingQty ¶
type ORF_R04_TimingQty struct {
HL7 HL7Name `hl7:",name=ORF_R04_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingQty
type ORF_W02 ¶
type ORF_W02 struct {
HL7 HL7Name `hl7:",name=ORF_W02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
QueryResponse []ORF_W02_QueryResponse `hl7:",required,display=Query Response"`
ERR []ERR `hl7:"20,display=Error"`
QAK *QAK `hl7:"21,display=Query Acknowledgment"`
DSC *DSC `hl7:"22,display=Continuation Pointer"`
}
Waveform Result, Response to Query
The W02 trigger event identifies QRF messages which are a response to a QRY message specifying an immediate mode query for waveform results/observations with record-oriented format.
type ORF_W02_Observation ¶
type ORF_W02_Observation struct {
HL7 HL7Name `hl7:",name=ORF_W02_Observation,type=tg"`
OBX *OBX `hl7:"17,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Observation
type ORF_W02_Order ¶
type ORF_W02_Order struct {
HL7 HL7Name `hl7:",name=ORF_W02_Order,type=tg"`
ORC *ORC `hl7:"10,display=Common Order"`
OBR *OBR `hl7:"11,required,display=Observation Request"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
ROL []ROL `hl7:"13,display=Role"`
TimingQty []ORF_W02_TimingQty `hl7:",display=Timing Qty"`
CTD *CTD `hl7:"16,display=Contact Data"`
Observation []ORF_W02_Observation `hl7:",required,display=Observation"`
CTI []CTI `hl7:"19,display=Clinical Trial Identification"`
}
Order
type ORF_W02_Patient ¶
type ORF_W02_Patient struct {
HL7 HL7Name `hl7:",name=ORF_W02_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
OBX []OBX `hl7:"9,display=Observation/Result"`
}
Patient
type ORF_W02_QueryResponse ¶
type ORF_W02_QueryResponse struct {
HL7 HL7Name `hl7:",name=ORF_W02_QueryResponse,type=tg"`
Patient *ORF_W02_Patient `hl7:",display=Patient"`
Order []ORF_W02_Order `hl7:",required,display=Order"`
}
QueryResponse
type ORF_W02_TimingQty ¶
type ORF_W02_TimingQty struct {
HL7 HL7Name `hl7:",name=ORF_W02_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingQty
type ORG ¶
type ORG struct {
HL7 HL7Name `hl7:",name=ORG,type=s"`
SetID SI `hl7:"1,seq,required,len=60,display=Set ID – ORG"`
OrganizationUnitCode *CWE `hl7:"2,len=250,table=0405,display=Organization Unit Code"`
OrganizationUnitTypeCode *CWE `hl7:"3,len=250,table=0474,display=Organization Unit Type Code"`
PrimaryUnitIndicator ID `hl7:"4,len=1,table=0136,display=Primary Org Unit Indicator"`
PractitionerUnitIdentifier *CX `hl7:"5,len=60,display=Practitioner Org Unit Identifier"`
HealthCareProviderTypeCode *CWE `hl7:"6,len=250,table=0452,display=Health Care Provider Type Code"`
HealthCareProviderClassificationCode *CWE `hl7:"7,len=250,table=0453,display=Health Care Provider Classification Code"`
HealthCareProviderAreaOfSpecializationCode *CWE `hl7:"8,len=250,table=0454,display=Health Care Provider Area of Specialization Code"`
EffectiveDateRange *DR `hl7:"9,len=52,display=Effective Date Range"`
EmploymentStatusCode *CWE `hl7:"10,len=250,table=0066,display=Employment Status Code"`
BoardApprovalIndicator ID `hl7:"11,len=1,table=0136,display=Board Approval Indicator"`
PrimaryCarePhysicianIndicator ID `hl7:"12,len=1,table=0136,display=Primary Care Physician Indicator"`
}
Practitioner Organization Unit
The ORG segment relates a practitioner to an organization unit and adds detailed information regarding the practitioner's practicing specialty in that organization unit. An ORG segment may optionally follow an STF segment. An ORG segment must always have been preceded by a corresponding STF segment. If no organization unit is specified, this segment is used to relate practitioners with their practicing specialties, including effective and end dates. When it is not necessary to record organization unit or dates associated with the practicing specialty, this data is recorded in PRA-3-Practitioner Category.
type ORG_O20 ¶
type ORG_O20 struct {
HL7 HL7Name `hl7:",name=ORG_O20,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORG_O20_Response `hl7:",display=Response"`
}
General Clinical Order Acknowledgement Response
The function of this message is to respond to an OMG message. An ORG message is the application acknowledgment to an OMG message.
type ORG_O20_ObservationGroup ¶
type ORG_O20_ObservationGroup struct {
HL7 HL7Name `hl7:",name=ORG_O20_ObservationGroup,type=tg"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
ROL []ROL `hl7:"13,display=Role"`
}
ObservationGroup
type ORG_O20_Order ¶
type ORG_O20_Order struct {
HL7 HL7Name `hl7:",name=ORG_O20_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []ORG_O20_Timing `hl7:",display=Timing"`
ObservationGroup *ORG_O20_ObservationGroup `hl7:",display=Observation Group"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
CTI []CTI `hl7:"15,display=Clinical Trial Identification"`
Specimen []ORG_O20_Specimen `hl7:",display=Specimen"`
}
Order
type ORG_O20_Patient ¶
type ORG_O20_Patient struct {
HL7 HL7Name `hl7:",name=ORG_O20_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORG_O20_Response ¶
type ORG_O20_Response struct {
HL7 HL7Name `hl7:",name=ORG_O20_Response,type=tg"`
Patient *ORG_O20_Patient `hl7:",display=Patient"`
Order []ORG_O20_Order `hl7:",required,display=Order"`
}
Response
type ORG_O20_Specimen ¶
type ORG_O20_Specimen struct {
HL7 HL7Name `hl7:",name=ORG_O20_Specimen,type=tg"`
SPM *SPM `hl7:"16,required,display=Specimen"`
SAC []SAC `hl7:"17,display=Specimen Container Detail"`
}
Specimen
type ORG_O20_Timing ¶
type ORG_O20_Timing struct {
HL7 HL7Name `hl7:",name=ORG_O20_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type ORI_O24 ¶
type ORI_O24 struct {
HL7 HL7Name `hl7:",name=ORI_O24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORI_O24_Response `hl7:",display=Response"`
}
General Imaging Order Response
The function of this message is to respond to an OMI message. An ORI message is the application acknowledgment to an OMI message.
type ORI_O24_Order ¶
type ORI_O24_Order struct {
HL7 HL7Name `hl7:",name=ORI_O24_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []ORI_O24_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
ROL []ROL `hl7:"14,display=Role"`
IPC []IPC `hl7:"15,required,display=Imaging Procedure Control Segment"`
}
Order
type ORI_O24_Patient ¶
type ORI_O24_Patient struct {
HL7 HL7Name `hl7:",name=ORI_O24_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORI_O24_Response ¶
type ORI_O24_Response struct {
HL7 HL7Name `hl7:",name=ORI_O24_Response,type=tg"`
Patient *ORI_O24_Patient `hl7:",display=Patient"`
Order []ORI_O24_Order `hl7:",required,display=Order"`
}
Response
type ORI_O24_Timing ¶
type ORI_O24_Timing struct {
HL7 HL7Name `hl7:",name=ORI_O24_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type ORL_O22 ¶
type ORL_O22 struct {
HL7 HL7Name `hl7:",name=ORL_O22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORL_O22_Response `hl7:",display=Response"`
}
General Laboratory Order Response
The function of this message is to respond to an OML message. An ORL message is the application acknowledgment to an OML message.
type ORL_O22_ObservationRequest ¶
type ORL_O22_ObservationRequest struct {
HL7 HL7Name `hl7:",name=ORL_O22_ObservationRequest,type=tg"`
OBR *OBR `hl7:"11,required,display=Observation Request"`
ROL []ROL `hl7:"12,display=Role"`
Specimen []ORL_O22_Specimen `hl7:",display=Specimen"`
}
ObservationRequest
type ORL_O22_Order ¶
type ORL_O22_Order struct {
HL7 HL7Name `hl7:",name=ORL_O22_Order,type=tg"`
ORC *ORC `hl7:"8,required,display=Common Order"`
Timing []ORL_O22_Timing `hl7:",display=Timing"`
ObservationRequest *ORL_O22_ObservationRequest `hl7:",display=Observation Request"`
}
Order
type ORL_O22_Response ¶
type ORL_O22_Response struct {
HL7 HL7Name `hl7:",name=ORL_O22_Response,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
Order []ORL_O22_Order `hl7:",display=Order"`
}
Response
type ORL_O22_Specimen ¶
type ORL_O22_Specimen struct {
HL7 HL7Name `hl7:",name=ORL_O22_Specimen,type=tg"`
SPM *SPM `hl7:"13,required,display=Specimen"`
SAC []SAC `hl7:"14,display=Specimen Container Detail"`
}
Specimen
type ORL_O22_Timing ¶
type ORL_O22_Timing struct {
HL7 HL7Name `hl7:",name=ORL_O22_Timing,type=tg"`
TQ1 *TQ1 `hl7:"9,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"10,display=Timing/Quantity Relationship"`
}
Timing
type ORL_O34 ¶
type ORL_O34 struct {
HL7 HL7Name `hl7:",name=ORL_O34,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORL_O34_Response `hl7:",display=Response"`
}
Multiple Laboratory Orders Related to Single Specimen Response
The function of this message is to respond to an OML message where the original trigger event produced an OML with the Specimen Group segment above the ORC. An ORL message is the application acknowledgment to an OML message.
type ORL_O34_ObservationRequest ¶
type ORL_O34_ObservationRequest struct {
HL7 HL7Name `hl7:",name=ORL_O34_ObservationRequest,type=tg"`
OBR *OBR `hl7:"14,required,display=Observation Request"`
ROL []ROL `hl7:"15,display=Role"`
}
ObservationRequest
type ORL_O34_Order ¶
type ORL_O34_Order struct {
HL7 HL7Name `hl7:",name=ORL_O34_Order,type=tg"`
ORC *ORC `hl7:"11,required,display=Common Order"`
Timing []ORL_O34_Timing `hl7:",display=Timing"`
ObservationRequest *ORL_O34_ObservationRequest `hl7:",display=Observation Request"`
}
Order
type ORL_O34_Response ¶
type ORL_O34_Response struct {
HL7 HL7Name `hl7:",name=ORL_O34_Response,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
Specimen []ORL_O34_Specimen `hl7:",required,display=Specimen"`
}
Response
type ORL_O34_Specimen ¶
type ORL_O34_Specimen struct {
HL7 HL7Name `hl7:",name=ORL_O34_Specimen,type=tg"`
SPM *SPM `hl7:"8,required,display=Specimen"`
OBX []OBX `hl7:"9,display=Observation/Result"`
SAC []SAC `hl7:"10,display=Specimen Container Detail"`
Order []ORL_O34_Order `hl7:",display=Order"`
}
Specimen
type ORL_O34_Timing ¶
type ORL_O34_Timing struct {
HL7 HL7Name `hl7:",name=ORL_O34_Timing,type=tg"`
TQ1 *TQ1 `hl7:"12,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"13,display=Timing/Quantity Relationship"`
}
Timing
type ORL_O36 ¶
type ORL_O36 struct {
HL7 HL7Name `hl7:",name=ORL_O36,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORL_O36_Response `hl7:",display=Response"`
}
Single Container of a Specimen Response
The function of this message is to respond to an OML message where the original trigger event produced an OML with the Specimen Group segment above the ORC. An ORL message is the application acknowledgment to an OML message.
type ORL_O36_ObservationRequest ¶
type ORL_O36_ObservationRequest struct {
HL7 HL7Name `hl7:",name=ORL_O36_ObservationRequest,type=tg"`
OBR *OBR `hl7:"15,required,display=Observation Request"`
ROL []ROL `hl7:"16,display=Role"`
}
ObservationRequest
type ORL_O36_Order ¶
type ORL_O36_Order struct {
HL7 HL7Name `hl7:",name=ORL_O36_Order,type=tg"`
ORC *ORC `hl7:"12,required,display=Common Order"`
Timing []ORL_O36_Timing `hl7:",display=Timing"`
ObservationRequest *ORL_O36_ObservationRequest `hl7:",display=Observation Request"`
}
Order
type ORL_O36_Response ¶
type ORL_O36_Response struct {
HL7 HL7Name `hl7:",name=ORL_O36_Response,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
Specimen []ORL_O36_Specimen `hl7:",required,display=Specimen"`
}
Response
type ORL_O36_Specimen ¶
type ORL_O36_Specimen struct {
HL7 HL7Name `hl7:",name=ORL_O36_Specimen,type=tg"`
SPM *SPM `hl7:"8,required,display=Specimen"`
OBX []OBX `hl7:"9,display=Observation/Result"`
NTE []NTE `hl7:"10,display=Notes and Comments"`
SpecimenContainer []ORL_O36_SpecimenContainer `hl7:",required,display=Specimen Container"`
}
Specimen
type ORL_O36_SpecimenContainer ¶
type ORL_O36_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=ORL_O36_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"11,required,display=Specimen Container Detail"`
Order []ORL_O36_Order `hl7:",display=Order"`
}
SpecimenContainer
type ORL_O36_Timing ¶
type ORL_O36_Timing struct {
HL7 HL7Name `hl7:",name=ORL_O36_Timing,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
Timing
type ORM_O01 ¶
type ORM_O01 struct {
HL7 HL7Name `hl7:",name=ORM_O01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
NTE []NTE `hl7:"2,display=Notes and Comments"`
Patient *ORM_O01_Patient `hl7:",display=Patient"`
Order []ORM_O01_Order `hl7:",required,display=Order"`
}
General Order Message
Retained for backwards compatibility only as of v2.4. Refer to OMG, OML, OMD, OMS, OMN, OMI, and OMP instead.
The function of this message is to initiate the transmission of information about an order. This includes placing new orders, cancellation of existing orders, discontinuation, holding, etc. ORM messages can originate also with a placer, filler, or an interested third party.
type ORM_O01_Insurance ¶
type ORM_O01_Insurance struct {
HL7 HL7Name `hl7:",name=ORM_O01_Insurance,type=tg"`
IN1 *IN1 `hl7:"8,required,display=Insurance"`
IN2 *IN2 `hl7:"9,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"10,display=Insurance Additional Information- Certification"`
}
Insurance
type ORM_O01_Observation ¶
type ORM_O01_Observation struct {
HL7 HL7Name `hl7:",name=ORM_O01_Observation,type=tg"`
OBX *OBX `hl7:"23,required,display=Observation/Result"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Observation
type ORM_O01_Order ¶
type ORM_O01_Order struct {
HL7 HL7Name `hl7:",name=ORM_O01_Order,type=tg"`
ORC *ORC `hl7:"13,required,display=Common Order"`
OrderDetail *ORM_O01_OrderDetail `hl7:",display=Order Detail"`
FT1 []FT1 `hl7:"25,display=Financial Transaction"`
CTI []CTI `hl7:"26,display=Clinical Trial Identification"`
BLG *BLG `hl7:"27,display=Billing"`
}
Order
type ORM_O01_OrderDetail ¶
type ORM_O01_OrderDetail struct {
HL7 HL7Name `hl7:",name=ORM_O01_OrderDetail,type=tg"`
OrderDetailSegment *ORM_O01_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
CTD *CTD `hl7:"21,display=Contact Data"`
DG1 []DG1 `hl7:"22,display=Diagnosis"`
Observation []ORM_O01_Observation `hl7:",display=Observation"`
}
OrderDetail
type ORM_O01_OrderDetailSegment ¶
type ORM_O01_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=ORM_O01_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"14,conditional,display=Observation Request"`
RQD *RQD `hl7:"15,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"16,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"17,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"18,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"19,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type ORM_O01_Patient ¶
type ORM_O01_Patient struct {
HL7 HL7Name `hl7:",name=ORM_O01_Patient,type=tg"`
PID *PID `hl7:"3,required,display=Patient Identification"`
PD1 *PD1 `hl7:"4,display=Patient Additional Demographic"`
NTE []NTE `hl7:"5,display=Notes and Comments"`
PatientVisit *ORM_O01_PatientVisit `hl7:",display=Patient Visit"`
Insurance []ORM_O01_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"11,display=Guarantor"`
AL1 []AL1 `hl7:"12,display=Patient Allergy Information"`
}
Patient
type ORM_O01_PatientVisit ¶
type ORM_O01_PatientVisit struct {
HL7 HL7Name `hl7:",name=ORM_O01_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"6,required,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
}
PatientVisit
type ORN_O08 ¶
type ORN_O08 struct {
HL7 HL7Name `hl7:",name=ORN_O08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORN_O08_Response `hl7:",display=Response"`
}
Non-Stock Requisition Order Acknowledgement
Non-stock requisitions can use the ORM message with the RQD and RQ1 segments as the detail segment, or use the OMN and ORN messages.
type ORN_O08_Order ¶
type ORN_O08_Order struct {
HL7 HL7Name `hl7:",name=ORN_O08_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []ORN_O08_Timing `hl7:",display=Timing"`
RQD *RQD `hl7:"12,required,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"13,display=Requisition Detail-1"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Order
type ORN_O08_Patient ¶
type ORN_O08_Patient struct {
HL7 HL7Name `hl7:",name=ORN_O08_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORN_O08_Response ¶
type ORN_O08_Response struct {
HL7 HL7Name `hl7:",name=ORN_O08_Response,type=tg"`
Patient *ORN_O08_Patient `hl7:",display=Patient"`
Order []ORN_O08_Order `hl7:",required,display=Order"`
}
Response
type ORN_O08_Timing ¶
type ORN_O08_Timing struct {
HL7 HL7Name `hl7:",name=ORN_O08_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type ORP_O10 ¶
type ORP_O10 struct {
HL7 HL7Name `hl7:",name=ORP_O10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORP_O10_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Order Acknowledgement
type ORP_O10_Component ¶
type ORP_O10_Component struct {
HL7 HL7Name `hl7:",name=ORP_O10_Component,type=tg"`
RXC *RXC `hl7:"15,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Component
type ORP_O10_Order ¶
type ORP_O10_Order struct {
HL7 HL7Name `hl7:",name=ORP_O10_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []ORP_O10_Timing `hl7:",display=Timing"`
OrderDetail *ORP_O10_OrderDetail `hl7:",display=Order Detail"`
}
Order
type ORP_O10_OrderDetail ¶
type ORP_O10_OrderDetail struct {
HL7 HL7Name `hl7:",name=ORP_O10_OrderDetail,type=tg"`
RXO *RXO `hl7:"12,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
RXR []RXR `hl7:"14,required,display=Pharmacy/Treatment Route"`
Component []ORP_O10_Component `hl7:",display=Component"`
}
OrderDetail
type ORP_O10_Patient ¶
type ORP_O10_Patient struct {
HL7 HL7Name `hl7:",name=ORP_O10_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORP_O10_Response ¶
type ORP_O10_Response struct {
HL7 HL7Name `hl7:",name=ORP_O10_Response,type=tg"`
Patient *ORP_O10_Patient `hl7:",display=Patient"`
Order []ORP_O10_Order `hl7:",required,display=Order"`
}
Response
type ORP_O10_Timing ¶
type ORP_O10_Timing struct {
HL7 HL7Name `hl7:",name=ORP_O10_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type ORR_O02 ¶
type ORR_O02 struct {
HL7 HL7Name `hl7:",name=ORR_O02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Response *ORR_O02_Response `hl7:",display=Response"`
}
General Order Response Message to any ORM
Left for backward compatibility only. It is recommended that the trigger events ORG, ORL, ORD, ORS, ORN, ORI, and ORP be used instead when communicating orders and order related events.
The function of this message is to respond to an ORM message. An ORR message is the application acknowledgment to an ORM message.
type ORR_O02_Order ¶
type ORR_O02_Order struct {
HL7 HL7Name `hl7:",name=ORR_O02_Order,type=tg"`
ORC *ORC `hl7:"7,required,display=Common Order"`
OrderDetailSegment *ORR_O02_OrderDetailSegment `hl7:",display=Order Detail Segment"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
CTI []CTI `hl7:"15,display=Clinical Trial Identification"`
}
Order
type ORR_O02_OrderDetailSegment ¶
type ORR_O02_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=ORR_O02_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"8,conditional,display=Observation Request"`
RQD *RQD `hl7:"9,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"10,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"11,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"12,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"13,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type ORR_O02_Patient ¶
type ORR_O02_Patient struct {
HL7 HL7Name `hl7:",name=ORR_O02_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
}
Patient
type ORR_O02_Response ¶
type ORR_O02_Response struct {
HL7 HL7Name `hl7:",name=ORR_O02_Response,type=tg"`
Patient *ORR_O02_Patient `hl7:",display=Patient"`
Order []ORR_O02_Order `hl7:",required,display=Order"`
}
Response
type ORS_O06 ¶
type ORS_O06 struct {
HL7 HL7Name `hl7:",name=ORS_O06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *ORS_O06_Response `hl7:",display=Response"`
}
Stock Requisition Order Acknowledgement
Stock requisition orders use the ORM where RQD is the detail segment for backward compatibility or can use the OMS and ORS messages.
type ORS_O06_Order ¶
type ORS_O06_Order struct {
HL7 HL7Name `hl7:",name=ORS_O06_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []ORS_O06_Timing `hl7:",display=Timing"`
RQD *RQD `hl7:"12,required,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"13,display=Requisition Detail-1"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Order
type ORS_O06_Patient ¶
type ORS_O06_Patient struct {
HL7 HL7Name `hl7:",name=ORS_O06_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type ORS_O06_Response ¶
type ORS_O06_Response struct {
HL7 HL7Name `hl7:",name=ORS_O06_Response,type=tg"`
Patient *ORS_O06_Patient `hl7:",display=Patient"`
Order []ORS_O06_Order `hl7:",required,display=Order"`
}
Response
type ORS_O06_Timing ¶
type ORS_O06_Timing struct {
HL7 HL7Name `hl7:",name=ORS_O06_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type ORU_R01 ¶
type ORU_R01 struct {
HL7 HL7Name `hl7:",name=ORU_R01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PatientResult []ORU_R01_PatientResult `hl7:",required,display=Patient Result"`
DSC *DSC `hl7:"24,display=Continuation Pointer"`
}
Unsolicited transmission of an observation message
The ORU message is for transmitting laboratory results to other systems. The OUL message is designed to accommodate the laboratory processes of laboratory automation systems.
type ORU_R01_Observation ¶
type ORU_R01_Observation struct {
HL7 HL7Name `hl7:",name=ORU_R01_Observation,type=tg"`
OBX *OBX `hl7:"18,required,display=Observation/Result"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
Observation
type ORU_R01_OrderObservation ¶
type ORU_R01_OrderObservation struct {
HL7 HL7Name `hl7:",name=ORU_R01_OrderObservation,type=tg"`
ORC *ORC `hl7:"11,display=Common Order"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []ORU_R01_TimingQty `hl7:",display=Timing Qty"`
CTD *CTD `hl7:"17,display=Contact Data"`
Observation []ORU_R01_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"20,display=Financial Transaction"`
CTI []CTI `hl7:"21,display=Clinical Trial Identification"`
Specimen []ORU_R01_Specimen `hl7:",display=Specimen"`
}
OrderObservation
type ORU_R01_Patient ¶
type ORU_R01_Patient struct {
HL7 HL7Name `hl7:",name=ORU_R01_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
OBX []OBX `hl7:"8,display=Observation/Result"`
Visit *ORU_R01_Visit `hl7:",display=Visit"`
}
Patient
type ORU_R01_PatientResult ¶
type ORU_R01_PatientResult struct {
HL7 HL7Name `hl7:",name=ORU_R01_PatientResult,type=tg"`
Patient *ORU_R01_Patient `hl7:",display=Patient"`
OrderObservation []ORU_R01_OrderObservation `hl7:",required,display=Order Observation"`
}
PatientResult
type ORU_R01_Specimen ¶
type ORU_R01_Specimen struct {
HL7 HL7Name `hl7:",name=ORU_R01_Specimen,type=tg"`
SPM *SPM `hl7:"22,required,display=Specimen"`
OBX []OBX `hl7:"23,display=Observation/Result"`
}
Specimen
type ORU_R01_TimingQty ¶
type ORU_R01_TimingQty struct {
HL7 HL7Name `hl7:",name=ORU_R01_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type ORU_R01_Visit ¶
type ORU_R01_Visit struct {
HL7 HL7Name `hl7:",name=ORU_R01_Visit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Visit
type ORU_R30 ¶
type ORU_R30 struct {
HL7 HL7Name `hl7:",name=ORU_R30,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
OBX []OBX `hl7:"6,display=Observation/Result"`
Visit *ORU_R30_Visit `hl7:",display=Visit"`
ORC *ORC `hl7:"9,required,display=Common Order"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
ROL []ROL `hl7:"12,display=Role"`
TimingQty []ORU_R30_TimingQty `hl7:",display=Timing Qty"`
Observation []ORU_R30_Observation `hl7:",required,display=Observation"`
}
Unsolicited Point-Of-Care Observation Message without Existing Order – Place an Order
This event trigger instructs the receiving system to create a new order for the observation(s) contained in the message.
type ORU_R30_Observation ¶
type ORU_R30_Observation struct {
HL7 HL7Name `hl7:",name=ORU_R30_Observation,type=tg"`
OBX *OBX `hl7:"15,required,display=Observation/Result"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Observation
type ORU_R30_TimingQty ¶
type ORU_R30_TimingQty struct {
HL7 HL7Name `hl7:",name=ORU_R30_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingQty
type ORU_R30_Visit ¶
type ORU_R30_Visit struct {
HL7 HL7Name `hl7:",name=ORU_R30_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type ORU_R31 ¶
type ORU_R31 struct {
HL7 HL7Name `hl7:",name=ORU_R31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
OBX []OBX `hl7:"6,display=Observation/Result"`
Visit *ORU_R31_Visit `hl7:",display=Visit"`
ORC *ORC `hl7:"9,required,display=Common Order"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
ROL []ROL `hl7:"12,display=Role"`
TimingQty []ORU_R31_TimingQty `hl7:",display=Timing Qty"`
Observation []ORU_R31_Observation `hl7:",required,display=Observation"`
}
Unsolicited New Point-Of-Care Observation Message – Search for an Order
This event trigger instructs the receiving system to search for an existing order for the observation(s) contained in the message.
type ORU_R31_Observation ¶
type ORU_R31_Observation struct {
HL7 HL7Name `hl7:",name=ORU_R31_Observation,type=tg"`
OBX *OBX `hl7:"15,required,display=Observation/Result"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Observation
type ORU_R31_TimingQty ¶
type ORU_R31_TimingQty struct {
HL7 HL7Name `hl7:",name=ORU_R31_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingQty
type ORU_R31_Visit ¶
type ORU_R31_Visit struct {
HL7 HL7Name `hl7:",name=ORU_R31_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type ORU_R32 ¶
type ORU_R32 struct {
HL7 HL7Name `hl7:",name=ORU_R32,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
OBX []OBX `hl7:"6,display=Observation/Result"`
Visit *ORU_R32_Visit `hl7:",display=Visit"`
ORC *ORC `hl7:"9,required,display=Common Order"`
OBR *OBR `hl7:"10,required,display=Observation Request"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
ROL []ROL `hl7:"12,display=Role"`
TimingQty []ORU_R32_TimingQty `hl7:",display=Timing Qty"`
Observation []ORU_R32_Observation `hl7:",required,display=Observation"`
}
Unsolicited Pre-Ordered Point-Of-Care Observation
This event trigger instructs the receiver to place the result with the order information included in the message.
type ORU_R32_Observation ¶
type ORU_R32_Observation struct {
HL7 HL7Name `hl7:",name=ORU_R32_Observation,type=tg"`
OBX *OBX `hl7:"15,required,display=Observation/Result"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Observation
type ORU_R32_TimingQty ¶
type ORU_R32_TimingQty struct {
HL7 HL7Name `hl7:",name=ORU_R32_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingQty
type ORU_R32_Visit ¶
type ORU_R32_Visit struct {
HL7 HL7Name `hl7:",name=ORU_R32_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type ORU_W01 ¶
type ORU_W01 struct {
HL7 HL7Name `hl7:",name=ORU_W01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PatientResult []ORU_W01_PatientResult `hl7:",required,display=Patient Result"`
DSC *DSC `hl7:"24,display=Continuation Pointer"`
}
Waveform Result, Unsolicited Transmission Of Requested Information
The waveform response unsolicited trigger event identifies ORU messages used to transmit waveform data which are results of an ordered test or series of observations. The W01 trigger event may also be used to identify ORU messages sent as the eventual response to a QRY message specifying a deferred mode query for waveform results/observations with record-oriented format (similar to the deferred response display mode DSR message type described in Chapter 2). One or more ORU messages with the W01 trigger event may result from this type of QRY message.
type ORU_W01_Observation ¶
type ORU_W01_Observation struct {
HL7 HL7Name `hl7:",name=ORU_W01_Observation,type=tg"`
OBX *OBX `hl7:"18,required,display=Observation/Result"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
Observation
type ORU_W01_OrderObservation ¶
type ORU_W01_OrderObservation struct {
HL7 HL7Name `hl7:",name=ORU_W01_OrderObservation,type=tg"`
ORC *ORC `hl7:"11,display=Common Order"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
ROL []ROL `hl7:"14,display=Role"`
TimingQty []ORU_W01_TimingQty `hl7:",display=Timing Qty"`
CTD *CTD `hl7:"17,display=Contact Data"`
Observation []ORU_W01_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"20,display=Financial Transaction"`
CTI []CTI `hl7:"21,display=Clinical Trial Identification"`
Specimen []ORU_W01_Specimen `hl7:",display=Specimen"`
}
OrderObservation
type ORU_W01_Patient ¶
type ORU_W01_Patient struct {
HL7 HL7Name `hl7:",name=ORU_W01_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
OBX []OBX `hl7:"8,display=Observation/Result"`
Visit *ORU_W01_Visit `hl7:",display=Visit"`
}
Patient
type ORU_W01_PatientResult ¶
type ORU_W01_PatientResult struct {
HL7 HL7Name `hl7:",name=ORU_W01_PatientResult,type=tg"`
Patient *ORU_W01_Patient `hl7:",display=Patient"`
OrderObservation []ORU_W01_OrderObservation `hl7:",required,display=Order Observation"`
}
PatientResult
type ORU_W01_Specimen ¶
type ORU_W01_Specimen struct {
HL7 HL7Name `hl7:",name=ORU_W01_Specimen,type=tg"`
SPM *SPM `hl7:"22,required,display=Specimen"`
OBX []OBX `hl7:"23,display=Observation/Result"`
}
Specimen
type ORU_W01_TimingQty ¶
type ORU_W01_TimingQty struct {
HL7 HL7Name `hl7:",name=ORU_W01_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"15,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"16,display=Timing/Quantity Relationship"`
}
TimingQty
type ORU_W01_Visit ¶
type ORU_W01_Visit struct {
HL7 HL7Name `hl7:",name=ORU_W01_Visit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Visit
type OSD ¶
type OSD struct {
HL7 HL7Name `hl7:",name=OSD,len=110,type=d"`
SequenceResultsFlag ID `` /* 194-byte string literal not displayed */
PlacerOrderNumberEntityIdentifier ST `hl7:"2,required,len=15,display=Contains the first component of the placer order number- entity identifier ."`
PlacerOrderNumberNamespaceID IS `` /* 181-byte string literal not displayed */
FillerOrderNumberEntityIdentifier ST `hl7:"4,required,len=15,display=Contains the first component of the filler order number- entity identifier."`
FillerOrderNumberNamespaceID IS `` /* 180-byte string literal not displayed */
SequenceConditionValue ST `` /* 157-byte string literal not displayed */
MaximumNumberOfRepeats NM `` /* 224-byte string literal not displayed */
PlacerOrderNumberUniversalID ST `hl7:"8,required,len=15,display=Contains the next to the last component of the placer order number- universal ID."`
PlacerOrderNumberUniversalIDType ID `` /* 150-byte string literal not displayed */
FillerOrderNumberUniversalID ST `hl7:"10,required,len=15,display=Contains the next to the last component of the filler order number- universal ID."`
FillerOrderNumberUniversalIDType ID `` /* 151-byte string literal not displayed */
}
Order Sequence Definition
This data type specifies a fully coded version for forming a relationship between an order and one or more other orders. The relationship may be sequential or a cyclical pattern.
type OSP ¶
type OSP struct {
HL7 HL7Name `hl7:",name=OSP,len=723,type=d"`
OccurrenceSpanCode CNE `` /* 129-byte string literal not displayed */
OccurrenceSpanStartDate DT `` /* 162-byte string literal not displayed */
OccurrenceSpanStopDate DT `` /* 160-byte string literal not displayed */
}
Occurrence Span Code and Date
A code and the related dates that identify an event that relates to the payment of the claim. For example, Prior Stay Dates which is the from/through dates given by the patient of any hospital stay that ended within 60 days of this hospital or SNF admission.
type OSQ_Q06 ¶
type OSQ_Q06 struct {
HL7 HL7Name `hl7:",name=OSQ_Q06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query for Order Status
The OSQ message is a record-oriented query that has the structure as the regular QRY message. OSQ is included here for the convenience of implementers.
type OSR_Q06 ¶
type OSR_Q06 struct {
HL7 HL7Name `hl7:",name=OSR_Q06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"8,display=Original style query filter"`
Response *OSR_Q06_Response `hl7:",display=Response"`
DSC *DSC `hl7:"22,display=Continuation Pointer"`
}
Query Response for Order Status
The function of this message is to respond to an OSQ message. The OSQ message is a record-oriented query that has the structure as the regular QRY message. OSQ is included here for the convenience of implementers.
type OSR_Q06_Order ¶
type OSR_Q06_Order struct {
HL7 HL7Name `hl7:",name=OSR_Q06_Order,type=tg"`
ORC *ORC `hl7:"11,required,display=Common Order"`
Timing []OSR_Q06_Timing `hl7:",display=Timing"`
OrderDetailSegment *OSR_Q06_OrderDetailSegment `hl7:",display=Order Detail Segment"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
CTI []CTI `hl7:"21,display=Clinical Trial Identification"`
}
Order
type OSR_Q06_OrderDetailSegment ¶
type OSR_Q06_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=OSR_Q06_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"14,conditional,display=Observation Request"`
RQD *RQD `hl7:"15,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"16,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"17,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"18,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"19,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type OSR_Q06_Patient ¶
type OSR_Q06_Patient struct {
HL7 HL7Name `hl7:",name=OSR_Q06_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NTE []NTE `hl7:"10,display=Notes and Comments"`
}
Patient
type OSR_Q06_Response ¶
type OSR_Q06_Response struct {
HL7 HL7Name `hl7:",name=OSR_Q06_Response,type=tg"`
Patient *OSR_Q06_Patient `hl7:",display=Patient"`
Order []OSR_Q06_Order `hl7:",required,display=Order"`
}
Response
type OSR_Q06_Timing ¶
type OSR_Q06_Timing struct {
HL7 HL7Name `hl7:",name=OSR_Q06_Timing,type=tg"`
TQ1 *TQ1 `hl7:"12,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"13,display=Timing/Quantity Relationship"`
}
Timing
type OUL_R21 ¶
type OUL_R21 struct {
HL7 HL7Name `hl7:",name=OUL_R21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
NTE *NTE `hl7:"3,display=Notes and Comments"`
Patient *OUL_R21_Patient `hl7:",display=Patient"`
OrderObservation []OUL_R21_OrderObservation `hl7:",required,display=Order Observation"`
DSC *DSC `hl7:"21,display=Continuation Pointer"`
}
Unsolicited laboratory observation
This message is kept here for backward compatibility reasons only. The new OUL messages with additional triggers should be used, when the Specimen information (segment SPM) with or without Container information (segment SAC) is required.
This message was designed to accommodate laboratory automation systems.
type OUL_R21_Container ¶
type OUL_R21_Container struct {
HL7 HL7Name `hl7:",name=OUL_R21_Container,type=tg"`
SAC *SAC `hl7:"9,required,display=Specimen Container Detail"`
SID *SID `hl7:"10,display=Substance Identifier"`
}
Container
type OUL_R21_Observation ¶
type OUL_R21_Observation struct {
HL7 HL7Name `hl7:",name=OUL_R21_Observation,type=tg"`
OBX *OBX `hl7:"16,display=Observation/Result"`
TCD *TCD `hl7:"17,display=Test Code Detail"`
SID []SID `hl7:"18,display=Substance Identifier"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
Observation
type OUL_R21_OrderObservation ¶
type OUL_R21_OrderObservation struct {
HL7 HL7Name `hl7:",name=OUL_R21_OrderObservation,type=tg"`
Container *OUL_R21_Container `hl7:",display=Container"`
ORC *ORC `hl7:"11,display=Common Order"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
TimingQty []OUL_R21_TimingQty `hl7:",display=Timing Qty"`
Observation []OUL_R21_Observation `hl7:",required,display=Observation"`
CTI []CTI `hl7:"20,display=Clinical Trial Identification"`
}
OrderObservation
type OUL_R21_Patient ¶
type OUL_R21_Patient struct {
HL7 HL7Name `hl7:",name=OUL_R21_Patient,type=tg"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Visit *OUL_R21_Visit `hl7:",display=Visit"`
}
Patient
type OUL_R21_TimingQty ¶
type OUL_R21_TimingQty struct {
HL7 HL7Name `hl7:",name=OUL_R21_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingQty
type OUL_R21_Visit ¶
type OUL_R21_Visit struct {
HL7 HL7Name `hl7:",name=OUL_R21_Visit,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Visit
type OUL_R22 ¶
type OUL_R22 struct {
HL7 HL7Name `hl7:",name=OUL_R22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE *NTE `hl7:"4,display=Notes and Comments"`
Patient *OUL_R22_Patient `hl7:",display=Patient"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
Specimen []OUL_R22_Specimen `hl7:",required,display=Specimen"`
DSC *DSC `hl7:"27,display=Continuation Pointer"`
}
Unsolicited Specimen Oriented Observation
This message was designed to accommodate specimen oriented testing. It should be applicable to container-less testing (e.g., elephant on a table) and laboratory automation systems requiring container.
Generally this construct allows transfer of multiple results related to a specimen from a patient, where this specimen has been in none, one, or multiple containers.
type OUL_R22_Container ¶
type OUL_R22_Container struct {
HL7 HL7Name `hl7:",name=OUL_R22_Container,type=tg"`
SAC *SAC `hl7:"14,required,display=Specimen Container Detail"`
INV *INV `hl7:"15,display=Inventory Detail"`
}
Container
type OUL_R22_Order ¶
type OUL_R22_Order struct {
HL7 HL7Name `hl7:",name=OUL_R22_Order,type=tg"`
OBR *OBR `hl7:"16,required,display=Observation Request"`
ORC *ORC `hl7:"17,display=Common Order"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
ROL []ROL `hl7:"19,display=Role"`
TimingQty []OUL_R22_TimingQty `hl7:",display=Timing Qty"`
Result []OUL_R22_Result `hl7:",display=Result"`
CTI []CTI `hl7:"26,display=Clinical Trial Identification"`
}
Order
type OUL_R22_Patient ¶
type OUL_R22_Patient struct {
HL7 HL7Name `hl7:",name=OUL_R22_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
OBX []OBX `hl7:"8,display=Observation/Result"`
Visit *OUL_R22_Visit `hl7:",display=Visit"`
}
Patient
type OUL_R22_Result ¶
type OUL_R22_Result struct {
HL7 HL7Name `hl7:",name=OUL_R22_Result,type=tg"`
OBX *OBX `hl7:"22,required,display=Observation/Result"`
TCD *TCD `hl7:"23,display=Test Code Detail"`
SID []SID `hl7:"24,display=Substance Identifier"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Result
type OUL_R22_Specimen ¶
type OUL_R22_Specimen struct {
HL7 HL7Name `hl7:",name=OUL_R22_Specimen,type=tg"`
SPM *SPM `hl7:"12,required,display=Specimen"`
OBX []OBX `hl7:"13,display=Observation/Result"`
Container []OUL_R22_Container `hl7:",display=Container"`
Order []OUL_R22_Order `hl7:",required,display=Order"`
}
Specimen
type OUL_R22_TimingQty ¶
type OUL_R22_TimingQty struct {
HL7 HL7Name `hl7:",name=OUL_R22_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"20,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"21,display=Timing/Quantity Relationship"`
}
TimingQty
type OUL_R22_Visit ¶
type OUL_R22_Visit struct {
HL7 HL7Name `hl7:",name=OUL_R22_Visit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Visit
type OUL_R23 ¶
type OUL_R23 struct {
HL7 HL7Name `hl7:",name=OUL_R23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE *NTE `hl7:"4,display=Notes and Comments"`
Patient *OUL_R23_Patient `hl7:",display=Patient"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
Specimen []OUL_R23_Specimen `hl7:",required,display=Specimen"`
DSC *DSC `hl7:"27,display=Continuation Pointer"`
}
Unsolicited Specimen Container Oriented Observation
This message was designed to accommodate specimen oriented testing. It should be applicable to, for example, laboratory automation systems requiring container.
Generally this construct allows transfer of multiple results related to one or more specific containers with one or more specimens from a patient.
type OUL_R23_Container ¶
type OUL_R23_Container struct {
HL7 HL7Name `hl7:",name=OUL_R23_Container,type=tg"`
SAC *SAC `hl7:"14,required,display=Specimen Container Detail"`
INV *INV `hl7:"15,display=Inventory Detail"`
Order []OUL_R23_Order `hl7:",required,display=Order"`
}
Container
type OUL_R23_Order ¶
type OUL_R23_Order struct {
HL7 HL7Name `hl7:",name=OUL_R23_Order,type=tg"`
OBR *OBR `hl7:"16,required,display=Observation Request"`
ORC *ORC `hl7:"17,display=Common Order"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
ROL []ROL `hl7:"19,display=Role"`
TimingQty []OUL_R23_TimingQty `hl7:",display=Timing Qty"`
Result []OUL_R23_Result `hl7:",display=Result"`
CTI []CTI `hl7:"26,display=Clinical Trial Identification"`
}
Order
type OUL_R23_Patient ¶
type OUL_R23_Patient struct {
HL7 HL7Name `hl7:",name=OUL_R23_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
OBX []OBX `hl7:"8,display=Observation/Result"`
Visit *OUL_R23_Visit `hl7:",display=Visit"`
}
Patient
type OUL_R23_Result ¶
type OUL_R23_Result struct {
HL7 HL7Name `hl7:",name=OUL_R23_Result,type=tg"`
OBX *OBX `hl7:"22,required,display=Observation/Result"`
TCD *TCD `hl7:"23,display=Test Code Detail"`
SID []SID `hl7:"24,display=Substance Identifier"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Result
type OUL_R23_Specimen ¶
type OUL_R23_Specimen struct {
HL7 HL7Name `hl7:",name=OUL_R23_Specimen,type=tg"`
SPM *SPM `hl7:"12,required,display=Specimen"`
OBX []OBX `hl7:"13,display=Observation/Result"`
Container []OUL_R23_Container `hl7:",required,display=Container"`
}
Specimen
type OUL_R23_TimingQty ¶
type OUL_R23_TimingQty struct {
HL7 HL7Name `hl7:",name=OUL_R23_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"20,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"21,display=Timing/Quantity Relationship"`
}
TimingQty
type OUL_R23_Visit ¶
type OUL_R23_Visit struct {
HL7 HL7Name `hl7:",name=OUL_R23_Visit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Visit
type OUL_R24 ¶
type OUL_R24 struct {
HL7 HL7Name `hl7:",name=OUL_R24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE *NTE `hl7:"4,display=Notes and Comments"`
Patient *OUL_R24_Patient `hl7:",display=Patient"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
Order []OUL_R24_Order `hl7:",required,display=Order"`
DSC *DSC `hl7:"27,display=Continuation Pointer"`
}
Unsolicited Order Oriented Observation
This message was designed to accommodate multi-specimen oriented testing. It should be applicable to, e.g., laboratory automation systems requiring container.
Generally this construct allows transfer of multiple results, each one related to none, one or more specific containers with one or more specimens from a patient.
type OUL_R24_Container ¶
type OUL_R24_Container struct {
HL7 HL7Name `hl7:",name=OUL_R24_Container,type=tg"`
SAC *SAC `hl7:"20,required,display=Specimen Container Detail"`
INV *INV `hl7:"21,display=Inventory Detail"`
}
Container
type OUL_R24_Order ¶
type OUL_R24_Order struct {
HL7 HL7Name `hl7:",name=OUL_R24_Order,type=tg"`
OBR *OBR `hl7:"12,required,display=Observation Request"`
ORC *ORC `hl7:"13,display=Common Order"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
ROL []ROL `hl7:"15,display=Role"`
TimingQty []OUL_R24_TimingQty `hl7:",display=Timing Qty"`
Specimen []OUL_R24_Specimen `hl7:",display=Specimen"`
Result []OUL_R24_Result `hl7:",display=Result"`
CTI []CTI `hl7:"26,display=Clinical Trial Identification"`
}
Order
type OUL_R24_Patient ¶
type OUL_R24_Patient struct {
HL7 HL7Name `hl7:",name=OUL_R24_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
OBX []OBX `hl7:"8,display=Observation/Result"`
Visit *OUL_R24_Visit `hl7:",display=Visit"`
}
Patient
type OUL_R24_Result ¶
type OUL_R24_Result struct {
HL7 HL7Name `hl7:",name=OUL_R24_Result,type=tg"`
OBX *OBX `hl7:"22,required,display=Observation/Result"`
TCD *TCD `hl7:"23,display=Test Code Detail"`
SID []SID `hl7:"24,display=Substance Identifier"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Result
type OUL_R24_Specimen ¶
type OUL_R24_Specimen struct {
HL7 HL7Name `hl7:",name=OUL_R24_Specimen,type=tg"`
SPM *SPM `hl7:"18,required,display=Specimen"`
OBX []OBX `hl7:"19,display=Observation/Result"`
Container []OUL_R24_Container `hl7:",display=Container"`
}
Specimen
type OUL_R24_TimingQty ¶
type OUL_R24_TimingQty struct {
HL7 HL7Name `hl7:",name=OUL_R24_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
TimingQty
type OUL_R24_Visit ¶
type OUL_R24_Visit struct {
HL7 HL7Name `hl7:",name=OUL_R24_Visit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
Visit
type OVR ¶
type OVR struct {
HL7 HL7Name `hl7:",name=OVR,type=s"`
BusinessRuleOverrideType *CWE `hl7:"1,len=705,table=0518,display=Business Rule Override Type"`
BusinessRuleOverrideCode *CWE `hl7:"2,len=705,table=0521,display=Business Rule Override Code"`
OverrideComments TX `hl7:"3,len=200,display=Override Comments"`
OverrideEnteredBy *XCN `hl7:"4,len=250,display=Override Entered By"`
OverrideAuthorizedBy *XCN `hl7:"5,len=250,display=Override Authorized By"`
}
Override Segment
Definition: This segment allows a sender to override specific receiving application's business rules to allow for processing of a message that would normally be rejected or ignored.
Example: MSH PID PV1 {ORC RXE {RXR} RXD {RXR} <RXC> <NTE> <FT1> <OVR>}
type PCE ¶
type PCE struct {
HL7 HL7Name `hl7:",name=PCE,type=s"`
SetID SI `hl7:"1,seq,required,len=2,display=Set ID – PCE"`
CostCenterAccountNumber IS `hl7:"2,len=30,table=0319,display=Cost Center Account Number"`
TransactionCode *CWE `hl7:"3,len=250,table=0132,display=Transaction Code"`
TransactionAmountUnit *CP `hl7:"4,len=12,display=Transaction Amount - Unit"`
}
Patient Charge Cost Center Exception
The Patient Charge Cost Center Exception segment identifies the Patient Price associated with Cost Center and Patient Charge Identifier combinations that should be used in an instance that the item is billed to a patient. The grouping of Cost Center accounts, Patient Charge Identifier, and Patient Price is unique.
type PCR ¶
type PCR struct {
HL7 HL7Name `hl7:",name=PCR,type=s"`
ImplicatedProduct CWE `hl7:"1,required,len=705,display=Implicated Product"`
GenericProduct IS `hl7:"2,len=1,table=0249,display=Generic Product"`
ProductClass *CWE `hl7:"3,len=705,display=Product Class"`
TotalDurationOfTherapy *CQ `hl7:"4,len=500,display=Total Duration Of Therapy"`
ProductManufactureDate DTM `hl7:"5,len=24,format=YMDHM,display=Product Manufacture Date"`
ProductExpirationDate DTM `hl7:"6,len=24,format=YMDHM,display=Product Expiration Date"`
ProductImplantationDate DTM `hl7:"7,len=24,format=YMDHM,display=Product Implantation Date"`
ProductExplantationDate DTM `hl7:"8,len=24,format=YMDHM,display=Product Explantation Date"`
SingleUseDevice IS `hl7:"9,len=8,table=0244,display=Single Use Device"`
IndicationForProductUse *CWE `hl7:"10,len=705,display=Indication For Product Use"`
ProductProblem IS `hl7:"11,len=8,table=0245,display=Product Problem"`
ProductSerialLotNumber []ST `hl7:"12,max=3,len=199,display=Product Serial/Lot Number"`
ProductAvailableForInspection IS `hl7:"13,len=1,table=0246,display=Product Available For Inspection"`
ProductEvaluationPerformed *CWE `hl7:"14,len=705,display=Product Evaluation Performed"`
ProductEvaluationStatus *CWE `hl7:"15,len=705,table=0247,display=Product Evaluation Status"`
ProductEvaluationResults *CWE `hl7:"16,len=705,display=Product Evaluation Results"`
EvaluatedProductSource ID `hl7:"17,len=8,table=0248,display=Evaluated Product Source"`
DateProductReturnedToManufacturer DTM `hl7:"18,len=24,format=YMDHM,display=Date Product Returned To Manufacturer"`
DeviceOperatorQualifications ID `hl7:"19,len=1,table=0242,display=Device Operator Qualifications"`
RelatednessAssessment ID `hl7:"20,len=1,table=0250,display=Relatedness Assessment"`
ActionTakenInResponseToTheEvent []ID `hl7:"21,max=6,len=2,table=0251,display=Action Taken In Response To The Event"`
EventCausalityObservations []ID `hl7:"22,max=6,len=2,table=0252,display=Event Causality Observations"`
IndirectExposureMechanism []ID `hl7:"23,max=3,len=1,table=0253,display=Indirect Exposure Mechanism"`
}
Possible Causal Relationship
The PCR segment is used to communicate a potential or suspected relationship between a product (drug or device) or test and an event with detrimental effect on a patient. This segment identifies a potential causal relationship between the product identified in this segment and the event identified in the PEO segment.
type PD1 ¶
type PD1 struct {
HL7 HL7Name `hl7:",name=PD1,type=s"`
LivingDependency []IS `hl7:"1,len=2,table=0223,display=Living Dependency"`
LivingArrangement IS `hl7:"2,len=2,table=0220,display=Living Arrangement"`
PatientPrimaryFacility []XON `hl7:"3,len=250,table=0204,display=Patient Primary Facility"`
PatientPrimaryCareProviderNameAndIDNo []XCN `hl7:"4,len=250,display=Patient Primary Care Provider Name and ID No."`
StudentIndicator IS `hl7:"5,len=2,table=0231,display=Student Indicator"`
Handicap IS `hl7:"6,len=2,table=0295,display=Handicap"`
LivingWillCode IS `hl7:"7,len=2,table=0315,display=Living Will Code"`
OrganDonorCode IS `hl7:"8,len=2,table=0316,display=Organ Donor Code"`
SeparateBill ID `hl7:"9,len=1,table=0136,display=Separate Bill"`
DuplicatePatient []CX `hl7:"10,len=250,display=Duplicate Patient"`
PublicityCode *CWE `hl7:"11,len=705,table=0215,display=Publicity Code"`
ProtectionIndicator ID `hl7:"12,len=1,table=0136,display=Protection Indicator"`
ProtectionIndicatorEffectiveDate DT `hl7:"13,len=8,format=YMD,display=Protection Indicator Effective Date"`
PlaceOfWorship []XON `hl7:"14,len=250,display=Place of Worship"`
AdvanceDirectiveCode []CWE `hl7:"15,conditional,len=705,table=0435,display=Advance Directive Code"`
ImmunizationRegistryStatus IS `hl7:"16,len=1,table=0441,display=Immunization Registry Status"`
ImmunizationRegistryStatusEffectiveDate DT `hl7:"17,len=8,format=YMD,display=Immunization Registry Status Effective Date"`
PublicityCodeEffectiveDate DT `hl7:"18,len=8,format=YMD,display=Publicity Code Effective Date"`
MilitaryBranch IS `hl7:"19,len=5,table=0140,display=Military Branch"`
MilitaryRankGrade IS `hl7:"20,len=2,table=0141,display=Military Rank/Grade"`
MilitaryStatus IS `hl7:"21,len=3,table=0142,display=Military Status"`
AdvanceDirectiveLastVerifiedDate DT `hl7:"22,len=8,format=YMD,display=Advance Directive Last Verified Date"`
}
Patient Additional Demographic
The patient additional demographic segment contains demographic information that is likely to change about the patient.
type PDA ¶
type PDA struct {
HL7 HL7Name `hl7:",name=PDA,type=s"`
DeathCauseCode []CWE `hl7:"1,len=705,display=Death Cause Code"`
DeathLocation *PL `hl7:"2,len=80,display=Death Location"`
DeathCertifiedIndicator ID `hl7:"3,len=1,table=0136,display=Death Certified Indicator"`
DeathCertificateSignedDateTime DTM `hl7:"4,len=24,format=YMDHM,display=Death Certificate Signed Date/Time"`
DeathCertifiedBy *XCN `hl7:"5,len=250,display=Death Certified By"`
AutopsyIndicator ID `hl7:"6,len=1,table=0136,display=Autopsy Indicator"`
AutopsyStartAndEndDateTime *DR `hl7:"7,len=53,display=Autopsy Start and End Date/Time"`
AutopsyPerformedBy *XCN `hl7:"8,len=250,display=Autopsy Performed By"`
CoronerIndicator ID `hl7:"9,len=1,table=0136,display=Coroner Indicator"`
}
Patient Death and Autopsy
This segment carries information on a patient's death and possible autopsy.
type PDC ¶
type PDC struct {
HL7 HL7Name `hl7:",name=PDC,type=s"`
ManufacturerDistributor []XON `hl7:"1,required,len=570,display=Manufacturer/Distributor"`
Country CWE `hl7:"2,required,len=705,display=Country"`
BrandName ST `hl7:"3,required,len=60,display=Brand Name"`
DeviceFamilyName ST `hl7:"4,len=60,display=Device Family Name"`
GenericName *CWE `hl7:"5,len=705,display=Generic Name"`
ModelIdentifier []ST `hl7:"6,len=60,display=Model Identifier"`
CatalogueIdentifier ST `hl7:"7,len=60,display=Catalogue Identifier"`
OtherIdentifier []ST `hl7:"8,len=60,display=Other Identifier"`
ProductCode *CWE `hl7:"9,len=705,display=Product Code"`
MarketingBasis ID `hl7:"10,len=4,table=0330,display=Marketing Basis"`
MarketingApprovalID ST `hl7:"11,len=60,display=Marketing Approval ID"`
LabeledShelfLife *CQ `hl7:"12,len=722,display=Labeled Shelf Life"`
ExpectedShelfLife *CQ `hl7:"13,len=722,display=Expected Shelf Life"`
DateFirstMarketed DTM `hl7:"14,len=24,format=YMDHM,display=Date First Marketed"`
DateLastMarketed DTM `hl7:"15,len=24,format=YMDHM,display=Date Last Marketed"`
}
Product Detail Country
type PEO ¶
type PEO struct {
HL7 HL7Name `hl7:",name=PEO,type=s"`
EventIdentifiersUsed []CWE `hl7:"1,len=705,display=Event Identifiers Used"`
EventSymptomDiagnosisCode []CWE `hl7:"2,len=705,display=Event Symptom/Diagnosis Code"`
EventOnsetDateTime DTM `hl7:"3,required,len=24,format=YMDHM,display=Event Onset Date/Time"`
EventExacerbationDateTime DTM `hl7:"4,len=24,format=YMDHM,display=Event Exacerbation Date/Time"`
EventImprovedDateTime DTM `hl7:"5,len=24,format=YMDHM,display=Event Improved Date/Time"`
EventEndedDataTime DTM `hl7:"6,len=24,format=YMDHM,display=Event Ended Data/Time"`
EventLocationOccurredAddress []XAD `hl7:"7,len=2915,display=Event Location Occurred Address"`
EventQualification []ID `hl7:"8,len=1,table=0237,display=Event Qualification"`
EventSerious ID `hl7:"9,len=1,table=0238,display=Event Serious"`
EventExpected ID `hl7:"10,len=1,table=0239,display=Event Expected"`
EventOutcome []ID `hl7:"11,len=1,table=0240,display=Event Outcome"`
PatientOutcome ID `hl7:"12,len=1,table=0241,display=Patient Outcome"`
EventDescriptionFromOthers []FT `hl7:"13,len=600,display=Event Description From Others"`
EventDescriptionFromOriginalReporter []FT `hl7:"14,len=600,display=Event Description From Original Reporter"`
EventDescriptionFromPatient []FT `hl7:"15,len=600,display=Event Description From Patient"`
EventDescriptionFromPractitioner []FT `hl7:"16,len=600,display=Event Description From Practitioner"`
EventDescriptionFromAutopsy []FT `hl7:"17,len=600,display=Event Description From Autopsy"`
CauseOfDeath []CWE `hl7:"18,len=705,display=Cause Of Death"`
PrimaryObserverName []XPN `hl7:"19,len=1317,display=Primary Observer Name"`
PrimaryObserverAddress []XAD `hl7:"20,len=2915,display=Primary Observer Address"`
PrimaryObserverTelephone []XTN `hl7:"21,len=2743,display=Primary Observer Telephone"`
PrimaryObserversQualification ID `hl7:"22,len=1,table=0242,display=Primary Observer's Qualification"`
ConfirmationProvidedBy ID `hl7:"23,len=1,table=0242,display=Confirmation Provided By"`
PrimaryObserverAwareDateTime DTM `hl7:"24,len=24,format=YMDHM,display=Primary Observer Aware Date/Time"`
PrimaryObserversIdentityMayBeDivulged ID `hl7:"25,len=1,table=0243,display=Primary Observer's Identity May Be Divulged"`
}
Product Experience Observation
Details related to a particular clinical experience or event are embodied in the PEO segment. This segment can be used to characterize an event which might be attributed to a product to which the patient was exposed. Products with a possible causal relationship to the observed experience are described in the following PCR (possible causal relationship) segments. The message format was designed to be robust and includes many optional elements which may not be required for a particular regulatory purpose but allow a complete representation of the drug experience if needed.
type PES ¶
type PES struct {
HL7 HL7Name `hl7:",name=PES,type=s"`
SenderOrganizationName []XON `hl7:"1,len=567,display=Sender Organization Name"`
SenderIndividualName []XCN `hl7:"2,len=3220,display=Sender Individual Name"`
SenderAddress []XAD `hl7:"3,len=2915,display=Sender Address"`
SenderTelephone []XTN `hl7:"4,len=2743,display=Sender Telephone"`
SenderEventIdentifier *EI `hl7:"5,len=427,display=Sender Event Identifier"`
SenderSequenceNumber NM `hl7:"6,len=16,display=Sender Sequence Number"`
SenderEventDescription []FT `hl7:"7,len=600,display=Sender Event Description"`
SenderComment FT `hl7:"8,len=600,display=Sender Comment"`
SenderAwareDateTime DTM `hl7:"9,len=24,format=YMDHM,display=Sender Aware Date/Time"`
EventReportDate DTM `hl7:"10,required,len=24,format=YMDHM,display=Event Report Date"`
EventReportTimingType []ID `hl7:"11,max=2,len=3,table=0234,display=Event Report Timing/Type"`
EventReportSource ID `hl7:"12,len=1,table=0235,display=Event Report Source"`
EventReportedTo []ID `hl7:"13,len=1,table=0236,display=Event Reported To"`
}
Product Experience Sender
type PEX_P07 ¶
type PEX_P07 struct {
HL7 HL7Name `hl7:",name=PEX_P07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
Visit *PEX_P07_Visit `hl7:",display=Visit"`
Experience []PEX_P07_Experience `hl7:",required,display=Experience"`
}
Unsolicited Initial Individual Product Experience Report
The primary application of this message is to transfer information related to an adverse event occurring while a patient was exposed to a product.
type PEX_P07_AssociatedPerson ¶
type PEX_P07_AssociatedPerson struct {
HL7 HL7Name `hl7:",name=PEX_P07_AssociatedPerson,type=tg"`
NK1 *NK1 `hl7:"22,required,display=Next of Kin / Associated Parties"`
AssociatedRxOrder *PEX_P07_AssociatedRxOrder `hl7:",display=Associated Rx Order"`
AssociatedRxAdmin []PEX_P07_AssociatedRxAdmin `hl7:",display=Associated Rx Admin"`
PRB []PRB `hl7:"29,display=Problem Details"`
OBX []OBX `hl7:"30,display=Observation/Result"`
}
AssociatedPerson
type PEX_P07_AssociatedRxAdmin ¶
type PEX_P07_AssociatedRxAdmin struct {
HL7 HL7Name `hl7:",name=PEX_P07_AssociatedRxAdmin,type=tg"`
RXA *RXA `hl7:"27,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"28,display=Pharmacy/Treatment Route"`
}
AssociatedRxAdmin
type PEX_P07_AssociatedRxOrder ¶
type PEX_P07_AssociatedRxOrder struct {
HL7 HL7Name `hl7:",name=PEX_P07_AssociatedRxOrder,type=tg"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
Nk1TimingQty []PEX_P07_Nk1TimingQty `hl7:",required,display=Nk1 Timing Qty"`
RXR []RXR `hl7:"26,display=Pharmacy/Treatment Route"`
}
AssociatedRxOrder
type PEX_P07_Experience ¶
type PEX_P07_Experience struct {
HL7 HL7Name `hl7:",name=PEX_P07_Experience,type=tg"`
PES *PES `hl7:"10,required,display=Product Experience Sender"`
PexObservation []PEX_P07_PexObservation `hl7:",required,display=Pex Observation"`
}
Experience
type PEX_P07_Nk1TimingQty ¶
type PEX_P07_Nk1TimingQty struct {
HL7 HL7Name `hl7:",name=PEX_P07_Nk1TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
Nk1TimingQty
type PEX_P07_PexCause ¶
type PEX_P07_PexCause struct {
HL7 HL7Name `hl7:",name=PEX_P07_PexCause,type=tg"`
PCR *PCR `hl7:"12,required,display=Possible Causal Relationship"`
RxOrder *PEX_P07_RxOrder `hl7:",display=Rx Order"`
RxAdministration []PEX_P07_RxAdministration `hl7:",display=Rx Administration"`
PRB []PRB `hl7:"19,display=Problem Details"`
OBX []OBX `hl7:"20,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
AssociatedPerson *PEX_P07_AssociatedPerson `hl7:",display=Associated Person"`
Study []PEX_P07_Study `hl7:",display=Study"`
}
PexCause
type PEX_P07_PexObservation ¶
type PEX_P07_PexObservation struct {
HL7 HL7Name `hl7:",name=PEX_P07_PexObservation,type=tg"`
PEO *PEO `hl7:"11,required,display=Product Experience Observation"`
PexCause []PEX_P07_PexCause `hl7:",required,display=Pex Cause"`
}
PexObservation
type PEX_P07_RxAdministration ¶
type PEX_P07_RxAdministration struct {
HL7 HL7Name `hl7:",name=PEX_P07_RxAdministration,type=tg"`
RXA *RXA `hl7:"17,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"18,display=Pharmacy/Treatment Route"`
}
RxAdministration
type PEX_P07_RxOrder ¶
type PEX_P07_RxOrder struct {
HL7 HL7Name `hl7:",name=PEX_P07_RxOrder,type=tg"`
RXE *RXE `hl7:"13,required,display=Pharmacy/Treatment Encoded Order"`
TimingQty []PEX_P07_TimingQty `hl7:",required,display=Timing Qty"`
RXR []RXR `hl7:"16,display=Pharmacy/Treatment Route"`
}
RxOrder
type PEX_P07_Study ¶
type PEX_P07_Study struct {
HL7 HL7Name `hl7:",name=PEX_P07_Study,type=tg"`
CSR *CSR `hl7:"31,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"32,display=Clinical Study Phase"`
}
Study
type PEX_P07_TimingQty ¶
type PEX_P07_TimingQty struct {
HL7 HL7Name `hl7:",name=PEX_P07_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingQty
type PEX_P07_Visit ¶
type PEX_P07_Visit struct {
HL7 HL7Name `hl7:",name=PEX_P07_Visit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
Visit
type PEX_P08 ¶
type PEX_P08 struct {
HL7 HL7Name `hl7:",name=PEX_P08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
Visit *PEX_P08_Visit `hl7:",display=Visit"`
Experience []PEX_P08_Experience `hl7:",required,display=Experience"`
}
Unsolicited Updatel Individual Product Experience Report
The primary application of this message is to transfer information related to an adverse event occurring while a patient was exposed to a product.
type PEX_P08_AssociatedPerson ¶
type PEX_P08_AssociatedPerson struct {
HL7 HL7Name `hl7:",name=PEX_P08_AssociatedPerson,type=tg"`
NK1 *NK1 `hl7:"22,required,display=Next of Kin / Associated Parties"`
AssociatedRxOrder *PEX_P08_AssociatedRxOrder `hl7:",display=Associated Rx Order"`
AssociatedRxAdmin []PEX_P08_AssociatedRxAdmin `hl7:",display=Associated Rx Admin"`
PRB []PRB `hl7:"29,display=Problem Details"`
OBX []OBX `hl7:"30,display=Observation/Result"`
}
AssociatedPerson
type PEX_P08_AssociatedRxAdmin ¶
type PEX_P08_AssociatedRxAdmin struct {
HL7 HL7Name `hl7:",name=PEX_P08_AssociatedRxAdmin,type=tg"`
RXA *RXA `hl7:"27,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"28,display=Pharmacy/Treatment Route"`
}
AssociatedRxAdmin
type PEX_P08_AssociatedRxOrder ¶
type PEX_P08_AssociatedRxOrder struct {
HL7 HL7Name `hl7:",name=PEX_P08_AssociatedRxOrder,type=tg"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
Nk1TimingQty []PEX_P08_Nk1TimingQty `hl7:",required,display=Nk1 Timing Qty"`
RXR []RXR `hl7:"26,display=Pharmacy/Treatment Route"`
}
AssociatedRxOrder
type PEX_P08_Experience ¶
type PEX_P08_Experience struct {
HL7 HL7Name `hl7:",name=PEX_P08_Experience,type=tg"`
PES *PES `hl7:"10,required,display=Product Experience Sender"`
PexObservation []PEX_P08_PexObservation `hl7:",required,display=Pex Observation"`
}
Experience
type PEX_P08_Nk1TimingQty ¶
type PEX_P08_Nk1TimingQty struct {
HL7 HL7Name `hl7:",name=PEX_P08_Nk1TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
Nk1TimingQty
type PEX_P08_PexCause ¶
type PEX_P08_PexCause struct {
HL7 HL7Name `hl7:",name=PEX_P08_PexCause,type=tg"`
PCR *PCR `hl7:"12,required,display=Possible Causal Relationship"`
RxOrder *PEX_P08_RxOrder `hl7:",display=Rx Order"`
RxAdministration []PEX_P08_RxAdministration `hl7:",display=Rx Administration"`
PRB []PRB `hl7:"19,display=Problem Details"`
OBX []OBX `hl7:"20,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
AssociatedPerson *PEX_P08_AssociatedPerson `hl7:",display=Associated Person"`
Study []PEX_P08_Study `hl7:",display=Study"`
}
PexCause
type PEX_P08_PexObservation ¶
type PEX_P08_PexObservation struct {
HL7 HL7Name `hl7:",name=PEX_P08_PexObservation,type=tg"`
PEO *PEO `hl7:"11,required,display=Product Experience Observation"`
PexCause []PEX_P08_PexCause `hl7:",required,display=Pex Cause"`
}
PexObservation
type PEX_P08_RxAdministration ¶
type PEX_P08_RxAdministration struct {
HL7 HL7Name `hl7:",name=PEX_P08_RxAdministration,type=tg"`
RXA *RXA `hl7:"17,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"18,display=Pharmacy/Treatment Route"`
}
RxAdministration
type PEX_P08_RxOrder ¶
type PEX_P08_RxOrder struct {
HL7 HL7Name `hl7:",name=PEX_P08_RxOrder,type=tg"`
RXE *RXE `hl7:"13,required,display=Pharmacy/Treatment Encoded Order"`
TimingQty []PEX_P08_TimingQty `hl7:",required,display=Timing Qty"`
RXR []RXR `hl7:"16,display=Pharmacy/Treatment Route"`
}
RxOrder
type PEX_P08_Study ¶
type PEX_P08_Study struct {
HL7 HL7Name `hl7:",name=PEX_P08_Study,type=tg"`
CSR *CSR `hl7:"31,required,display=Clinical Study Registration"`
CSP []CSP `hl7:"32,display=Clinical Study Phase"`
}
Study
type PEX_P08_TimingQty ¶
type PEX_P08_TimingQty struct {
HL7 HL7Name `hl7:",name=PEX_P08_TimingQty,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingQty
type PEX_P08_Visit ¶
type PEX_P08_Visit struct {
HL7 HL7Name `hl7:",name=PEX_P08_Visit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
Visit
type PGL_PC6 ¶
type PGL_PC6 struct {
HL7 HL7Name `hl7:",name=PGL_PC6,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PGL_PC6_PatientVisit `hl7:",display=Patient Visit"`
Goal []PGL_PC6_Goal `hl7:",required,display=Goal"`
}
Patient Goal Add
This message is used to send goals from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.P
type PGL_PC6_Goal ¶
type PGL_PC6_Goal struct {
HL7 HL7Name `hl7:",name=PGL_PC6_Goal,type=tg"`
GOL *GOL `hl7:"7,required,display=Goal Detail"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
GoalRole []PGL_PC6_GoalRole `hl7:",display=Goal Role"`
Pathway []PGL_PC6_Pathway `hl7:",display=Pathway"`
Observation []PGL_PC6_Observation `hl7:",display=Observation"`
Problem []PGL_PC6_Problem `hl7:",display=Problem"`
Order []PGL_PC6_Order `hl7:",display=Order"`
}
Goal
type PGL_PC6_GoalRole ¶
type PGL_PC6_GoalRole struct {
HL7 HL7Name `hl7:",name=PGL_PC6_GoalRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
GoalRole
type PGL_PC6_Observation ¶
type PGL_PC6_Observation struct {
HL7 HL7Name `hl7:",name=PGL_PC6_Observation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
Observation
type PGL_PC6_Order ¶
type PGL_PC6_Order struct {
HL7 HL7Name `hl7:",name=PGL_PC6_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PGL_PC6_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PGL_PC6_OrderDetail ¶
type PGL_PC6_OrderDetail struct {
HL7 HL7Name `hl7:",name=PGL_PC6_OrderDetail,type=tg"`
OrderDetailSegment *PGL_PC6_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PGL_PC6_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PGL_PC6_OrderDetailSegment ¶
type PGL_PC6_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PGL_PC6_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PGL_PC6_OrderObservation ¶
type PGL_PC6_OrderObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC6_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PGL_PC6_Pathway ¶
type PGL_PC6_Pathway struct {
HL7 HL7Name `hl7:",name=PGL_PC6_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PGL_PC6_PatientVisit ¶
type PGL_PC6_PatientVisit struct {
HL7 HL7Name `hl7:",name=PGL_PC6_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PGL_PC6_Problem ¶
type PGL_PC6_Problem struct {
HL7 HL7Name `hl7:",name=PGL_PC6_Problem,type=tg"`
PRB *PRB `hl7:"16,required,display=Problem Details"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
ProblemRole []PGL_PC6_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PGL_PC6_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PGL_PC6_ProblemObservation ¶
type PGL_PC6_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC6_ProblemObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
ProblemObservation
type PGL_PC6_ProblemRole ¶
type PGL_PC6_ProblemRole struct {
HL7 HL7Name `hl7:",name=PGL_PC6_ProblemRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
ProblemRole
type PGL_PC7 ¶
type PGL_PC7 struct {
HL7 HL7Name `hl7:",name=PGL_PC7,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PGL_PC7_PatientVisit `hl7:",display=Patient Visit"`
Goal []PGL_PC7_Goal `hl7:",required,display=Goal"`
}
Patient Goal Update
This message is used to send goals from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.P
type PGL_PC7_Goal ¶
type PGL_PC7_Goal struct {
HL7 HL7Name `hl7:",name=PGL_PC7_Goal,type=tg"`
GOL *GOL `hl7:"7,required,display=Goal Detail"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
GoalRole []PGL_PC7_GoalRole `hl7:",display=Goal Role"`
Pathway []PGL_PC7_Pathway `hl7:",display=Pathway"`
Observation []PGL_PC7_Observation `hl7:",display=Observation"`
Problem []PGL_PC7_Problem `hl7:",display=Problem"`
Order []PGL_PC7_Order `hl7:",display=Order"`
}
Goal
type PGL_PC7_GoalRole ¶
type PGL_PC7_GoalRole struct {
HL7 HL7Name `hl7:",name=PGL_PC7_GoalRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
GoalRole
type PGL_PC7_Observation ¶
type PGL_PC7_Observation struct {
HL7 HL7Name `hl7:",name=PGL_PC7_Observation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
Observation
type PGL_PC7_Order ¶
type PGL_PC7_Order struct {
HL7 HL7Name `hl7:",name=PGL_PC7_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PGL_PC7_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PGL_PC7_OrderDetail ¶
type PGL_PC7_OrderDetail struct {
HL7 HL7Name `hl7:",name=PGL_PC7_OrderDetail,type=tg"`
OrderDetailSegment *PGL_PC7_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PGL_PC7_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PGL_PC7_OrderDetailSegment ¶
type PGL_PC7_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PGL_PC7_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PGL_PC7_OrderObservation ¶
type PGL_PC7_OrderObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC7_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PGL_PC7_Pathway ¶
type PGL_PC7_Pathway struct {
HL7 HL7Name `hl7:",name=PGL_PC7_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PGL_PC7_PatientVisit ¶
type PGL_PC7_PatientVisit struct {
HL7 HL7Name `hl7:",name=PGL_PC7_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PGL_PC7_Problem ¶
type PGL_PC7_Problem struct {
HL7 HL7Name `hl7:",name=PGL_PC7_Problem,type=tg"`
PRB *PRB `hl7:"16,required,display=Problem Details"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
ProblemRole []PGL_PC7_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PGL_PC7_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PGL_PC7_ProblemObservation ¶
type PGL_PC7_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC7_ProblemObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
ProblemObservation
type PGL_PC7_ProblemRole ¶
type PGL_PC7_ProblemRole struct {
HL7 HL7Name `hl7:",name=PGL_PC7_ProblemRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
ProblemRole
type PGL_PC8 ¶
type PGL_PC8 struct {
HL7 HL7Name `hl7:",name=PGL_PC8,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PGL_PC8_PatientVisit `hl7:",display=Patient Visit"`
Goal []PGL_PC8_Goal `hl7:",required,display=Goal"`
}
Patient Goal Delete
This message is used to send goals from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.P
type PGL_PC8_Goal ¶
type PGL_PC8_Goal struct {
HL7 HL7Name `hl7:",name=PGL_PC8_Goal,type=tg"`
GOL *GOL `hl7:"7,required,display=Goal Detail"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
GoalRole []PGL_PC8_GoalRole `hl7:",display=Goal Role"`
Pathway []PGL_PC8_Pathway `hl7:",display=Pathway"`
Observation []PGL_PC8_Observation `hl7:",display=Observation"`
Problem []PGL_PC8_Problem `hl7:",display=Problem"`
Order []PGL_PC8_Order `hl7:",display=Order"`
}
Goal
type PGL_PC8_GoalRole ¶
type PGL_PC8_GoalRole struct {
HL7 HL7Name `hl7:",name=PGL_PC8_GoalRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
GoalRole
type PGL_PC8_Observation ¶
type PGL_PC8_Observation struct {
HL7 HL7Name `hl7:",name=PGL_PC8_Observation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
Observation
type PGL_PC8_Order ¶
type PGL_PC8_Order struct {
HL7 HL7Name `hl7:",name=PGL_PC8_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PGL_PC8_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PGL_PC8_OrderDetail ¶
type PGL_PC8_OrderDetail struct {
HL7 HL7Name `hl7:",name=PGL_PC8_OrderDetail,type=tg"`
OrderDetailSegment *PGL_PC8_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PGL_PC8_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PGL_PC8_OrderDetailSegment ¶
type PGL_PC8_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PGL_PC8_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PGL_PC8_OrderObservation ¶
type PGL_PC8_OrderObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC8_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PGL_PC8_Pathway ¶
type PGL_PC8_Pathway struct {
HL7 HL7Name `hl7:",name=PGL_PC8_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PGL_PC8_PatientVisit ¶
type PGL_PC8_PatientVisit struct {
HL7 HL7Name `hl7:",name=PGL_PC8_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PGL_PC8_Problem ¶
type PGL_PC8_Problem struct {
HL7 HL7Name `hl7:",name=PGL_PC8_Problem,type=tg"`
PRB *PRB `hl7:"16,required,display=Problem Details"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
ProblemRole []PGL_PC8_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PGL_PC8_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PGL_PC8_ProblemObservation ¶
type PGL_PC8_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PGL_PC8_ProblemObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
ProblemObservation
type PGL_PC8_ProblemRole ¶
type PGL_PC8_ProblemRole struct {
HL7 HL7Name `hl7:",name=PGL_PC8_ProblemRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
ProblemRole
type PID ¶
type PID struct {
HL7 HL7Name `hl7:",name=PID,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - PID"`
PatientID CX `hl7:"2,len=20,display=Patient ID"`
PatientIdentifierList []CX `hl7:"3,required,len=250,display=Patient Identifier List"`
AlternatePatientID []CX `hl7:"4,len=20,display=Alternate Patient ID - PID"`
PatientName []XPN `hl7:"5,required,len=250,display=Patient Name"`
MothersMaidenName []XPN `hl7:"6,len=250,display=Mother's Maiden Name"`
DateTimeOfBirth DTM `hl7:"7,len=24,format=YMDHM,display=Date/Time of Birth"`
AdministrativeSex IS `hl7:"8,len=1,table=0001,display=Administrative Sex"`
PatientAlias []XPN `hl7:"9,len=250,display=Patient Alias"`
Race []CWE `hl7:"10,len=705,table=0005,display=Race"`
PatientAddress []XAD `hl7:"11,len=250,display=Patient Address"`
CountyCode IS `hl7:"12,len=4,table=0289,display=County Code"`
PhoneNumberHome []XTN `hl7:"13,len=250,display=Phone Number - Home"`
PhoneNumberBusiness []XTN `hl7:"14,len=250,display=Phone Number - Business"`
PrimaryLanguage *CWE `hl7:"15,len=705,table=0296,display=Primary Language"`
MaritalStatus *CWE `hl7:"16,len=705,table=0002,display=Marital Status"`
Religion *CWE `hl7:"17,len=705,table=0006,display=Religion"`
PatientAccountNumber *CX `hl7:"18,len=250,display=Patient Account Number"`
SSNNumberPatient ST `hl7:"19,len=16,display=SSN Number - Patient"`
DriversLicenseNumberPatient DLN `hl7:"20,len=25,display=Driver's License Number - Patient"`
MothersIdentifier []CX `hl7:"21,len=250,display=Mother's Identifier"`
EthnicGroup []CWE `hl7:"22,len=705,table=0189,display=Ethnic Group"`
BirthPlace ST `hl7:"23,len=250,display=Birth Place"`
MultipleBirthIndicator ID `hl7:"24,len=1,table=0136,display=Multiple Birth Indicator"`
BirthOrder NM `hl7:"25,len=2,display=Birth Order"`
Citizenship []CWE `hl7:"26,len=705,table=0171,display=Citizenship"`
VeteransMilitaryStatus *CWE `hl7:"27,len=705,table=0172,display=Veterans Military Status"`
Nationality CWE `hl7:"28,len=705,table=0212,display=Nationality"`
PatientDeathDateAndTime DTM `hl7:"29,len=24,format=YMDHM,display=Patient Death Date and Time"`
PatientDeathIndicator ID `hl7:"30,len=1,table=0136,display=Patient Death Indicator"`
IdentityUnknownIndicator ID `hl7:"31,len=1,table=0136,display=Identity Unknown Indicator"`
IdentityReliabilityCode []IS `hl7:"32,len=20,table=0445,display=Identity Reliability Code"`
LastUpdateDateTime DTM `hl7:"33,len=24,format=YMDHM,display=Last Update Date/Time"`
LastUpdateFacility *HD `hl7:"34,len=241,display=Last Update Facility"`
SpeciesCode *CWE `hl7:"35,conditional,len=705,table=0446,display=Species Code"`
BreedCode *CWE `hl7:"36,conditional,len=705,table=0447,display=Breed Code"`
Strain ST `hl7:"37,len=80,display=Strain"`
ProductionClassCode []CWE `hl7:"38,max=2,len=705,table=0429,display=Production Class Code"`
TribalCitizenship []CWE `hl7:"39,len=705,table=0171,display=Tribal Citizenship"`
}
Patient Identification
The PID segment is used by all applications as the primary means of communicating patient identification information. This segment contains permanent patient identifying and demographic information that, for the most part, is not likely to change frequently.
type PIN_I07 ¶
type PIN_I07 struct {
HL7 HL7Name `hl7:",name=PIN_I07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Provider []PIN_I07_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"6,required,display=Patient Identification"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
GuarantorInsurance *PIN_I07_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
}
Unsolicited Insurance Information
This trigger event is used by an entity or organization to transmit to a healthcare provider the insurance information on a specific patient. Typically, the healthcare provider will be a primary care provider.
type PIN_I07_GuarantorInsurance ¶
type PIN_I07_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=PIN_I07_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"8,display=Guarantor"`
Insurance []PIN_I07_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type PIN_I07_Insurance ¶
type PIN_I07_Insurance struct {
HL7 HL7Name `hl7:",name=PIN_I07_Insurance,type=tg"`
IN1 *IN1 `hl7:"9,required,display=Insurance"`
IN2 *IN2 `hl7:"10,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"11,display=Insurance Additional Information- Certification"`
}
Insurance
type PIN_I07_Provider ¶
type PIN_I07_Provider struct {
HL7 HL7Name `hl7:",name=PIN_I07_Provider,type=tg"`
PRD *PRD `hl7:"4,required,display=Provider Data"`
CTD []CTD `hl7:"5,display=Contact Data"`
}
Provider
type PIP ¶
type PIP struct {
HL7 HL7Name `hl7:",name=PIP,len=1875,type=d"`
Privilege CWE `` /* 156-byte string literal not displayed */
PrivilegeClass *CWE `` /* 164-byte string literal not displayed */
ExpirationDate DT `hl7:"3,len=8,format=YMD,display=Specifies the date the institutional privilege is/was no longer valid."`
ActivationDate DT `hl7:"4,len=8,format=YMD,display=Specifies the date the institutional privilege became/becomes valid."`
Facility *EI `hl7:"5,len=427,display=Specifies the facility in which the institutional privilege is/was valid."`
}
Practitioner Institutional Privileges
This data type specifies the institutional privileges with associated detail granted to a provider.
type PKG ¶
type PKG struct {
HL7 HL7Name `hl7:",name=PKG,type=s"`
SetID SI `hl7:"1,seq,required,len=2,display=Set Id - PKG"`
PackagingUnits *CWE `hl7:"2,len=250,table=0818,display=Packaging Units"`
DefaultOrderUnitOfMeasureIndicator *CNE `hl7:"3,len=1,table=0532,display=Default Order Unit Of Measure Indicator"`
PackageQuantity NM `hl7:"4,len=12,display=Package Quantity"`
Price *CP `hl7:"5,len=12,display=Price"`
FutureItemPrice *CP `hl7:"6,len=12,display=Future Item Price"`
FutureItemPriceEffectiveDate DTM `hl7:"7,len=24,format=YMDHM,display=Future Item Price Effective Date"`
}
Packaging Segment
This segment contains the type of packaging available for the inventory supply item to be ordered and/or issued to a department or other supply location for a specified Purchasing Vendor. It would be recommended to send this segment in descending unit of measure order corresponding with the ascending Set ID.
type PL ¶
type PL struct {
HL7 HL7Name `hl7:",name=PL,len=1230,type=d"`
PointOfCare IS `` /* 347-byte string literal not displayed */
Room IS `` /* 226-byte string literal not displayed */
Bed IS `` /* 215-byte string literal not displayed */
Facility *HD `` /* 236-byte string literal not displayed */
LocationStatus IS `` /* 227-byte string literal not displayed */
PersonLocationType IS `` /* 427-byte string literal not displayed */
Building IS `` /* 247-byte string literal not displayed */
Floor IS `` /* 241-byte string literal not displayed */
LocationDescription ST `hl7:"9,len=199,display=This component describes the location in free text."`
ComprehensiveLocationIdentifier *EI `` /* 336-byte string literal not displayed */
AssigningAuthorityForLocation *HD `` /* 318-byte string literal not displayed */
}
Person Location
This data type is used to specify a patient location within a healthcare institution. Which components are valued depends on the needs of the site. For example for a patient treated at home, only the person location type is valued. It is most commonly used for specifying patient locations, but may refer to other types of locations within a healthcare setting.
type PLN ¶
type PLN struct {
HL7 HL7Name `hl7:",name=PLN,len=101,type=d"`
IDNumber ST `hl7:"1,required,len=20,display=Specifies the license number or other ID number such as UPIN- Medicare and Medicaid number."`
TypeOfIDNumber IS `hl7:"2,required,len=8,table=0338,display=Specifies the type of number."`
StateOtherQualifyingInformation ST `` /* 243-byte string literal not displayed */
ExpirationDate DT `hl7:"4,len=8,format=YMD,display=Specifies the date when the license or ID is no longer valid."`
}
Practitioner License or Other ID Number
This data type specifies a practitioners license number, or other ID number such as UPIN, Medicare and Medicaid number, and associated detail.
type PMT ¶
type PMT struct {
HL7 HL7Name `hl7:",name=PMT,type=s"`
PaymentRemittanceAdviceNumber EI `hl7:"1,required,len=73,display=Payment/Remittance Advice Number"`
PaymentRemittanceEffectiveDateTime DTM `hl7:"2,required,len=26,format=YMDHM,display=Payment/Remittance Effective Date/Time"`
PaymentRemittanceExpirationDateTime DTM `hl7:"3,required,len=26,format=YMDHM,display=Payment/Remittance Expiration Date/Time"`
PaymentMethod CWE `hl7:"4,required,len=177,table=0570,display=Payment Method"`
PaymentRemittanceDateTime DTM `hl7:"5,required,len=26,format=YMDHM,display=Payment/Remittance Date/Time"`
PaymentRemittanceAmount CP `hl7:"6,required,len=254,display=Payment/Remittance Amount"`
CheckNumber *EI `hl7:"7,len=15,display=Check Number"`
PayeeBankIdentification *XON `hl7:"8,len=6,display=Payee Bank Identification"`
PayeeTransitNumber ST `hl7:"9,len=4,display=Payee Transit Number"`
PayeeBankAccountID *CX `hl7:"10,len=20,display=Payee Bank Account ID"`
PaymentOrganization XON `hl7:"11,required,len=183,display=Payment Organization"`
ESRCodeLine ST `hl7:"12,len=100,display=ESR-Code-Line"`
}
Payment Information
This segment contains information that describes a payment made by a Payer organization.
type PMU_B01 ¶
type PMU_B01 struct {
HL7 HL7Name `hl7:",name=PMU_B01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA []PRA `hl7:"6,display=Practitioner Detail"`
ORG []ORG `hl7:"7,display=Practitioner Organization Unit"`
AFF []AFF `hl7:"8,display=Professional Affiliation"`
LAN []LAN `hl7:"9,display=Language Detail"`
EDU []EDU `hl7:"10,display=Educational Detail"`
CER []CER `hl7:"11,display=Certificate Detail"`
}
Add Personnel Record
An event B01 signals to add a new record for healthcare administration information about an individual healthcare practitioner establishing a relationship between that practitioner and the institution.
The EVN segment is used to indicate the effective or planned date.
type PMU_B02 ¶
type PMU_B02 struct {
HL7 HL7Name `hl7:",name=PMU_B02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA []PRA `hl7:"6,display=Practitioner Detail"`
ORG []ORG `hl7:"7,display=Practitioner Organization Unit"`
AFF []AFF `hl7:"8,display=Professional Affiliation"`
LAN []LAN `hl7:"9,display=Language Detail"`
EDU []EDU `hl7:"10,display=Educational Detail"`
CER []CER `hl7:"11,display=Certificate Detail"`
}
Update Personnel Record
An event B02 signals to update the record with the healthcare administration information about an individual healthcare practitioner. This event should not be used to grant/revoke a certificate.
The EVN segment is used to indicate the effective or planned date.
type PMU_B03 ¶
type PMU_B03 struct {
HL7 HL7Name `hl7:",name=PMU_B03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
}
Delete Personnel Record
An event B03 signals to delete the record with the healthcare administration information about an individual healthcare practitioner to correct erroneous entries.
The EVN segment is used to indicate the effective or planned date.
type PMU_B04 ¶
type PMU_B04 struct {
HL7 HL7Name `hl7:",name=PMU_B04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA []PRA `hl7:"6,display=Practitioner Detail"`
ORG []ORG `hl7:"7,display=Practitioner Organization Unit"`
}
Active Practicing Person
An event B04 signals that a staff member is available for work (e.g., schedules can be created) and has a relationship with the institution. This message applies to STF-7.
type PMU_B05 ¶
type PMU_B05 struct {
HL7 HL7Name `hl7:",name=PMU_B05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA []PRA `hl7:"6,display=Practitioner Detail"`
ORG []ORG `hl7:"7,display=Practitioner Organization Unit"`
}
Deactivate Practicing Person
An event B05 indicates that a staff member is temporarily unavailable for work, while maintaining a relationship with the institution. This message applies to STF-7.
type PMU_B06 ¶
type PMU_B06 struct {
HL7 HL7Name `hl7:",name=PMU_B06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA []PRA `hl7:"6,display=Practitioner Detail"`
ORG []ORG `hl7:"7,display=Practitioner Organization Unit"`
}
Terminate Practicing Person
An event B06 signals that the formal relationship between a staff member and the institution has ended (i.e., upon termination).
type PMU_B07 ¶
type PMU_B07 struct {
HL7 HL7Name `hl7:",name=PMU_B07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA *PRA `hl7:"6,display=Practitioner Detail"`
Certificate []PMU_B07_Certificate `hl7:",display=Certificate"`
}
Grant Certificate/Permission
An event B07 indicates that a health professional is granted a certificate/permission for a special purpose.
A permission is issued by an organization and documented in form of a certificate. An update of a role results in an issuing of a new certificate.
The EVN segment is used to indicate the effective or planned date.
type PMU_B07_Certificate ¶
type PMU_B07_Certificate struct {
HL7 HL7Name `hl7:",name=PMU_B07_Certificate,type=tg"`
CER *CER `hl7:"7,required,display=Certificate Detail"`
ROL []ROL `hl7:"8,display=Role"`
}
Certificate
type PMU_B08 ¶
type PMU_B08 struct {
HL7 HL7Name `hl7:",name=PMU_B08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,required,display=Event Type"`
STF *STF `hl7:"5,required,display=Staff Identification"`
PRA *PRA `hl7:"6,display=Practitioner Detail"`
CER []CER `hl7:"7,display=Certificate Detail"`
}
Revoke Certificate/Permission
An event B08 indicates that a certificate/permission for a health professional is revoked.
The EVN segment is used to indicate the effective or planned date.
type PPG_PCG ¶
type PPG_PCG struct {
HL7 HL7Name `hl7:",name=PPG_PCG,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPG_PCG_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPG_PCG_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Add (Goal-Oriented)
type PPG_PCG_Goal ¶
type PPG_PCG_Goal struct {
HL7 HL7Name `hl7:",name=PPG_PCG_Goal,type=tg"`
GOL *GOL `hl7:"12,required,display=Goal Detail"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
GoalRole []PPG_PCG_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPG_PCG_GoalObservation `hl7:",display=Goal Observation"`
Problem []PPG_PCG_Problem `hl7:",display=Problem"`
Order []PPG_PCG_Order `hl7:",display=Order"`
}
Goal
type PPG_PCG_GoalObservation ¶
type PPG_PCG_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCG_GoalObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
GoalObservation
type PPG_PCG_GoalRole ¶
type PPG_PCG_GoalRole struct {
HL7 HL7Name `hl7:",name=PPG_PCG_GoalRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
GoalRole
type PPG_PCG_Order ¶
type PPG_PCG_Order struct {
HL7 HL7Name `hl7:",name=PPG_PCG_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPG_PCG_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPG_PCG_OrderDetail ¶
type PPG_PCG_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPG_PCG_OrderDetail,type=tg"`
OrderDetailSegment *PPG_PCG_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPG_PCG_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPG_PCG_OrderDetailSegment ¶
type PPG_PCG_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPG_PCG_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPG_PCG_OrderObservation ¶
type PPG_PCG_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCG_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPG_PCG_Pathway ¶
type PPG_PCG_Pathway struct {
HL7 HL7Name `hl7:",name=PPG_PCG_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPG_PCG_PathwayRole `hl7:",display=Pathway Role"`
Goal []PPG_PCG_Goal `hl7:",display=Goal"`
}
Pathway
type PPG_PCG_PathwayRole ¶
type PPG_PCG_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPG_PCG_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPG_PCG_PatientVisit ¶
type PPG_PCG_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPG_PCG_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPG_PCG_Problem ¶
type PPG_PCG_Problem struct {
HL7 HL7Name `hl7:",name=PPG_PCG_Problem,type=tg"`
PRB *PRB `hl7:"19,required,display=Problem Details"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
ProblemRole []PPG_PCG_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPG_PCG_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PPG_PCG_ProblemObservation ¶
type PPG_PCG_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCG_ProblemObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ProblemObservation
type PPG_PCG_ProblemRole ¶
type PPG_PCG_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPG_PCG_ProblemRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
ProblemRole
type PPG_PCH ¶
type PPG_PCH struct {
HL7 HL7Name `hl7:",name=PPG_PCH,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPG_PCH_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPG_PCH_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Update (Goal-Oriented)
type PPG_PCH_Goal ¶
type PPG_PCH_Goal struct {
HL7 HL7Name `hl7:",name=PPG_PCH_Goal,type=tg"`
GOL *GOL `hl7:"12,required,display=Goal Detail"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
GoalRole []PPG_PCH_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPG_PCH_GoalObservation `hl7:",display=Goal Observation"`
Problem []PPG_PCH_Problem `hl7:",display=Problem"`
Order []PPG_PCH_Order `hl7:",display=Order"`
}
Goal
type PPG_PCH_GoalObservation ¶
type PPG_PCH_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCH_GoalObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
GoalObservation
type PPG_PCH_GoalRole ¶
type PPG_PCH_GoalRole struct {
HL7 HL7Name `hl7:",name=PPG_PCH_GoalRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
GoalRole
type PPG_PCH_Order ¶
type PPG_PCH_Order struct {
HL7 HL7Name `hl7:",name=PPG_PCH_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPG_PCH_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPG_PCH_OrderDetail ¶
type PPG_PCH_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPG_PCH_OrderDetail,type=tg"`
OrderDetailSegment *PPG_PCH_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPG_PCH_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPG_PCH_OrderDetailSegment ¶
type PPG_PCH_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPG_PCH_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPG_PCH_OrderObservation ¶
type PPG_PCH_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCH_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPG_PCH_Pathway ¶
type PPG_PCH_Pathway struct {
HL7 HL7Name `hl7:",name=PPG_PCH_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPG_PCH_PathwayRole `hl7:",display=Pathway Role"`
Goal []PPG_PCH_Goal `hl7:",display=Goal"`
}
Pathway
type PPG_PCH_PathwayRole ¶
type PPG_PCH_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPG_PCH_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPG_PCH_PatientVisit ¶
type PPG_PCH_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPG_PCH_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPG_PCH_Problem ¶
type PPG_PCH_Problem struct {
HL7 HL7Name `hl7:",name=PPG_PCH_Problem,type=tg"`
PRB *PRB `hl7:"19,required,display=Problem Details"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
ProblemRole []PPG_PCH_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPG_PCH_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PPG_PCH_ProblemObservation ¶
type PPG_PCH_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCH_ProblemObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ProblemObservation
type PPG_PCH_ProblemRole ¶
type PPG_PCH_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPG_PCH_ProblemRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
ProblemRole
type PPG_PCJ ¶
type PPG_PCJ struct {
HL7 HL7Name `hl7:",name=PPG_PCJ,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPG_PCJ_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPG_PCJ_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Delete (Goal-Oriented)
type PPG_PCJ_Goal ¶
type PPG_PCJ_Goal struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_Goal,type=tg"`
GOL *GOL `hl7:"12,required,display=Goal Detail"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
GoalRole []PPG_PCJ_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPG_PCJ_GoalObservation `hl7:",display=Goal Observation"`
Problem []PPG_PCJ_Problem `hl7:",display=Problem"`
Order []PPG_PCJ_Order `hl7:",display=Order"`
}
Goal
type PPG_PCJ_GoalObservation ¶
type PPG_PCJ_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_GoalObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
GoalObservation
type PPG_PCJ_GoalRole ¶
type PPG_PCJ_GoalRole struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_GoalRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
GoalRole
type PPG_PCJ_Order ¶
type PPG_PCJ_Order struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPG_PCJ_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPG_PCJ_OrderDetail ¶
type PPG_PCJ_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_OrderDetail,type=tg"`
OrderDetailSegment *PPG_PCJ_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPG_PCJ_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPG_PCJ_OrderDetailSegment ¶
type PPG_PCJ_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPG_PCJ_OrderObservation ¶
type PPG_PCJ_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPG_PCJ_Pathway ¶
type PPG_PCJ_Pathway struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPG_PCJ_PathwayRole `hl7:",display=Pathway Role"`
Goal []PPG_PCJ_Goal `hl7:",display=Goal"`
}
Pathway
type PPG_PCJ_PathwayRole ¶
type PPG_PCJ_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPG_PCJ_PatientVisit ¶
type PPG_PCJ_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPG_PCJ_Problem ¶
type PPG_PCJ_Problem struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_Problem,type=tg"`
PRB *PRB `hl7:"19,required,display=Problem Details"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
ProblemRole []PPG_PCJ_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPG_PCJ_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PPG_PCJ_ProblemObservation ¶
type PPG_PCJ_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_ProblemObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ProblemObservation
type PPG_PCJ_ProblemRole ¶
type PPG_PCJ_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPG_PCJ_ProblemRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
ProblemRole
type PPN ¶
type PPN struct {
HL7 HL7Name `hl7:",name=PPN,len=3213,type=d"`
IDNumber ST `` /* 198-byte string literal not displayed */
FamilyName FN `` /* 417-byte string literal not displayed */
GivenName ST `hl7:"3,len=30,display=First name."`
SecondAndFurtherGivenNamesOrInitialsThereof ST `hl7:"4,len=30,display=Multiple middle names may be included by separating them with spaces."`
Suffix ST `hl7:"5,len=20,display=Used to specify a name suffix (e.g.- Jr. or III)."`
Prefix ST `hl7:"6,len=20,display=Used to specify a name prefix (e.g.- Dr.)."`
Degree IS `` /* 239-byte string literal not displayed */
SourceTable IS `` /* 209-byte string literal not displayed */
AssigningAuthority *HD `` /* 360-byte string literal not displayed */
NameTypeCode ID `` /* 179-byte string literal not displayed */
IdentifierCheckDigit ST `` /* 237-byte string literal not displayed */
CheckDigitScheme ID `hl7:"12,conditional,len=3,table=0061,display=Contains the code identifying the check digit scheme employed."`
IdentifierTypeCode ID `` /* 237-byte string literal not displayed */
AssigningFacility *HD `` /* 318-byte string literal not displayed */
DateTimeActionPerformed DTM `hl7:"15,len=24,format=YMDHM,display=This component describes when the activity was performed."`
NameRepresentationCode ID `` /* 248-byte string literal not displayed */
NameContext *CWE `` /* 605-byte string literal not displayed */
NameValidityRange DR `` /* 327-byte string literal not displayed */
NameAssemblyOrder ID `` /* 187-byte string literal not displayed */
EffectiveDate DTM `hl7:"20,len=24,format=YMDHM,display=The first date- if known- on which the person name is valid and active."`
ExpirationDate DTM `hl7:"21,len=24,format=YMDHM,display=The last date- if known- on which the person name is valid and active."`
ProfessionalSuffix ST `` /* 586-byte string literal not displayed */
AssigningJurisdiction *CWE `hl7:"23,len=705,display=The geo-political body that assigned the identifier in component 1."`
AssigningAgencyOrDepartment *CWE `hl7:"24,len=705,display=The agency or department that assigned the identifier in component 1."`
}
Performing Person Time Stamp
This data type is the equivalent of an XCN data type joined with a DTM data type. However, the XCN data type has been flattened to allow legal expression of its embedded complex data types HD, CWE and CWE.
type PPP_PCB ¶
type PPP_PCB struct {
HL7 HL7Name `hl7:",name=PPP_PCB,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPP_PCB_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPP_PCB_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Add (Problem-Oriented)
type PPP_PCB_Goal ¶
type PPP_PCB_Goal struct {
HL7 HL7Name `hl7:",name=PPP_PCB_Goal,type=tg"`
GOL *GOL `hl7:"19,required,display=Goal Detail"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
GoalRole []PPP_PCB_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPP_PCB_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPP_PCB_GoalObservation ¶
type PPP_PCB_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCB_GoalObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
GoalObservation
type PPP_PCB_GoalRole ¶
type PPP_PCB_GoalRole struct {
HL7 HL7Name `hl7:",name=PPP_PCB_GoalRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
GoalRole
type PPP_PCB_Order ¶
type PPP_PCB_Order struct {
HL7 HL7Name `hl7:",name=PPP_PCB_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPP_PCB_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPP_PCB_OrderDetail ¶
type PPP_PCB_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPP_PCB_OrderDetail,type=tg"`
OrderDetailSegment *PPP_PCB_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPP_PCB_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPP_PCB_OrderDetailSegment ¶
type PPP_PCB_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPP_PCB_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPP_PCB_OrderObservation ¶
type PPP_PCB_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCB_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPP_PCB_Pathway ¶
type PPP_PCB_Pathway struct {
HL7 HL7Name `hl7:",name=PPP_PCB_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPP_PCB_PathwayRole `hl7:",display=Pathway Role"`
Problem []PPP_PCB_Problem `hl7:",display=Problem"`
}
Pathway
type PPP_PCB_PathwayRole ¶
type PPP_PCB_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPP_PCB_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPP_PCB_PatientVisit ¶
type PPP_PCB_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPP_PCB_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPP_PCB_Problem ¶
type PPP_PCB_Problem struct {
HL7 HL7Name `hl7:",name=PPP_PCB_Problem,type=tg"`
PRB *PRB `hl7:"12,required,display=Problem Details"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
ProblemRole []PPP_PCB_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPP_PCB_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPP_PCB_Goal `hl7:",display=Goal"`
Order []PPP_PCB_Order `hl7:",display=Order"`
}
Problem
type PPP_PCB_ProblemObservation ¶
type PPP_PCB_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCB_ProblemObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
ProblemObservation
type PPP_PCB_ProblemRole ¶
type PPP_PCB_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPP_PCB_ProblemRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
ProblemRole
type PPP_PCC ¶
type PPP_PCC struct {
HL7 HL7Name `hl7:",name=PPP_PCC,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPP_PCC_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPP_PCC_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Update (Problem-Oriented)
type PPP_PCC_Goal ¶
type PPP_PCC_Goal struct {
HL7 HL7Name `hl7:",name=PPP_PCC_Goal,type=tg"`
GOL *GOL `hl7:"19,required,display=Goal Detail"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
GoalRole []PPP_PCC_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPP_PCC_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPP_PCC_GoalObservation ¶
type PPP_PCC_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCC_GoalObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
GoalObservation
type PPP_PCC_GoalRole ¶
type PPP_PCC_GoalRole struct {
HL7 HL7Name `hl7:",name=PPP_PCC_GoalRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
GoalRole
type PPP_PCC_Order ¶
type PPP_PCC_Order struct {
HL7 HL7Name `hl7:",name=PPP_PCC_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPP_PCC_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPP_PCC_OrderDetail ¶
type PPP_PCC_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPP_PCC_OrderDetail,type=tg"`
OrderDetailSegment *PPP_PCC_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPP_PCC_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPP_PCC_OrderDetailSegment ¶
type PPP_PCC_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPP_PCC_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPP_PCC_OrderObservation ¶
type PPP_PCC_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCC_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPP_PCC_Pathway ¶
type PPP_PCC_Pathway struct {
HL7 HL7Name `hl7:",name=PPP_PCC_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPP_PCC_PathwayRole `hl7:",display=Pathway Role"`
Problem []PPP_PCC_Problem `hl7:",display=Problem"`
}
Pathway
type PPP_PCC_PathwayRole ¶
type PPP_PCC_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPP_PCC_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPP_PCC_PatientVisit ¶
type PPP_PCC_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPP_PCC_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPP_PCC_Problem ¶
type PPP_PCC_Problem struct {
HL7 HL7Name `hl7:",name=PPP_PCC_Problem,type=tg"`
PRB *PRB `hl7:"12,required,display=Problem Details"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
ProblemRole []PPP_PCC_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPP_PCC_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPP_PCC_Goal `hl7:",display=Goal"`
Order []PPP_PCC_Order `hl7:",display=Order"`
}
Problem
type PPP_PCC_ProblemObservation ¶
type PPP_PCC_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCC_ProblemObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
ProblemObservation
type PPP_PCC_ProblemRole ¶
type PPP_PCC_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPP_PCC_ProblemRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
ProblemRole
type PPP_PCD ¶
type PPP_PCD struct {
HL7 HL7Name `hl7:",name=PPP_PCD,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPP_PCD_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPP_PCD_Pathway `hl7:",required,display=Pathway"`
}
Patient Pathway Delete (Problem-Oriented)
type PPP_PCD_Goal ¶
type PPP_PCD_Goal struct {
HL7 HL7Name `hl7:",name=PPP_PCD_Goal,type=tg"`
GOL *GOL `hl7:"19,required,display=Goal Detail"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
VAR []VAR `hl7:"21,display=Variance"`
GoalRole []PPP_PCD_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPP_PCD_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPP_PCD_GoalObservation ¶
type PPP_PCD_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCD_GoalObservation,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
GoalObservation
type PPP_PCD_GoalRole ¶
type PPP_PCD_GoalRole struct {
HL7 HL7Name `hl7:",name=PPP_PCD_GoalRole,type=tg"`
ROL *ROL `hl7:"22,required,display=Role"`
VAR []VAR `hl7:"23,display=Variance"`
}
GoalRole
type PPP_PCD_Order ¶
type PPP_PCD_Order struct {
HL7 HL7Name `hl7:",name=PPP_PCD_Order,type=tg"`
ORC *ORC `hl7:"26,required,display=Common Order"`
OrderDetail *PPP_PCD_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPP_PCD_OrderDetail ¶
type PPP_PCD_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPP_PCD_OrderDetail,type=tg"`
OrderDetailSegment *PPP_PCD_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
OrderObservation []PPP_PCD_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPP_PCD_OrderDetailSegment ¶
type PPP_PCD_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPP_PCD_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"27,conditional,display=Observation Request"`
RQD *RQD `hl7:"28,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"29,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"30,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"31,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"32,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPP_PCD_OrderObservation ¶
type PPP_PCD_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCD_OrderObservation,type=tg"`
OBX *OBX `hl7:"35,required,display=Observation/Result"`
NTE []NTE `hl7:"36,display=Notes and Comments"`
VAR []VAR `hl7:"37,display=Variance"`
}
OrderObservation
type PPP_PCD_Pathway ¶
type PPP_PCD_Pathway struct {
HL7 HL7Name `hl7:",name=PPP_PCD_Pathway,type=tg"`
PTH *PTH `hl7:"7,required,display=Pathway"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
PathwayRole []PPP_PCD_PathwayRole `hl7:",display=Pathway Role"`
Problem []PPP_PCD_Problem `hl7:",display=Problem"`
}
Pathway
type PPP_PCD_PathwayRole ¶
type PPP_PCD_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPP_PCD_PathwayRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
PathwayRole
type PPP_PCD_PatientVisit ¶
type PPP_PCD_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPP_PCD_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPP_PCD_Problem ¶
type PPP_PCD_Problem struct {
HL7 HL7Name `hl7:",name=PPP_PCD_Problem,type=tg"`
PRB *PRB `hl7:"12,required,display=Problem Details"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
VAR []VAR `hl7:"14,display=Variance"`
ProblemRole []PPP_PCD_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPP_PCD_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPP_PCD_Goal `hl7:",display=Goal"`
Order []PPP_PCD_Order `hl7:",display=Order"`
}
Problem
type PPP_PCD_ProblemObservation ¶
type PPP_PCD_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPP_PCD_ProblemObservation,type=tg"`
OBX *OBX `hl7:"17,required,display=Observation/Result"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
ProblemObservation
type PPP_PCD_ProblemRole ¶
type PPP_PCD_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPP_PCD_ProblemRole,type=tg"`
ROL *ROL `hl7:"15,required,display=Role"`
VAR []VAR `hl7:"16,display=Variance"`
}
ProblemRole
type PPR_PC1 ¶
type PPR_PC1 struct {
HL7 HL7Name `hl7:",name=PPR_PC1,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPR_PC1_PatientVisit `hl7:",display=Patient Visit"`
Problem []PPR_PC1_Problem `hl7:",required,display=Problem"`
}
Patient Problem Add
The patient problem message is used to send problems from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.
type PPR_PC1_Goal ¶
type PPR_PC1_Goal struct {
HL7 HL7Name `hl7:",name=PPR_PC1_Goal,type=tg"`
GOL *GOL `hl7:"16,required,display=Goal Detail"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
GoalRole []PPR_PC1_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPR_PC1_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPR_PC1_GoalObservation ¶
type PPR_PC1_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC1_GoalObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
GoalObservation
type PPR_PC1_GoalRole ¶
type PPR_PC1_GoalRole struct {
HL7 HL7Name `hl7:",name=PPR_PC1_GoalRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
GoalRole
type PPR_PC1_Order ¶
type PPR_PC1_Order struct {
HL7 HL7Name `hl7:",name=PPR_PC1_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PPR_PC1_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPR_PC1_OrderDetail ¶
type PPR_PC1_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPR_PC1_OrderDetail,type=tg"`
OrderDetailSegment *PPR_PC1_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PPR_PC1_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPR_PC1_OrderDetailSegment ¶
type PPR_PC1_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPR_PC1_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPR_PC1_OrderObservation ¶
type PPR_PC1_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC1_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PPR_PC1_Pathway ¶
type PPR_PC1_Pathway struct {
HL7 HL7Name `hl7:",name=PPR_PC1_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PPR_PC1_PatientVisit ¶
type PPR_PC1_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPR_PC1_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPR_PC1_Problem ¶
type PPR_PC1_Problem struct {
HL7 HL7Name `hl7:",name=PPR_PC1_Problem,type=tg"`
PRB *PRB `hl7:"7,required,display=Problem Details"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
ProblemRole []PPR_PC1_ProblemRole `hl7:",display=Problem Role"`
Pathway []PPR_PC1_Pathway `hl7:",display=Pathway"`
ProblemObservation []PPR_PC1_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPR_PC1_Goal `hl7:",display=Goal"`
Order []PPR_PC1_Order `hl7:",display=Order"`
}
Problem
type PPR_PC1_ProblemObservation ¶
type PPR_PC1_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC1_ProblemObservation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
ProblemObservation
type PPR_PC1_ProblemRole ¶
type PPR_PC1_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPR_PC1_ProblemRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
ProblemRole
type PPR_PC2 ¶
type PPR_PC2 struct {
HL7 HL7Name `hl7:",name=PPR_PC2,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPR_PC2_PatientVisit `hl7:",display=Patient Visit"`
Problem []PPR_PC2_Problem `hl7:",required,display=Problem"`
}
Patient Problem Update
The patient problem message is used to send problems from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.
type PPR_PC2_Goal ¶
type PPR_PC2_Goal struct {
HL7 HL7Name `hl7:",name=PPR_PC2_Goal,type=tg"`
GOL *GOL `hl7:"16,required,display=Goal Detail"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
GoalRole []PPR_PC2_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPR_PC2_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPR_PC2_GoalObservation ¶
type PPR_PC2_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC2_GoalObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
GoalObservation
type PPR_PC2_GoalRole ¶
type PPR_PC2_GoalRole struct {
HL7 HL7Name `hl7:",name=PPR_PC2_GoalRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
GoalRole
type PPR_PC2_Order ¶
type PPR_PC2_Order struct {
HL7 HL7Name `hl7:",name=PPR_PC2_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PPR_PC2_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPR_PC2_OrderDetail ¶
type PPR_PC2_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPR_PC2_OrderDetail,type=tg"`
OrderDetailSegment *PPR_PC2_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PPR_PC2_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPR_PC2_OrderDetailSegment ¶
type PPR_PC2_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPR_PC2_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPR_PC2_OrderObservation ¶
type PPR_PC2_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC2_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PPR_PC2_Pathway ¶
type PPR_PC2_Pathway struct {
HL7 HL7Name `hl7:",name=PPR_PC2_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PPR_PC2_PatientVisit ¶
type PPR_PC2_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPR_PC2_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPR_PC2_Problem ¶
type PPR_PC2_Problem struct {
HL7 HL7Name `hl7:",name=PPR_PC2_Problem,type=tg"`
PRB *PRB `hl7:"7,required,display=Problem Details"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
ProblemRole []PPR_PC2_ProblemRole `hl7:",display=Problem Role"`
Pathway []PPR_PC2_Pathway `hl7:",display=Pathway"`
ProblemObservation []PPR_PC2_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPR_PC2_Goal `hl7:",display=Goal"`
Order []PPR_PC2_Order `hl7:",display=Order"`
}
Problem
type PPR_PC2_ProblemObservation ¶
type PPR_PC2_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC2_ProblemObservation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
ProblemObservation
type PPR_PC2_ProblemRole ¶
type PPR_PC2_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPR_PC2_ProblemRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
ProblemRole
type PPR_PC3 ¶
type PPR_PC3 struct {
HL7 HL7Name `hl7:",name=PPR_PC3,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PatientVisit *PPR_PC3_PatientVisit `hl7:",display=Patient Visit"`
Problem []PPR_PC3_Problem `hl7:",required,display=Problem"`
}
Patient Problem Delete
The patient problem message is used to send problems from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.
type PPR_PC3_Goal ¶
type PPR_PC3_Goal struct {
HL7 HL7Name `hl7:",name=PPR_PC3_Goal,type=tg"`
GOL *GOL `hl7:"16,required,display=Goal Detail"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
GoalRole []PPR_PC3_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPR_PC3_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PPR_PC3_GoalObservation ¶
type PPR_PC3_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC3_GoalObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
GoalObservation
type PPR_PC3_GoalRole ¶
type PPR_PC3_GoalRole struct {
HL7 HL7Name `hl7:",name=PPR_PC3_GoalRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
GoalRole
type PPR_PC3_Order ¶
type PPR_PC3_Order struct {
HL7 HL7Name `hl7:",name=PPR_PC3_Order,type=tg"`
ORC *ORC `hl7:"23,required,display=Common Order"`
OrderDetail *PPR_PC3_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPR_PC3_OrderDetail ¶
type PPR_PC3_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPR_PC3_OrderDetail,type=tg"`
OrderDetailSegment *PPR_PC3_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
VAR []VAR `hl7:"31,display=Variance"`
OrderObservation []PPR_PC3_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPR_PC3_OrderDetailSegment ¶
type PPR_PC3_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPR_PC3_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"24,conditional,display=Observation Request"`
RQD *RQD `hl7:"25,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"26,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"27,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"28,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"29,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPR_PC3_OrderObservation ¶
type PPR_PC3_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC3_OrderObservation,type=tg"`
OBX *OBX `hl7:"32,required,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
VAR []VAR `hl7:"34,display=Variance"`
}
OrderObservation
type PPR_PC3_Pathway ¶
type PPR_PC3_Pathway struct {
HL7 HL7Name `hl7:",name=PPR_PC3_Pathway,type=tg"`
PTH *PTH `hl7:"12,required,display=Pathway"`
VAR []VAR `hl7:"13,display=Variance"`
}
Pathway
type PPR_PC3_PatientVisit ¶
type PPR_PC3_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPR_PC3_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"5,required,display=Patient Visit"`
PV2 *PV2 `hl7:"6,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPR_PC3_Problem ¶
type PPR_PC3_Problem struct {
HL7 HL7Name `hl7:",name=PPR_PC3_Problem,type=tg"`
PRB *PRB `hl7:"7,required,display=Problem Details"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
VAR []VAR `hl7:"9,display=Variance"`
ProblemRole []PPR_PC3_ProblemRole `hl7:",display=Problem Role"`
Pathway []PPR_PC3_Pathway `hl7:",display=Pathway"`
ProblemObservation []PPR_PC3_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PPR_PC3_Goal `hl7:",display=Goal"`
Order []PPR_PC3_Order `hl7:",display=Order"`
}
Problem
type PPR_PC3_ProblemObservation ¶
type PPR_PC3_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPR_PC3_ProblemObservation,type=tg"`
OBX *OBX `hl7:"14,required,display=Observation/Result"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
ProblemObservation
type PPR_PC3_ProblemRole ¶
type PPR_PC3_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPR_PC3_ProblemRole,type=tg"`
ROL *ROL `hl7:"10,required,display=Role"`
VAR []VAR `hl7:"11,display=Variance"`
}
ProblemRole
type PPT_PCL ¶
type PPT_PCL struct {
HL7 HL7Name `hl7:",name=PPT_PCL,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
Patient []PPT_PCL_Patient `hl7:",required,display=Patient"`
}
Patient Pathway (Goal-Oriented) Response
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by PPT (a response from the system responsible for maintaining the goal-oriented pathway information).
type PPT_PCL_Goal ¶
type PPT_PCL_Goal struct {
HL7 HL7Name `hl7:",name=PPT_PCL_Goal,type=tg"`
GOL *GOL `hl7:"16,required,display=Goal Detail"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
GoalRole []PPT_PCL_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PPT_PCL_GoalObservation `hl7:",display=Goal Observation"`
Problem []PPT_PCL_Problem `hl7:",display=Problem"`
Order []PPT_PCL_Order `hl7:",display=Order"`
}
Goal
type PPT_PCL_GoalObservation ¶
type PPT_PCL_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPT_PCL_GoalObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
GoalObservation
type PPT_PCL_GoalRole ¶
type PPT_PCL_GoalRole struct {
HL7 HL7Name `hl7:",name=PPT_PCL_GoalRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
GoalRole
type PPT_PCL_Order ¶
type PPT_PCL_Order struct {
HL7 HL7Name `hl7:",name=PPT_PCL_Order,type=tg"`
ORC *ORC `hl7:"30,required,display=Common Order"`
OrderDetail *PPT_PCL_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPT_PCL_OrderDetail ¶
type PPT_PCL_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPT_PCL_OrderDetail,type=tg"`
OrderDetailSegment *PPT_PCL_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
VAR []VAR `hl7:"38,display=Variance"`
OrderObservation []PPT_PCL_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPT_PCL_OrderDetailSegment ¶
type PPT_PCL_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPT_PCL_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"31,conditional,display=Observation Request"`
RQD *RQD `hl7:"32,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"33,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"34,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"35,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"36,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPT_PCL_OrderObservation ¶
type PPT_PCL_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPT_PCL_OrderObservation,type=tg"`
OBX *OBX `hl7:"39,required,display=Observation/Result"`
NTE []NTE `hl7:"40,display=Notes and Comments"`
VAR []VAR `hl7:"41,display=Variance"`
}
OrderObservation
type PPT_PCL_Pathway ¶
type PPT_PCL_Pathway struct {
HL7 HL7Name `hl7:",name=PPT_PCL_Pathway,type=tg"`
PTH *PTH `hl7:"11,required,display=Pathway"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
VAR []VAR `hl7:"13,display=Variance"`
PathwayRole []PPT_PCL_PathwayRole `hl7:",display=Pathway Role"`
Goal []PPT_PCL_Goal `hl7:",display=Goal"`
}
Pathway
type PPT_PCL_PathwayRole ¶
type PPT_PCL_PathwayRole struct {
HL7 HL7Name `hl7:",name=PPT_PCL_PathwayRole,type=tg"`
ROL *ROL `hl7:"14,required,display=Role"`
VAR []VAR `hl7:"15,display=Variance"`
}
PathwayRole
type PPT_PCL_Patient ¶
type PPT_PCL_Patient struct {
HL7 HL7Name `hl7:",name=PPT_PCL_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PatientVisit *PPT_PCL_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PPT_PCL_Pathway `hl7:",required,display=Pathway"`
}
Patient
type PPT_PCL_PatientVisit ¶
type PPT_PCL_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPT_PCL_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPT_PCL_Problem ¶
type PPT_PCL_Problem struct {
HL7 HL7Name `hl7:",name=PPT_PCL_Problem,type=tg"`
PRB *PRB `hl7:"23,required,display=Problem Details"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
VAR []VAR `hl7:"25,display=Variance"`
ProblemRole []PPT_PCL_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPT_PCL_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PPT_PCL_ProblemObservation ¶
type PPT_PCL_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPT_PCL_ProblemObservation,type=tg"`
OBX *OBX `hl7:"28,required,display=Observation/Result"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
ProblemObservation
type PPT_PCL_ProblemRole ¶
type PPT_PCL_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPT_PCL_ProblemRole,type=tg"`
ROL *ROL `hl7:"26,required,display=Role"`
VAR []VAR `hl7:"27,display=Variance"`
}
ProblemRole
type PPV_PCA ¶
type PPV_PCA struct {
HL7 HL7Name `hl7:",name=PPV_PCA,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
Patient []PPV_PCA_Patient `hl7:",required,display=Patient"`
}
Patient Goal Response
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by PPV (a response from the system responsible for maintaining the goal information).
type PPV_PCA_Goal ¶
type PPV_PCA_Goal struct {
HL7 HL7Name `hl7:",name=PPV_PCA_Goal,type=tg"`
GOL *GOL `hl7:"11,required,display=Goal Detail"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
VAR []VAR `hl7:"13,display=Variance"`
GoalRole []PPV_PCA_GoalRole `hl7:",display=Goal Role"`
GoalPathway []PPV_PCA_GoalPathway `hl7:",display=Goal Pathway"`
GoalObservation []PPV_PCA_GoalObservation `hl7:",display=Goal Observation"`
Problem []PPV_PCA_Problem `hl7:",display=Problem"`
Order []PPV_PCA_Order `hl7:",display=Order"`
}
Goal
type PPV_PCA_GoalObservation ¶
type PPV_PCA_GoalObservation struct {
HL7 HL7Name `hl7:",name=PPV_PCA_GoalObservation,type=tg"`
OBX *OBX `hl7:"18,required,display=Observation/Result"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
GoalObservation
type PPV_PCA_GoalPathway ¶
type PPV_PCA_GoalPathway struct {
HL7 HL7Name `hl7:",name=PPV_PCA_GoalPathway,type=tg"`
PTH *PTH `hl7:"16,required,display=Pathway"`
VAR []VAR `hl7:"17,display=Variance"`
}
GoalPathway
type PPV_PCA_GoalRole ¶
type PPV_PCA_GoalRole struct {
HL7 HL7Name `hl7:",name=PPV_PCA_GoalRole,type=tg"`
ROL *ROL `hl7:"14,required,display=Role"`
VAR []VAR `hl7:"15,display=Variance"`
}
GoalRole
type PPV_PCA_Order ¶
type PPV_PCA_Order struct {
HL7 HL7Name `hl7:",name=PPV_PCA_Order,type=tg"`
ORC *ORC `hl7:"27,required,display=Common Order"`
OrderDetail *PPV_PCA_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PPV_PCA_OrderDetail ¶
type PPV_PCA_OrderDetail struct {
HL7 HL7Name `hl7:",name=PPV_PCA_OrderDetail,type=tg"`
OrderDetailSegment *PPV_PCA_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"34,display=Notes and Comments"`
VAR []VAR `hl7:"35,display=Variance"`
OrderObservation []PPV_PCA_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PPV_PCA_OrderDetailSegment ¶
type PPV_PCA_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PPV_PCA_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"28,conditional,display=Observation Request"`
RQD *RQD `hl7:"29,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"30,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"31,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"32,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"33,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PPV_PCA_OrderObservation ¶
type PPV_PCA_OrderObservation struct {
HL7 HL7Name `hl7:",name=PPV_PCA_OrderObservation,type=tg"`
OBX *OBX `hl7:"36,required,display=Observation/Result"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
VAR []VAR `hl7:"38,display=Variance"`
}
OrderObservation
type PPV_PCA_Patient ¶
type PPV_PCA_Patient struct {
HL7 HL7Name `hl7:",name=PPV_PCA_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PatientVisit *PPV_PCA_PatientVisit `hl7:",display=Patient Visit"`
Goal []PPV_PCA_Goal `hl7:",required,display=Goal"`
}
Patient
type PPV_PCA_PatientVisit ¶
type PPV_PCA_PatientVisit struct {
HL7 HL7Name `hl7:",name=PPV_PCA_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type PPV_PCA_Problem ¶
type PPV_PCA_Problem struct {
HL7 HL7Name `hl7:",name=PPV_PCA_Problem,type=tg"`
PRB *PRB `hl7:"20,required,display=Problem Details"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
VAR []VAR `hl7:"22,display=Variance"`
ProblemRole []PPV_PCA_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PPV_PCA_ProblemObservation `hl7:",display=Problem Observation"`
}
Problem
type PPV_PCA_ProblemObservation ¶
type PPV_PCA_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PPV_PCA_ProblemObservation,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
ProblemObservation
type PPV_PCA_ProblemRole ¶
type PPV_PCA_ProblemRole struct {
HL7 HL7Name `hl7:",name=PPV_PCA_ProblemRole,type=tg"`
ROL *ROL `hl7:"23,required,display=Role"`
VAR []VAR `hl7:"24,display=Variance"`
}
ProblemRole
type PR1 ¶
type PR1 struct {
HL7 HL7Name `hl7:",name=PR1,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - PR1"`
ProcedureCodingMethod ST `hl7:"2,display=Procedure Coding Method"`
ProcedureCode CNE `hl7:"3,required,len=705,table=0088,display=Procedure Code"`
ProcedureDescription ST `hl7:"4,display=Procedure Description"`
ProcedureDateTime DTM `hl7:"5,required,len=24,format=YMDHM,display=Procedure Date/Time"`
ProcedureFunctionalType IS `hl7:"6,len=2,table=0230,display=Procedure Functional Type"`
ProcedureMinutes NM `hl7:"7,len=4,display=Procedure Minutes"`
Anesthesiologist ST `hl7:"8,display=Anesthesiologist"`
AnesthesiaCode IS `hl7:"9,len=2,table=0019,display=Anesthesia Code"`
AnesthesiaMinutes NM `hl7:"10,len=4,display=Anesthesia Minutes"`
Surgeon ST `hl7:"11,display=Surgeon"`
ProcedurePractitioner ST `hl7:"12,display=Procedure Practitioner"`
ConsentCode *CWE `hl7:"13,len=250,table=0059,display=Consent Code"`
ProcedurePriority ID `hl7:"14,len=2,table=0418,display=Procedure Priority"`
AssociatedDiagnosisCode *CWE `hl7:"15,len=250,table=0051,display=Associated Diagnosis Code"`
ProcedureCodeModifier []CNE `hl7:"16,len=705,table=0340,display=Procedure Code Modifier"`
ProcedureDRGType IS `hl7:"17,len=20,table=0416,display=Procedure DRG Type"`
TissueTypeCode []CWE `hl7:"18,len=250,table=0417,display=Tissue Type Code"`
ProcedureIdentifier *EI `hl7:"19,conditional,len=427,display=Procedure Identifier"`
ProcedureActionCode ID `hl7:"20,conditional,len=1,table=0206,display=Procedure Action Code"`
DRGProcedureDeterminationStatus IS `hl7:"21,len=20,table=0761,display=DRG Procedure Determination Status"`
DRGProcedureRelevance IS `hl7:"22,len=20,table=0763,display=DRG Procedure Relevance"`
}
Procedures
The PR1 segment contains information relative to various types of procedures that can be performed on a patient. The PR1 segment can be used to send procedure information, for example: Surgical, Nuclear Medicine, X-ray with contrast, etc. The PR1 segment is used to send multiple procedures, for example, for medical records encoding or for billing systems.
type PRA ¶
type PRA struct {
HL7 HL7Name `hl7:",name=PRA,type=s"`
PrimaryKeyValue *CWE `hl7:"1,conditional,len=250,display=Primary Key Value - PRA"`
PractitionerGroup []CWE `hl7:"2,len=250,table=0358,display=Practitioner Group"`
PractitionerCategory []IS `hl7:"3,len=3,table=0186,display=Practitioner Category"`
ProviderBilling ID `hl7:"4,len=1,table=0187,display=Provider Billing"`
Specialty []SPD `hl7:"5,len=112,display=Specialty"`
PractitionerIDNumbers []PLN `hl7:"6,len=99,display=Practitioner ID Numbers"`
Privileges []PIP `hl7:"7,len=770,display=Privileges"`
DateEnteredPractice DT `hl7:"8,len=8,format=YMD,display=Date Entered Practice"`
Institution *CWE `hl7:"9,len=250,table=0537,display=Institution"`
DateLeftPractice DT `hl7:"10,len=8,format=YMD,display=Date Left Practice"`
GovernmentReimbursementBillingEligibility []CWE `hl7:"11,len=250,table=0401,display=Government Reimbursement Billing Eligibility"`
SetID SI `hl7:"12,seq,conditional,len=60,display=Set ID - PRA"`
}
Practitioner Detail
The Technical Steward for the PRA segment is PA and Personnel Management.
The PRA segment adds detailed medical practitioner information to the personnel identified by the STF segment. A PRA segment may optionally follow an STF segment. A PRA segment must always have been preceded by a corresponding STF segment. The PRA segment may also be used for staff who work in healthcare who are not practitioners but need to be certified, e.g., "medical records staff."
type PRB ¶
type PRB struct {
HL7 HL7Name `hl7:",name=PRB,type=s"`
ActionCode ID `hl7:"1,required,len=2,table=0287,display=Action Code"`
ActionDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Action Date/Time"`
ProblemID CWE `hl7:"3,required,len=705,display=Problem ID"`
ProblemInstanceID EI `hl7:"4,required,len=60,display=Problem Instance ID"`
EpisodeOfCareID *EI `hl7:"5,len=60,display=Episode of Care ID"`
ProblemListPriority NM `hl7:"6,len=60,display=Problem List Priority"`
ProblemEstablishedDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Problem Established Date/Time"`
AnticipatedProblemResolutionDateTime DTM `hl7:"8,len=24,format=YMDHM,display=Anticipated Problem Resolution Date/Time"`
ActualProblemResolutionDateTime DTM `hl7:"9,len=24,format=YMDHM,display=Actual Problem Resolution Date/Time"`
ProblemClassification *CWE `hl7:"10,len=705,display=Problem Classification"`
ProblemManagementDiscipline []CWE `hl7:"11,len=705,display=Problem Management Discipline"`
ProblemPersistence *CWE `hl7:"12,len=705,display=Problem Persistence"`
ProblemConfirmationStatus *CWE `hl7:"13,len=705,display=Problem Confirmation Status"`
ProblemLifeCycleStatus *CWE `hl7:"14,len=705,display=Problem Life Cycle Status"`
ProblemLifeCycleStatusDateTime DTM `hl7:"15,len=24,format=YMDHM,display=Problem Life Cycle Status Date/Time"`
ProblemDateOfOnset DTM `hl7:"16,len=24,format=YMDHM,display=Problem Date of Onset"`
ProblemOnsetText ST `hl7:"17,len=80,display=Problem Onset Text"`
ProblemRanking *CWE `hl7:"18,len=705,display=Problem Ranking"`
CertaintyOfProblem *CWE `hl7:"19,len=705,display=Certainty of Problem"`
ProbabilityOfProblem NM `hl7:"20,len=5,display=Probability of Problem"`
IndividualAwarenessOfProblem *CWE `hl7:"21,len=705,display=Individual Awareness of Problem"`
ProblemPrognosis *CWE `hl7:"22,len=705,display=Problem Prognosis"`
IndividualAwarenessOfPrognosis *CWE `hl7:"23,len=705,display=Individual Awareness of Prognosis"`
FamilySignificantOtherAwarenessOfProblemPrognosis ST `hl7:"24,len=200,display=Family/Significant Other Awareness of Problem/Prognosis"`
SecuritySensitivity *CWE `hl7:"25,len=705,display=Security/Sensitivity"`
ProblemSeverity *CWE `hl7:"26,len=705,table=0836,display=Problem Severity"`
ProblemPerspective *CWE `hl7:"27,len=705,table=0838,display=Problem Perspective"`
MoodCode *CNE `hl7:"28,conditional,len=60,table=0725,display=Mood Code"`
}
Problem Details
The problem detail segment contains the data necessary to add, update, correct, and delete the problems of a given individual.
type PRC ¶
type PRC struct {
HL7 HL7Name `hl7:",name=PRC,type=s"`
PrimaryKeyValue CWE `hl7:"1,required,len=250,table=0132,display=Primary Key Value - PRC"`
FacilityID []CWE `hl7:"2,len=250,table=0464,display=Facility ID - PRC"`
Department []CWE `hl7:"3,len=250,table=0184,display=Department"`
ValidPatientClasses []IS `hl7:"4,len=1,table=0004,display=Valid Patient Classes"`
Price []CP `hl7:"5,conditional,len=12,display=Price"`
Formula []ST `hl7:"6,len=200,display=Formula"`
MinimumQuantity NM `hl7:"7,len=4,display=Minimum Quantity"`
MaximumQuantity NM `hl7:"8,len=4,display=Maximum Quantity"`
MinimumPrice *MO `hl7:"9,len=12,display=Minimum Price"`
MaximumPrice *MO `hl7:"10,len=12,display=Maximum Price"`
EffectiveStartDate DTM `hl7:"11,len=24,format=YMDHM,display=Effective Start Date"`
EffectiveEndDate DTM `hl7:"12,len=24,format=YMDHM,display=Effective End Date"`
PriceOverrideFlag IS `hl7:"13,len=1,table=0268,display=Price Override Flag"`
BillingCategory []CWE `hl7:"14,len=250,table=0293,display=Billing Category"`
ChargeableFlag ID `hl7:"15,len=1,table=0136,display=Chargeable Flag"`
ActiveInactiveFlag ID `hl7:"16,len=1,table=0183,display=Active/Inactive Flag"`
Cost *MO `hl7:"17,len=12,display=Cost"`
ChargeOnIndicator IS `hl7:"18,len=1,table=0269,display=Charge On Indicator"`
}
Pricing
The Technical Steward for the PRC segment is Financial Management.
The PRC segment contains the pricing information for the preceding CDM segment's chargeable item. It contains the fields which, for the same chargeable item, might vary depending upon facility or department or patient type. The preceding CDM segment contains the fields which, for one chargeable item, remain the same across facilities, departments, and patient types.
type PRD ¶
type PRD struct {
HL7 HL7Name `hl7:",name=PRD,type=s"`
ProviderRole []CWE `hl7:"1,required,len=705,table=0286,display=Provider Role"`
ProviderName []XPN `hl7:"2,len=250,display=Provider Name"`
ProviderAddress []XAD `hl7:"3,len=250,display=Provider Address"`
ProviderLocation *PL `hl7:"4,len=60,display=Provider Location"`
ProviderCommunicationInformation []XTN `hl7:"5,len=250,display=Provider Communication Information"`
PreferredMethodOfContact *CWE `hl7:"6,len=705,table=0185,display=Preferred Method of Contact"`
ProviderIdentifiers []PLN `hl7:"7,len=100,display=Provider Identifiers"`
EffectiveStartDateOfProviderRole DTM `hl7:"8,len=24,format=YMDHM,display=Effective Start Date of Provider Role"`
EffectiveEndDateOfProviderRole []DTM `hl7:"9,len=24,format=YMDHM,display=Effective End Date of Provider Role"`
ProviderOrganizationNameAndIdentifier *XON `hl7:"10,len=250,display=Provider Organization Name and Identifier"`
ProviderOrganizationAddress []XAD `hl7:"11,len=60,display=Provider Organization Address"`
ProviderOrganizationLocationInformation []PL `hl7:"12,len=60,display=Provider Organization Location Information"`
ProviderOrganizationCommunicationInformation []XTN `hl7:"13,len=250,display=Provider Organization Communication Information"`
ProviderOrganizationMethodOfContact *CWE `hl7:"14,len=705,table=0185,display=Provider Organization Method of Contact"`
}
Provider Data
This segment will be employed as part of a patient referral message and its related transactions. The PRD segment contains data specifically focused on a referral, and it is inter-enterprise in nature. The justification for this new segment comes from the fact that we are dealing with referrals that are external to the facilities that received them. Therefore, using a segment such as the current PV1 would be inadequate for all the return information that may be required by the receiving facility or application. In addition, the PV1 does not always provide information sufficient to enable the external facility to make a complete identification of the referring entity. The information contained in the PRD segment will include the referring provider, the referred-to provider, the referred-to location or service, and the referring provider clinic address.
type PRL ¶
type PRL struct {
HL7 HL7Name `hl7:",name=PRL,len=977,type=d"`
ParentObservationIdentifier CWE `` /* 185-byte string literal not displayed */
ParentObservationSubIdentifier ST `` /* 159-byte string literal not displayed */
ParentObservationValueDescriptor TX `hl7:"3,len=250,display=Contains a descriptor of the parent observation value as specified in the OBX-5 of the parent result."`
}
Parent Result Link
Uniquely identifies the parent results OBX segment related to the current order, together with the information in OBR-29 - Parent.
type PRR_PC5 ¶
type PRR_PC5 struct {
HL7 HL7Name `hl7:",name=PRR_PC5,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
Patient []PRR_PC5_Patient `hl7:",required,display=Patient"`
}
Patient Problem Response
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by PRR (a response from the system responsible for maintaining the problem information).
type PRR_PC5_Goal ¶
type PRR_PC5_Goal struct {
HL7 HL7Name `hl7:",name=PRR_PC5_Goal,type=tg"`
GOL *GOL `hl7:"20,required,display=Goal Detail"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
VAR []VAR `hl7:"22,display=Variance"`
GoalRole []PRR_PC5_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PRR_PC5_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PRR_PC5_GoalObservation ¶
type PRR_PC5_GoalObservation struct {
HL7 HL7Name `hl7:",name=PRR_PC5_GoalObservation,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
GoalObservation
type PRR_PC5_GoalRole ¶
type PRR_PC5_GoalRole struct {
HL7 HL7Name `hl7:",name=PRR_PC5_GoalRole,type=tg"`
ROL *ROL `hl7:"23,required,display=Role"`
VAR []VAR `hl7:"24,display=Variance"`
}
GoalRole
type PRR_PC5_Order ¶
type PRR_PC5_Order struct {
HL7 HL7Name `hl7:",name=PRR_PC5_Order,type=tg"`
ORC *ORC `hl7:"27,required,display=Common Order"`
OrderDetail *PRR_PC5_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PRR_PC5_OrderDetail ¶
type PRR_PC5_OrderDetail struct {
HL7 HL7Name `hl7:",name=PRR_PC5_OrderDetail,type=tg"`
OrderDetailSegment *PRR_PC5_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"34,display=Notes and Comments"`
VAR []VAR `hl7:"35,display=Variance"`
OrderObservation []PRR_PC5_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PRR_PC5_OrderDetailSegment ¶
type PRR_PC5_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PRR_PC5_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"28,conditional,display=Observation Request"`
RQD *RQD `hl7:"29,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"30,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"31,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"32,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"33,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PRR_PC5_OrderObservation ¶
type PRR_PC5_OrderObservation struct {
HL7 HL7Name `hl7:",name=PRR_PC5_OrderObservation,type=tg"`
OBX *OBX `hl7:"36,required,display=Observation/Result"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
VAR []VAR `hl7:"38,display=Variance"`
}
OrderObservation
type PRR_PC5_Patient ¶
type PRR_PC5_Patient struct {
HL7 HL7Name `hl7:",name=PRR_PC5_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PatientVisit *PRR_PC5_PatientVisit `hl7:",display=Patient Visit"`
Problem []PRR_PC5_Problem `hl7:",required,display=Problem"`
}
Patient
type PRR_PC5_PatientVisit ¶
type PRR_PC5_PatientVisit struct {
HL7 HL7Name `hl7:",name=PRR_PC5_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type PRR_PC5_Problem ¶
type PRR_PC5_Problem struct {
HL7 HL7Name `hl7:",name=PRR_PC5_Problem,type=tg"`
PRB *PRB `hl7:"11,required,display=Problem Details"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
VAR []VAR `hl7:"13,display=Variance"`
ProblemRole []PRR_PC5_ProblemRole `hl7:",display=Problem Role"`
ProblemPathway []PRR_PC5_ProblemPathway `hl7:",display=Problem Pathway"`
ProblemObservation []PRR_PC5_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PRR_PC5_Goal `hl7:",display=Goal"`
Order []PRR_PC5_Order `hl7:",display=Order"`
}
Problem
type PRR_PC5_ProblemObservation ¶
type PRR_PC5_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PRR_PC5_ProblemObservation,type=tg"`
OBX *OBX `hl7:"18,required,display=Observation/Result"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
ProblemObservation
type PRR_PC5_ProblemPathway ¶
type PRR_PC5_ProblemPathway struct {
HL7 HL7Name `hl7:",name=PRR_PC5_ProblemPathway,type=tg"`
PTH *PTH `hl7:"16,required,display=Pathway"`
VAR []VAR `hl7:"17,display=Variance"`
}
ProblemPathway
type PRR_PC5_ProblemRole ¶
type PRR_PC5_ProblemRole struct {
HL7 HL7Name `hl7:",name=PRR_PC5_ProblemRole,type=tg"`
ROL *ROL `hl7:"14,required,display=Role"`
VAR []VAR `hl7:"15,display=Variance"`
}
ProblemRole
type PSG ¶
type PSG struct {
HL7 HL7Name `hl7:",name=PSG,type=s"`
ProviderProductServiceGroupNumber EI `hl7:"1,required,len=73,display=Provider Product/Service Group Number"`
PayerProductServiceGroupNumber *EI `hl7:"2,len=73,display=Payer Product/Service Group Number"`
ProductServiceGroupSequenceNumber SI `hl7:"3,required,len=4,display=Product/Service Group Sequence Number"`
AdjudicateAsGroup ID `hl7:"4,required,len=1,table=0136,display=Adjudicate as Group"`
ProductServiceGroupBilledAmount CP `hl7:"5,required,len=254,display=Product/Service Group Billed Amount"`
ProductServiceGroupDescription ST `hl7:"6,required,len=254,display=Product/Service Group Description"`
}
Product/Service Group
The Product/Service Group segment is used to form a logical grouping of Product/Service Line Items, Patients and Response Summaries for a particular Invoice. For example, a Product/Service Group can be used to group all Product/Service Line Items that must be adjudicated as a group in order to be paid.
type PSH ¶
type PSH struct {
HL7 HL7Name `hl7:",name=PSH,type=s"`
ReportType ST `hl7:"1,required,len=60,display=Report Type"`
ReportFormIdentifier ST `hl7:"2,len=60,display=Report Form Identifier"`
ReportDate DTM `hl7:"3,required,len=24,format=YMDHM,display=Report Date"`
ReportIntervalStartDate DTM `hl7:"4,len=24,format=YMDHM,display=Report Interval Start Date"`
ReportIntervalEndDate DTM `hl7:"5,len=24,format=YMDHM,display=Report Interval End Date"`
QuantityManufactured *CQ `hl7:"6,len=722,display=Quantity Manufactured"`
QuantityDistributed *CQ `hl7:"7,len=722,display=Quantity Distributed"`
QuantityDistributedMethod ID `hl7:"8,len=1,table=0329,display=Quantity Distributed Method"`
QuantityDistributedComment FT `hl7:"9,len=600,display=Quantity Distributed Comment"`
QuantityInUse *CQ `hl7:"10,len=722,display=Quantity in Use"`
QuantityInUseMethod ID `hl7:"11,len=1,table=0329,display=Quantity in Use Method"`
QuantityInUseComment FT `hl7:"12,len=600,display=Quantity in Use Comment"`
NumberOfProductExperienceReportsFiledByFacility []NM `hl7:"13,max=8,len=16,display=Number of Product Experience Reports Filed by Facility"`
NumberOfProductExperienceReportsFiledByDistributor []NM `hl7:"14,max=8,len=16,display=Number of Product Experience Reports Filed by Distributor"`
}
Product Summary Header
type PSL ¶
type PSL struct {
HL7 HL7Name `hl7:",name=PSL,type=s"`
ProviderProductServiceLineItemNumber EI `hl7:"1,required,len=73,display=Provider Product/Service Line Item Number"`
PayerProductServiceLineItemNumber *EI `hl7:"2,len=73,display=Payer Product/Service Line Item Number"`
ProductServiceLineItemSequenceNumber SI `hl7:"3,required,len=4,display=Product/Service Line Item Sequence Number"`
ProviderTrackingID *EI `hl7:"4,len=20,display=Provider Tracking ID"`
PayerTrackingID *EI `hl7:"5,len=20,display=Payer Tracking ID"`
ProductServiceLineItemStatus CWE `hl7:"6,required,len=2,table=0559,display=Product/Service Line Item Status"`
ProductServiceCode CWE `hl7:"7,required,len=177,table=0879,display=Product/Service Code"`
ProductServiceCodeModifier []CWE `hl7:"8,max=5,len=177,table=0880,display=Product/Service Code Modifier"`
ProductServiceCodeDescription ST `hl7:"9,len=80,display=Product/Service Code Description"`
ProductServiceEffectiveDate DTM `hl7:"10,conditional,len=24,format=YMDHM,display=Product/Service Effective Date"`
ProductServiceExpirationDate DTM `hl7:"11,len=24,format=YMDHM,display=Product/Service Expiration Date"`
ProductServiceQuantity *CQ `hl7:"12,conditional,len=222,display=Product/Service Quantity"`
ProductServiceUnitCost *CP `hl7:"13,conditional,len=254,display=Product/Service Unit Cost"`
NumberOfItemsPerUnit NM `hl7:"14,conditional,len=10,display=Number of Items per Unit"`
ProductServiceGrossAmount *CP `hl7:"15,conditional,len=254,display=Product/Service Gross Amount"`
ProductServiceBilledAmount *CP `hl7:"16,conditional,len=254,display=Product/Service Billed Amount"`
ProductServiceClarificationCodeType []IS `hl7:"17,max=20,len=10,table=0561,display=Product/Service Clarification Code Type"`
ProductServiceClarificationCodeValue []ST `hl7:"18,max=20,len=40,display=Product/Service Clarification Code Value"`
HealthDocumentReferenceIdentifier []EI `hl7:"19,max=5,len=73,display=Health Document Reference Identifier"`
ProcessingConsiderationCode []IS `hl7:"20,max=20,len=10,table=0562,display=Processing Consideration Code"`
RestrictedDisclosureIndicator ID `hl7:"21,required,len=2,table=0532,display=Restricted Disclosure Indicator"`
RelatedProductServiceCodeIndicator *CWE `hl7:"22,len=177,table=0879,display=Related Product/Service Code Indicator"`
ProductServiceAmountForPhysician *CP `hl7:"23,len=254,display=Product/Service Amount for Physician"`
ProductServiceCostFactor NM `hl7:"24,len=5,display=Product/Service Cost Factor"`
CostCenter *CX `hl7:"25,len=250,display=Cost Center"`
BillingPeriod *DR `hl7:"26,len=49,display=Billing Period"`
DaysWithoutBilling NM `hl7:"27,len=5,display=Days without Billing"`
SessionNo NM `hl7:"28,len=4,display=Session-No"`
ExecutingPhysicianID *XCN `hl7:"29,len=20,display=Executing Physician ID"`
ResponsiblePhysicianID *XCN `hl7:"30,len=20,display=Responsible Physician ID"`
RoleExecutingPhysician *CWE `hl7:"31,len=10,table=0881,display=Role Executing Physician"`
MedicalRoleExecutingPhysician *CWE `hl7:"32,len=10,table=0882,display=Medical Role Executing Physician"`
SideOfBody *CWE `hl7:"33,len=3,table=0894,display=Side of body"`
NumberOfTPsPP NM `hl7:"34,len=6,display=Number of TP's PP"`
TPValuePP *CP `hl7:"35,len=6,display=TP-Value PP"`
InternalScalingFactorPP NM `hl7:"36,len=4,display=Internal Scaling Factor PP"`
ExternalScalingFactorPP NM `hl7:"37,len=4,display=External Scaling Factor PP"`
AmountPP *CP `hl7:"38,len=7,display=Amount PP"`
NumberOfTPsTechnicalPart NM `hl7:"39,len=6,display=Number of TP's Technical Part"`
TPValueTechnicalPart *CP `hl7:"40,len=6,display=TP-Value Technical Part"`
InternalScalingFactorTechnicalPart NM `hl7:"41,len=4,display=Internal Scaling Factor Technical Part"`
ExternalScalingFactorTechnicalPart NM `hl7:"42,len=4,display=External Scaling Factor Technical Part"`
AmountTechnicalPart *CP `hl7:"43,len=7,display=Amount Technical Part"`
TotalAmountProfessionalPartTechnicalPart *CP `hl7:"44,len=8,display=Total Amount Professional Part + Technical Part"`
VATRate NM `hl7:"45,len=3,display=VAT-Rate"`
MainService ID `hl7:"46,len=20,display=Main-Service"`
Validation ID `hl7:"47,len=1,table=0136,display=Validation"`
Comment ST `hl7:"48,len=255,display=Comment"`
}
Product/Service Line Item
The Product/Service Line Item segment is used to identify individual product/service items that typically are aggregated into an Invoice. Each instance of a Product/Service Line Item corresponds to a unique product delivered or service rendered.
type PSS ¶
type PSS struct {
HL7 HL7Name `hl7:",name=PSS,type=s"`
ProviderProductServiceSectionNumber EI `hl7:"1,required,len=73,display=Provider Product/Service Section Number"`
PayerProductServiceSectionNumber *EI `hl7:"2,len=73,display=Payer Product/Service Section Number"`
ProductServiceSectionSequenceNumber SI `hl7:"3,required,len=4,display=Product/Service Section Sequence Number"`
BilledAmount CP `hl7:"4,required,len=254,display=Billed Amount"`
SectionDescriptionOrHeading ST `hl7:"5,required,len=254,display=Section Description or Heading"`
}
Product/Service Section
The Product/Service Section segment is used to form a logical grouping of Product/Service Group segments, Patients and Response Summaries for a particular Invoice.
type PT ¶
type PT struct {
HL7 HL7Name `hl7:",name=PT,len=3,type=d"`
ProcessingID ID `` /* 187-byte string literal not displayed */
ProcessingMode ID `` /* 184-byte string literal not displayed */
}
Processing Type
This data type indicates whether to process a message as defined in HL7 Application (level 7) Processing rules.
type PTA ¶
type PTA struct {
HL7 HL7Name `hl7:",name=PTA,len=56,type=d"`
PolicyType IS `hl7:"1,required,len=5,table=0147,display=Specifies the policy type."`
AmountClass IS `hl7:"2,len=9,table=0193,display=Specifies the amount quantity class."`
MoneyOrPercentageQuantity NM `hl7:"3,len=16,display=Specifies the currency or percentage quantity."`
MoneyOrPercentage MOP `hl7:"4,required,len=23,display=specifies an amount that may be either currency or a percentage."`
}
Policy Type and Amount
This data type specifies the policy type and amount covered by the insurance.
type PTH ¶
type PTH struct {
HL7 HL7Name `hl7:",name=PTH,type=s"`
ActionCode ID `hl7:"1,required,len=2,table=0287,display=Action Code"`
PathwayID CWE `hl7:"2,required,len=705,display=Pathway ID"`
PathwayInstanceID EI `hl7:"3,required,len=60,display=Pathway Instance ID"`
PathwayEstablishedDateTime DTM `hl7:"4,required,len=24,format=YMDHM,display=Pathway Established Date/Time"`
PathwayLifeCycleStatus *CWE `hl7:"5,len=705,display=Pathway Life Cycle Status"`
ChangePathwayLifeCycleStatusDateTime DTM `hl7:"6,conditional,len=24,format=YMDHM,display=Change Pathway Life Cycle Status Date/Time"`
MoodCode *CNE `hl7:"7,conditional,len=60,table=0725,display=Mood Code"`
}
Pathway
The pathway segment contains the data necessary to add, update, correct, and delete from the record pathways that are utilized to address an individual's health care.
type PTR_PCF ¶
type PTR_PCF struct {
HL7 HL7Name `hl7:",name=PTR_PCF,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
QRD *QRD `hl7:"7,required,display=Original-Style Query Definition"`
Patient []PTR_PCF_Patient `hl7:",required,display=Patient"`
}
Patient Pathway (Problem-Oriented) Response
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by PTR (a response from the system responsible for maintaining the problem-oriented pathway information).
type PTR_PCF_Goal ¶
type PTR_PCF_Goal struct {
HL7 HL7Name `hl7:",name=PTR_PCF_Goal,type=tg"`
GOL *GOL `hl7:"23,required,display=Goal Detail"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
VAR []VAR `hl7:"25,display=Variance"`
GoalRole []PTR_PCF_GoalRole `hl7:",display=Goal Role"`
GoalObservation []PTR_PCF_GoalObservation `hl7:",display=Goal Observation"`
}
Goal
type PTR_PCF_GoalObservation ¶
type PTR_PCF_GoalObservation struct {
HL7 HL7Name `hl7:",name=PTR_PCF_GoalObservation,type=tg"`
OBX *OBX `hl7:"28,required,display=Observation/Result"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
GoalObservation
type PTR_PCF_GoalRole ¶
type PTR_PCF_GoalRole struct {
HL7 HL7Name `hl7:",name=PTR_PCF_GoalRole,type=tg"`
ROL *ROL `hl7:"26,required,display=Role"`
VAR []VAR `hl7:"27,display=Variance"`
}
GoalRole
type PTR_PCF_Order ¶
type PTR_PCF_Order struct {
HL7 HL7Name `hl7:",name=PTR_PCF_Order,type=tg"`
ORC *ORC `hl7:"30,required,display=Common Order"`
OrderDetail *PTR_PCF_OrderDetail `hl7:",display=Order Detail"`
}
Order
type PTR_PCF_OrderDetail ¶
type PTR_PCF_OrderDetail struct {
HL7 HL7Name `hl7:",name=PTR_PCF_OrderDetail,type=tg"`
OrderDetailSegment *PTR_PCF_OrderDetailSegment `hl7:",required,display=Order Detail Segment"`
NTE []NTE `hl7:"37,display=Notes and Comments"`
VAR []VAR `hl7:"38,display=Variance"`
OrderObservation []PTR_PCF_OrderObservation `hl7:",display=Order Observation"`
}
OrderDetail
type PTR_PCF_OrderDetailSegment ¶
type PTR_PCF_OrderDetailSegment struct {
HL7 HL7Name `hl7:",name=PTR_PCF_OrderDetailSegment,type=tg"`
OBR *OBR `hl7:"31,conditional,display=Observation Request"`
RQD *RQD `hl7:"32,conditional,display=Requisition Detail"`
RQ1 *RQ1 `hl7:"33,conditional,display=Requisition Detail-1"`
RXO *RXO `hl7:"34,conditional,display=Pharmacy/Treatment Order"`
ODS *ODS `hl7:"35,conditional,display=Dietary Orders- Supplements- and Preferences"`
ODT *ODT `hl7:"36,conditional,display=Diet Tray Instructions"`
}
OrderDetailSegment
type PTR_PCF_OrderObservation ¶
type PTR_PCF_OrderObservation struct {
HL7 HL7Name `hl7:",name=PTR_PCF_OrderObservation,type=tg"`
OBX *OBX `hl7:"39,required,display=Observation/Result"`
NTE []NTE `hl7:"40,display=Notes and Comments"`
VAR []VAR `hl7:"41,display=Variance"`
}
OrderObservation
type PTR_PCF_Pathway ¶
type PTR_PCF_Pathway struct {
HL7 HL7Name `hl7:",name=PTR_PCF_Pathway,type=tg"`
PTH *PTH `hl7:"11,required,display=Pathway"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
VAR []VAR `hl7:"13,display=Variance"`
PathwayRole []PTR_PCF_PathwayRole `hl7:",display=Pathway Role"`
Problem []PTR_PCF_Problem `hl7:",display=Problem"`
}
Pathway
type PTR_PCF_PathwayRole ¶
type PTR_PCF_PathwayRole struct {
HL7 HL7Name `hl7:",name=PTR_PCF_PathwayRole,type=tg"`
ROL *ROL `hl7:"14,required,display=Role"`
VAR []VAR `hl7:"15,display=Variance"`
}
PathwayRole
type PTR_PCF_Patient ¶
type PTR_PCF_Patient struct {
HL7 HL7Name `hl7:",name=PTR_PCF_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PatientVisit *PTR_PCF_PatientVisit `hl7:",display=Patient Visit"`
Pathway []PTR_PCF_Pathway `hl7:",required,display=Pathway"`
}
Patient
type PTR_PCF_PatientVisit ¶
type PTR_PCF_PatientVisit struct {
HL7 HL7Name `hl7:",name=PTR_PCF_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type PTR_PCF_Problem ¶
type PTR_PCF_Problem struct {
HL7 HL7Name `hl7:",name=PTR_PCF_Problem,type=tg"`
PRB *PRB `hl7:"16,required,display=Problem Details"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
VAR []VAR `hl7:"18,display=Variance"`
ProblemRole []PTR_PCF_ProblemRole `hl7:",display=Problem Role"`
ProblemObservation []PTR_PCF_ProblemObservation `hl7:",display=Problem Observation"`
Goal []PTR_PCF_Goal `hl7:",display=Goal"`
Order []PTR_PCF_Order `hl7:",display=Order"`
}
Problem
type PTR_PCF_ProblemObservation ¶
type PTR_PCF_ProblemObservation struct {
HL7 HL7Name `hl7:",name=PTR_PCF_ProblemObservation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
ProblemObservation
type PTR_PCF_ProblemRole ¶
type PTR_PCF_ProblemRole struct {
HL7 HL7Name `hl7:",name=PTR_PCF_ProblemRole,type=tg"`
ROL *ROL `hl7:"19,required,display=Role"`
VAR []VAR `hl7:"20,display=Variance"`
}
ProblemRole
type PV1 ¶
type PV1 struct {
HL7 HL7Name `hl7:",name=PV1,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - PV1"`
PatientClass IS `hl7:"2,required,len=1,table=0004,display=Patient Class"`
AssignedPatientLocation *PL `hl7:"3,len=80,display=Assigned Patient Location"`
AdmissionType IS `hl7:"4,len=2,table=0007,display=Admission Type"`
PreadmitNumber *CX `hl7:"5,len=250,display=Preadmit Number"`
PriorPatientLocation *PL `hl7:"6,len=80,display=Prior Patient Location"`
AttendingDoctor []XCN `hl7:"7,len=250,table=0010,display=Attending Doctor"`
ReferringDoctor []XCN `hl7:"8,len=250,table=0010,display=Referring Doctor"`
ConsultingDoctor []XCN `hl7:"9,len=250,table=0010,display=Consulting Doctor"`
HospitalService IS `hl7:"10,len=3,table=0069,display=Hospital Service"`
TemporaryLocation *PL `hl7:"11,len=80,display=Temporary Location"`
PreadmitTestIndicator IS `hl7:"12,len=2,table=0087,display=Preadmit Test Indicator"`
ReAdmissionIndicator IS `hl7:"13,len=2,table=0092,display=Re-admission Indicator"`
AdmitSource IS `hl7:"14,len=6,table=0023,display=Admit Source"`
AmbulatoryStatus []IS `hl7:"15,len=2,table=0009,display=Ambulatory Status"`
VIPIndicator IS `hl7:"16,len=2,table=0099,display=VIP Indicator"`
AdmittingDoctor []XCN `hl7:"17,len=250,table=0010,display=Admitting Doctor"`
PatientType IS `hl7:"18,len=2,table=0018,display=Patient Type"`
VisitNumber *CX `hl7:"19,len=250,display=Visit Number"`
FinancialClass []FC `hl7:"20,len=50,display=Financial Class"`
ChargePriceIndicator IS `hl7:"21,len=2,table=0032,display=Charge Price Indicator"`
CourtesyCode IS `hl7:"22,len=2,table=0045,display=Courtesy Code"`
CreditRating IS `hl7:"23,len=2,table=0046,display=Credit Rating"`
ContractCode []IS `hl7:"24,len=2,table=0044,display=Contract Code"`
ContractEffectiveDate []DT `hl7:"25,len=8,format=YMD,display=Contract Effective Date"`
ContractAmount []NM `hl7:"26,len=12,display=Contract Amount"`
ContractPeriod []NM `hl7:"27,len=3,display=Contract Period"`
InterestCode IS `hl7:"28,len=2,table=0073,display=Interest Code"`
TransferToBadDebtCode IS `hl7:"29,len=4,table=0110,display=Transfer to Bad Debt Code"`
TransferToBadDebtDate DT `hl7:"30,len=8,format=YMD,display=Transfer to Bad Debt Date"`
BadDebtAgencyCode IS `hl7:"31,len=10,table=0021,display=Bad Debt Agency Code"`
BadDebtTransferAmount NM `hl7:"32,len=12,display=Bad Debt Transfer Amount"`
BadDebtRecoveryAmount NM `hl7:"33,len=12,display=Bad Debt Recovery Amount"`
DeleteAccountIndicator IS `hl7:"34,len=1,table=0111,display=Delete Account Indicator"`
DeleteAccountDate DT `hl7:"35,len=8,format=YMD,display=Delete Account Date"`
DischargeDisposition IS `hl7:"36,len=3,table=0112,display=Discharge Disposition"`
DischargedToLocation *DLD `hl7:"37,len=47,display=Discharged to Location"`
DietType *CWE `hl7:"38,len=705,table=0114,display=Diet Type"`
ServicingFacility IS `hl7:"39,len=2,table=0115,display=Servicing Facility"`
BedStatus IS `hl7:"40,len=1,table=0116,display=Bed Status"`
AccountStatus IS `hl7:"41,len=2,table=0117,display=Account Status"`
PendingLocation *PL `hl7:"42,len=80,display=Pending Location"`
PriorTemporaryLocation *PL `hl7:"43,len=80,display=Prior Temporary Location"`
AdmitDateTime DTM `hl7:"44,len=24,format=YMDHM,display=Admit Date/Time"`
DischargeDateTime DTM `hl7:"45,len=24,format=YMDHM,display=Discharge Date/Time"`
CurrentPatientBalance NM `hl7:"46,len=12,display=Current Patient Balance"`
TotalCharges NM `hl7:"47,len=12,display=Total Charges"`
TotalAdjustments NM `hl7:"48,len=12,display=Total Adjustments"`
TotalPayments NM `hl7:"49,len=12,display=Total Payments"`
AlternateVisitID *CX `hl7:"50,len=250,display=Alternate Visit ID"`
VisitIndicator IS `hl7:"51,len=1,table=0326,display=Visit Indicator"`
OtherHealthcareProvider []XCN `hl7:"52,len=250,table=0010,display=Other Healthcare Provider"`
}
Patient Visit
The PV1 segment is used by Registration/Patient Administration applications to communicate information on an account or visit-specific basis. The default is to send account level data. To use this segment for visit level data PV1-51 - Visit Indicator must be valued to "V". The value of PV-51 affects the level of data being sent on the PV1, PV2, and any other segments that are part of the associated PV1 hierarchy (e.g., ROL, DG1, or OBX).
type PV2 ¶
type PV2 struct {
HL7 HL7Name `hl7:",name=PV2,type=s"`
PriorPendingLocation *PL `hl7:"1,conditional,len=80,display=Prior Pending Location"`
AccommodationCode *CWE `hl7:"2,len=705,table=0129,display=Accommodation Code"`
AdmitReason *CWE `hl7:"3,len=705,display=Admit Reason"`
TransferReason *CWE `hl7:"4,len=705,display=Transfer Reason"`
PatientValuables []ST `hl7:"5,len=25,display=Patient Valuables"`
PatientValuablesLocation ST `hl7:"6,len=25,display=Patient Valuables Location"`
VisitUserCode []IS `hl7:"7,len=2,table=0130,display=Visit User Code"`
ExpectedAdmitDateTime DTM `hl7:"8,len=24,format=YMDHM,display=Expected Admit Date/Time"`
ExpectedDischargeDateTime DTM `hl7:"9,len=24,format=YMDHM,display=Expected Discharge Date/Time"`
EstimatedLengthOfInpatientStay NM `hl7:"10,len=3,display=Estimated Length of Inpatient Stay"`
ActualLengthOfInpatientStay NM `hl7:"11,len=3,display=Actual Length of Inpatient Stay"`
VisitDescription ST `hl7:"12,len=50,display=Visit Description"`
ReferralSourceCode []XCN `hl7:"13,len=250,display=Referral Source Code"`
PreviousServiceDate DT `hl7:"14,len=8,format=YMD,display=Previous Service Date"`
EmploymentIllnessRelatedIndicator ID `hl7:"15,len=1,table=0136,display=Employment Illness Related Indicator"`
PurgeStatusCode IS `hl7:"16,len=1,table=0213,display=Purge Status Code"`
PurgeStatusDate DT `hl7:"17,len=8,format=YMD,display=Purge Status Date"`
SpecialProgramCode IS `hl7:"18,len=2,table=0214,display=Special Program Code"`
RetentionIndicator ID `hl7:"19,len=1,table=0136,display=Retention Indicator"`
ExpectedNumberOfInsurancePlans NM `hl7:"20,len=1,display=Expected Number of Insurance Plans"`
VisitPublicityCode IS `hl7:"21,len=1,table=0215,display=Visit Publicity Code"`
VisitProtectionIndicator ID `hl7:"22,len=1,table=0136,display=Visit Protection Indicator"`
ClinicOrganizationName []XON `hl7:"23,len=250,display=Clinic Organization Name"`
PatientStatusCode IS `hl7:"24,len=2,table=0216,display=Patient Status Code"`
VisitPriorityCode IS `hl7:"25,len=1,table=0217,display=Visit Priority Code"`
PreviousTreatmentDate DT `hl7:"26,len=8,format=YMD,display=Previous Treatment Date"`
ExpectedDischargeDisposition IS `hl7:"27,len=2,table=0112,display=Expected Discharge Disposition"`
SignatureOnFileDate DT `hl7:"28,len=8,format=YMD,display=Signature on File Date"`
FirstSimilarIllnessDate DT `hl7:"29,len=8,format=YMD,display=First Similar Illness Date"`
PatientChargeAdjustmentCode *CWE `hl7:"30,len=705,table=0218,display=Patient Charge Adjustment Code"`
RecurringServiceCode IS `hl7:"31,len=2,table=0219,display=Recurring Service Code"`
BillingMediaCode ID `hl7:"32,len=1,table=0136,display=Billing Media Code"`
ExpectedSurgeryDateAndTime DTM `hl7:"33,len=24,format=YMDHM,display=Expected Surgery Date and Time"`
MilitaryPartnershipCode ID `hl7:"34,len=1,table=0136,display=Military Partnership Code"`
MilitaryNonAvailabilityCode ID `hl7:"35,len=1,table=0136,display=Military Non-Availability Code"`
NewbornBabyIndicator ID `hl7:"36,len=1,table=0136,display=Newborn Baby Indicator"`
BabyDetainedIndicator ID `hl7:"37,len=1,table=0136,display=Baby Detained Indicator"`
ModeOfArrivalCode *CWE `hl7:"38,len=705,table=0430,display=Mode of Arrival Code"`
RecreationalDrugUseCode []CWE `hl7:"39,len=705,table=0431,display=Recreational Drug Use Code"`
AdmissionLevelOfCareCode *CWE `hl7:"40,len=705,table=0432,display=Admission Level of Care Code"`
PrecautionCode []CWE `hl7:"41,len=705,table=0433,display=Precaution Code"`
PatientConditionCode *CWE `hl7:"42,len=705,table=0434,display=Patient Condition Code"`
LivingWillCode IS `hl7:"43,len=2,table=0315,display=Living Will Code"`
OrganDonorCode IS `hl7:"44,len=2,table=0316,display=Organ Donor Code"`
AdvanceDirectiveCode []CWE `hl7:"45,conditional,len=705,table=0435,display=Advance Directive Code"`
PatientStatusEffectiveDate DT `hl7:"46,len=8,format=YMD,display=Patient Status Effective Date"`
ExpectedLOAReturnDateTime DTM `hl7:"47,conditional,len=24,format=YMDHM,display=Expected LOA Return Date/Time"`
ExpectedPreAdmissionTestingDateTime DTM `hl7:"48,len=24,format=YMDHM,display=Expected Pre-admission Testing Date/Time"`
NotifyClergyCode []IS `hl7:"49,len=20,table=0534,display=Notify Clergy Code"`
AdvanceDirectiveLastVerifiedDate DT `hl7:"50,len=8,format=YMD,display=Advance Directive Last Verified Date"`
}
Patient Visit - Additional Information
The PV2 segment is a continuation of information contained on the PV1 segment.
type PYE ¶
type PYE struct {
HL7 HL7Name `hl7:",name=PYE,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID – PYE"`
PayeeType IS `hl7:"2,required,len=6,table=0557,display=Payee Type"`
PayeeRelationshipToInvoicePatient IS `hl7:"3,conditional,len=2,table=0558,display=Payee Relationship to Invoice (Patient)"`
PayeeIdentificationList []XON `hl7:"4,conditional,max=5,len=183,display=Payee Identification List"`
PayeePersonName []XPN `hl7:"5,conditional,max=4,len=466,display=Payee Person Name"`
PayeeAddress []XAD `hl7:"6,conditional,max=4,len=235,display=Payee Address"`
PaymentMethod IS `hl7:"7,len=80,table=0570,display=Payment Method"`
}
Payee Information
This segment is used to define payee information.
type QAK ¶
type QAK struct {
HL7 HL7Name `hl7:",name=QAK,type=s"`
QueryTag ST `hl7:"1,conditional,len=32,display=Query Tag"`
QueryResponseStatus ID `hl7:"2,len=2,table=0208,display=Query Response Status"`
MessageQueryName *CWE `hl7:"3,len=250,table=0471,display=Message Query Name"`
HitCount NM `hl7:"4,len=10,display=Hit Count"`
ThisPayload NM `hl7:"5,len=10,display=This payload"`
HitsRemaining NM `hl7:"6,len=10,display=Hits remaining"`
}
Query Acknowledgment
The QAK segment contains information sent with responses to a query. Although the QAK segment is required in the responses to the enhanced queries (see section Error! Reference source not found. , "Error! Reference source not found."), it may appear as an optional segment placed after the (optional) ERR segment in any query response (message) to any original mode query.
type QBP_E03 ¶
type QBP_E03 struct {
HL7 HL7Name `hl7:",name=QBP_E03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
QueryInformation *QBP_E03_QueryInformation `hl7:",required,display=Query Information"`
}
HealthCare Services Invoice Status Query
This message is used to query the status of a HealthCare Services Invoice. There are 3 types of queries handled by this message: 1) a specific Invoice, 2) a specific Product/Service Group or 3) a specific Product/Service Line Item. If a Provider wants to obtain information on a group of invoices (e.g., submitted in a date range), each individual Invoice must be queried.
type QBP_E03_QueryInformation ¶
type QBP_E03_QueryInformation struct {
HL7 HL7Name `hl7:",name=QBP_E03_QueryInformation,type=tg"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
}
QueryInformation
type QBP_E22 ¶
type QBP_E22 struct {
HL7 HL7Name `hl7:",name=QBP_E22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
Query *QBP_E22_Query `hl7:",required,display=Query"`
}
Query Authorization Request Status
This message is used to query the status of an Authorization Request. There are 2 types of queries handled by this message: 1) a specific Authorization Request or 2) a specific Product/Service Line Item. If a Provider wants to obtain information on a group of Authorization Requests (e.g., submitted in a date range), each individual Authorization Request must be queried.
type QBP_E22_Query ¶
type QBP_E22_Query struct {
HL7 HL7Name `hl7:",name=QBP_E22_Query,type=tg"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
}
Query
type QBP_K13 ¶
type QBP_K13 struct {
HL7 HL7Name `hl7:",name=QBP_K13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"3,display=Error"`
QAK *QAK `hl7:"4,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"5,required,display=Query Parameter Definition"`
RowDefinition *QBP_K13_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"8,display=Continuation Pointer"`
}
Query by parameter
type QBP_K13_RowDefinition ¶
type QBP_K13_RowDefinition struct {
HL7 HL7Name `hl7:",name=QBP_K13_RowDefinition,type=tg"`
RDF *RDF `hl7:"6,required,display=Table Row Definition"`
RDT []RDT `hl7:"7,display=Table Row Data"`
}
RowDefinition
type QBP_Q11 ¶
type QBP_Q11 struct {
HL7 HL7Name `hl7:",name=QBP_Q11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,display=Event Type"`
QPD *QPD `hl7:"5,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Query by Parameter Requesting an RSP Segment Pattern Response
The QBP_Q11 structure supports a Segment Pattern Response and contains the MSH, QPD, RCP, and DSC segments. Its default trigger event is Q11. A standard or site-defined query may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined query, that value must begin with Z.
type QBP_Q13 ¶
type QBP_Q13 struct {
HL7 HL7Name `hl7:",name=QBP_Q13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,display=Event Type"`
QPD *QPD `hl7:"5,required,display=Query Parameter Definition"`
RDF *RDF `hl7:"6,display=Table Row Definition"`
RCP *RCP `hl7:"7,required,display=Response Control Parameter"`
DSC *DSC `hl7:"8,display=Continuation Pointer"`
}
Query by Parameter Requesting an RTB Tabular Response
The QBP_Q13 structure supports a Tabular Response and contains the MSH, RDF, RCP, and DSC segments. Its default trigger event is Q13. A standard or site-defined query may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined query, that value must begin with Z.
type QBP_Q15 ¶
type QBP_Q15 struct {
HL7 HL7Name `hl7:",name=QBP_Q15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EVN *EVN `hl7:"4,display=Event Type"`
QPD *QPD `hl7:"5,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Query by Parameter Requesting an RDY Display Response
The QBP_Q15 structure supports a Display Response and contains the MSH, QPD, RCP, and DSC segments. Its default trigger event is Q15. A standard or site-defined query may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined query, that value must begin with Z.
type QBP_Q21 ¶
type QBP_Q21 struct {
HL7 HL7Name `hl7:",name=QBP_Q21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Get Person Demographics
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of an identifier for a person, and the response of the demographics for that person.
type QBP_Q22 ¶
type QBP_Q22 struct {
HL7 HL7Name `hl7:",name=QBP_Q22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Find Candidates Query
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of a set of demographics for a person, and the response is the list of candidates considered by the MPI to match that set.
Each returned person, specified by a PID segment, can also have an optional QRI - Query Response Instance segment containing information about the quality of the match.
type QBP_Q23 ¶
type QBP_Q23 struct {
HL7 HL7Name `hl7:",name=QBP_Q23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Get Corresponding Identifiers Query
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of an identifier for a person, and the response is a list of identifiers for that person from the domains specified.
type QBP_Q24 ¶
type QBP_Q24 struct {
HL7 HL7Name `hl7:",name=QBP_Q24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Allocate Identifiers Query
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of domains in which identifiers should be allocated. The response is new identifiers in those domains.
This event is not meant to cause the creation of a new person record, or to bind identifiers to a particular person record. The events A28 - Add person information and A24 - Link patient information should be used for that purpose. This event is meant to simply reserve the use of identifiers.
type QBP_Q25 ¶
type QBP_Q25 struct {
HL7 HL7Name `hl7:",name=QBP_Q25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Personnel Information by Segment Query
The purpose of this query/response pair is to retrieve all available personnel information based upon the values of one or more commonly used search parameter.
type QBP_Q31 ¶
type QBP_Q31 struct {
HL7 HL7Name `hl7:",name=QBP_Q31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy Query - Dispense History
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z73 ¶
type QBP_Z73 struct {
HL7 HL7Name `hl7:",name=QBP_Z73,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
}
Query by parameter - Information about Phone Calls
Retrieve all information about phone calls made during a defined interval either in a detailed or an accumulative format. The identifier for the patient must be given.
type QBP_Z75 ¶
type QBP_Z75 struct {
HL7 HL7Name `hl7:",name=QBP_Z75,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
RDF *RDF `hl7:"6,display=Table Row Definition"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Query by parameter - Tabular Patient List
The purpose of this message/response is to find patient records that closely (as specified by the Client) match a set of input criteria using a specified algorithm.
type QBP_Z79 ¶
type QBP_Z79 struct {
HL7 HL7Name `hl7:",name=QBP_Z79,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query - Dispense Information
The purpose of this message/response is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z81 ¶
type QBP_Z81 struct {
HL7 HL7Name `hl7:",name=QBP_Z81,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Dispense History Query
The purpose of this query/response is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z85 ¶
type QBP_Z85 struct {
HL7 HL7Name `hl7:",name=QBP_Z85,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy Information Comprehensive Query
The purpose of this query/response is to retrieve patient pharmacy history information from the Server.
type QBP_Z87 ¶
type QBP_Z87 struct {
HL7 HL7Name `hl7:",name=QBP_Z87,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Dispense Information Query
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z89 ¶
type QBP_Z89 struct {
HL7 HL7Name `hl7:",name=QBP_Z89,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Lab Results History Query
The purpose of this query/response pair is to retrieve patient laboratory results information from the Server.
type QBP_Z91 ¶
type QBP_Z91 struct {
HL7 HL7Name `hl7:",name=QBP_Z91,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RDF *RDF `hl7:"5,display=Table Row Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Who Am I Query
The purpose of this query/response pair is to find the identity of the patient for specified medical record number(s).
type QBP_Z93 ¶
type QBP_Z93 struct {
HL7 HL7Name `hl7:",name=QBP_Z93,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RDF *RDF `hl7:"5,display=Table Row Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Tabular Dispense History Query
The purpose of this query/response pair is to find medications dispensed between specified date range for specified medical record numbers.
type QBP_Z95 ¶
type QBP_Z95 struct {
HL7 HL7Name `hl7:",name=QBP_Z95,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RDF *RDF `hl7:"5,display=Table Row Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Tabular Dispense History Query
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z97 ¶
type QBP_Z97 struct {
HL7 HL7Name `hl7:",name=QBP_Z97,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Dispense History Query
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type QBP_Z99 ¶
type QBP_Z99 struct {
HL7 HL7Name `hl7:",name=QBP_Z99,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RDF *RDF `hl7:"5,display=Table Row Definition"`
RCP *RCP `hl7:"6,required,display=Response Control Parameter"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Who Am I Query
The purpose of this query/response pair is to find the identity of the patient for specified medical record number(s).
type QCK_Q02 ¶
type QCK_Q02 struct {
HL7 HL7Name `hl7:",name=QCK_Q02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,display=Query Acknowledgment"`
}
Deferred Query Response
This section is retained for backward compatibility as of V2.4.
type QCN_J01 ¶
type QCN_J01 struct {
HL7 HL7Name `hl7:",name=QCN_J01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QID *QID `hl7:"4,required,display=Query Identification"`
}
Cancel Query
type QID ¶
type QID struct {
HL7 HL7Name `hl7:",name=QID,type=s"`
QueryTag ST `hl7:"1,required,len=32,display=Query Tag"`
MessageQueryName CWE `hl7:"2,required,len=250,table=0471,display=Message Query Name"`
}
Query Identification
The QID segment contains the information necessary to uniquely identify a query. Its primary use is in query cancellation or subscription cancellation.
type QIP ¶
type QIP struct {
HL7 HL7Name `hl7:",name=QIP,len=212,type=d"`
SegmentFieldName ST `hl7:"1,required,len=12,display=This component contains the segment field name."`
Values ST `hl7:"2,required,len=199,display=This component contains the field value or values in the form 'value1& value2 & value3...'"`
}
Query Input Parameter List
This data type contains a segment field name and the list of values to be passed to the query processor.
type QPD ¶
type QPD struct {
HL7 HL7Name `hl7:",name=QPD,type=s"`
MessageQueryName CWE `hl7:"1,required,len=250,table=0471,display=Message Query Name"`
QueryTag ST `hl7:"2,conditional,len=32,display=Query Tag"`
UserParametersInSuccessiveFields *VARIES `hl7:"3,len=256,display=User Parameters (in successive fields)"`
}
Query Parameter Definition
The QPD segment defines the parameters of the query.
type QRD ¶
type QRD struct {
HL7 HL7Name `hl7:",name=QRD,type=s"`
QueryDateTime DTM `hl7:"1,required,len=24,format=YMDHM,display=Query Date/Time"`
QueryFormatCode ID `hl7:"2,required,len=1,table=0106,display=Query Format Code"`
QueryPriority ID `hl7:"3,required,len=1,table=0091,display=Query Priority"`
QueryID ST `hl7:"4,required,len=10,display=Query ID"`
DeferredResponseType ID `hl7:"5,len=1,table=0107,display=Deferred Response Type"`
DeferredResponseDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Deferred Response Date/Time"`
QuantityLimitedRequest CQ `hl7:"7,required,len=10,display=Quantity Limited Request"`
WhoSubjectFilter []XCN `hl7:"8,required,len=250,display=Who Subject Filter"`
WhatSubjectFilter []CWE `hl7:"9,required,len=250,table=0048,display=What Subject Filter"`
WhatDepartmentDataCode []CWE `hl7:"10,required,len=250,display=What Department Data Code"`
WhatDataCodeValueQual []VR `hl7:"11,len=20,display=What Data Code Value Qual."`
QueryResultsLevel ID `hl7:"12,len=1,table=0108,display=Query Results Level"`
}
Original-Style Query Definition
The QRD segment is used to define a query.
This segment is retained for backward compatibility only as of V2.4.
type QRF ¶
type QRF struct {
HL7 HL7Name `hl7:",name=QRF,type=s"`
WhereSubjectFilter []ST `hl7:"1,required,len=20,display=Where Subject Filter"`
WhenDataStartDateTime DTM `hl7:"2,len=24,format=YMDHM,display=When Data Start Date/Time"`
WhenDataEndDateTime DTM `hl7:"3,len=24,format=YMDHM,display=When Data End Date/Time"`
WhatUserQualifier []ST `hl7:"4,len=60,display=What User Qualifier"`
OtherQRYSubjectFilter []ST `hl7:"5,len=60,display=Other QRY Subject Filter"`
WhichDateTimeQualifier []ID `hl7:"6,len=12,table=0156,display=Which Date/Time Qualifier"`
WhichDateTimeStatusQualifier []ID `hl7:"7,len=12,table=0157,display=Which Date/Time Status Qualifier"`
DateTimeSelectionQualifier []ID `hl7:"8,len=12,table=0158,display=Date/Time Selection Qualifier"`
WhenQuantityTimingQualifier TQ `hl7:"9,len=60,display=When Quantity/Timing Qualifier"`
SearchConfidenceThreshold NM `hl7:"10,len=10,display=Search Confidence Threshold"`
}
Original style query filter
The QRF segment is used with the QRD segment to further refine the content of an original style query.
This segment is retained for backward compatibility as of V2.4.
type QRI ¶
type QRI struct {
HL7 HL7Name `hl7:",name=QRI,type=s"`
CandidateConfidence NM `hl7:"1,len=10,display=Candidate Confidence"`
MatchReasonCode []IS `hl7:"2,len=2,table=0392,display=Match Reason Code"`
AlgorithmDescriptor *CWE `hl7:"3,len=250,table=0393,display=Algorithm Descriptor"`
}
Query Response Instance
The QRI segment is used to indicate the weight match for a returned record (where the responding system employs a numeric algorithm) and/or the match reason code (where the responding system uses rules or other match options).
type QRY_A19 ¶
type QRY_A19 struct {
HL7 HL7Name `hl7:",name=QRY_A19,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Patient Query
The Original Mode Query was retained for backward compatibility only as of version 2.4.
Another application determines a need for Patient Administration data about a patient and sends a query to the Patient Administration system. The Who Filter in the QRD can identify the patient or account number upon which the query is defined and can contain a format code of "R" (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue. The ADT event-type segment, if included in the response, describes the last event for which the Patient Administration system initiated an unsolicited update.
type QRY_PC4 ¶
type QRY_PC4 struct {
HL7 HL7Name `hl7:",name=QRY_PC4,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Patient Care Problem Query
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by QRY (a query from another system). The QRD-8-who filter identifies the patient or account number upon which the query is defined and can contain a Format Code of R (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue.
Note from the Caristix team: The HL7 documentation appears to contain an error where the SFT and UAC segments in this message did not appear. We have included them in this message.
type QRY_PC9 ¶
type QRY_PC9 struct {
HL7 HL7Name `hl7:",name=QRY_PC9,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Patient Goal Query
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by QRY (a query from another system). The QRD-8-who filter identifies the patient or account number upon which the query is defined and can contain a Format Code of R (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue.
type QRY_PCE ¶
type QRY_PCE struct {
HL7 HL7Name `hl7:",name=QRY_PCE,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Patient Pathway (Problem-Oriented) Query
Retained for backwards compatibility only in version 2.4 and later; refer to Chapter 5, section 5.4.
The following trigger/message event is served by QRY (a query from another system). The QRD-8-who filter identifies the patient or account number upon which the query is defined and can contain a Format Code of R (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue.
type QRY_PCK ¶
type QRY_PCK struct {
HL7 HL7Name `hl7:",name=QRY_PCK,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Patient Pathway (Goal-Oriented) Query
Retained for backwards compatibility only in version 2.4 and later.
The following trigger/message event is served by QRY (a query from another system). The QRD-8-who filter identifies the patient or account number upon which the query is defined and can contain a Format Code of R (record-oriented). If the query is based on the Patient ID and there are data associated with multiple accounts, the problem of which account data should be returned becomes an implementation issue.
type QRY_Q01 ¶
type QRY_Q01 struct {
HL7 HL7Name `hl7:",name=QRY_Q01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query Sent for immediate response
type QRY_Q02 ¶
type QRY_Q02 struct {
HL7 HL7Name `hl7:",name=QRY_Q02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Deferred Query
This section is retained for backward compatibility as of V2.4.
type QRY_Q26 ¶
type QRY_Q26 struct {
HL7 HL7Name `hl7:",name=QRY_Q26,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy/Treatment Order Query
This query/response pair is retained for backward compatibility only.
type QRY_Q27 ¶
type QRY_Q27 struct {
HL7 HL7Name `hl7:",name=QRY_Q27,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query - Pharmacy/Treatment Administration Information
This query/response pair is retained for backward compatibility only.
type QRY_Q28 ¶
type QRY_Q28 struct {
HL7 HL7Name `hl7:",name=QRY_Q28,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy/Treatment Dispense Information Query
This query/response pair is retained for backward compatibility only.
type QRY_Q29 ¶
type QRY_Q29 struct {
HL7 HL7Name `hl7:",name=QRY_Q29,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy/Treatment Encoded Order Information Query
This query/response pair is retained for backward compatibility only.
type QRY_Q30 ¶
type QRY_Q30 struct {
HL7 HL7Name `hl7:",name=QRY_Q30,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Pharmacy/Treatment Dose Information Query
This query/response pair is retained for backward compatibility only.
type QRY_R02 ¶
type QRY_R02 struct {
HL7 HL7Name `hl7:",name=QRY_R02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,required,display=Original style query filter"`
}
Results of Observation Query
Retained for backwards compatibility only in version 2.4 and later. The original mode query and the QRD/QRF segments have been replaced.
type QRY_T12 ¶
type QRY_T12 struct {
HL7 HL7Name `hl7:",name=QRY_T12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
QRD *QRD `hl7:"2,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"3,display=Original style query filter"`
}
Document Query
Retained for backwards compatibility only in version 2.4 and later.
type QSB_Q16 ¶
type QSB_Q16 struct {
HL7 HL7Name `hl7:",name=QSB_Q16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Create Subscription
type QSB_Z83 ¶
type QSB_Z83 struct {
HL7 HL7Name `hl7:",name=QSB_Z83,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Publish ORU Subscription
The purpose of this publish/response pair is to send Lab Results, either filtered or unfiltered, as specified in the input parameters.
A standard query response is not received from the se Instead, actual ORU messages are returned corresponding to nput parameters. The input param when selecting data to be returned. That is, all input parameters that are specified must e sat d in r fo res report to be sent.
type QSC ¶
type QSC struct {
HL7 HL7Name `hl7:",name=QSC,len=219,type=d"`
SegmentFieldName ST `` /* 201-byte string literal not displayed */
RelationalOperator ID `hl7:"2,len=2,table=0209,display=Relational Operator"`
Value ST `hl7:"3,len=199,display=The value to which the field will be compared."`
RelationalConjunction ID `` /* 282-byte string literal not displayed */
}
Query Selection Criteria
This field indicates the conditions that qualify the rows to be returned in the query response. Note that this field conveys the same information as the "WHERE" clause in the corresponding SQL expression of the query, but is formatted differently.
type QSX_J02 ¶
type QSX_J02 struct {
HL7 HL7Name `hl7:",name=QSX_J02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QID *QID `hl7:"4,required,display=Query Identification"`
}
Cancel Subscription
type QVR_Q17 ¶
type QVR_Q17 struct {
HL7 HL7Name `hl7:",name=QVR_Q17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QPD *QPD `hl7:"4,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"5,required,display=Response Control Parameter"`
DSC *DSC `hl7:"6,display=Continuation Pointer"`
}
Query for Previous Events
The Query for Previous Events is like a Query by Parameter with a Segment Pattern Response except that the response consists of zero to many messages of the type defined in the Query Profile rather than a single response message containing multiple iterations of the segment pattern. While the messages sent in response to a QVR will reflect events which occurred in the past, the time stamp in the message header will reflect the time the message is actually constructed (current time). It is also similar to the previous generation VQQ/RQQ Event Replay.
type RAR_RAR ¶
type RAR_RAR struct {
HL7 HL7Name `hl7:",name=RAR_RAR,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
Definition []RAR_RAR_Definition `hl7:",required,display=Definition"`
DSC *DSC `hl7:"16,display=Continuation Pointer"`
}
Pharmacy/Treatment Administration Information Response
This query/response pair is retained for backward compatibility only.
type RAR_RAR_Definition ¶
type RAR_RAR_Definition struct {
HL7 HL7Name `hl7:",name=RAR_RAR_Definition,type=tg"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
Patient *RAR_RAR_Patient `hl7:",display=Patient"`
Order []RAR_RAR_Order `hl7:",required,display=Order"`
}
Definition
type RAR_RAR_Encoding ¶
type RAR_RAR_Encoding struct {
HL7 HL7Name `hl7:",name=RAR_RAR_Encoding,type=tg"`
RXE *RXE `hl7:"11,required,display=Pharmacy/Treatment Encoded Order"`
RXR []RXR `hl7:"12,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"13,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RAR_RAR_Order ¶
type RAR_RAR_Order struct {
HL7 HL7Name `hl7:",name=RAR_RAR_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Encoding *RAR_RAR_Encoding `hl7:",display=Encoding"`
RXA []RXA `hl7:"14,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
}
Order
type RAR_RAR_Patient ¶
type RAR_RAR_Patient struct {
HL7 HL7Name `hl7:",name=RAR_RAR_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Patient
type RAS_O17 ¶
type RAS_O17 struct {
HL7 HL7Name `hl7:",name=RAS_O17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *RAS_O17_Patient `hl7:",display=Patient"`
Order []RAS_O17_Order `hl7:",required,display=Order"`
}
Pharmacy/Treatment Administration
The RAS message may be created by the administering application (e.g., nursing application) for each instance of administration for an existing order. If the administering application wants to report several administrations of medication/treatment for a given order with a single RAS message, each instance is reported by a separate (repeating) RXA segment. In addition, the administration records for a group of orders may be sent in a single message by creating repeating groups of segments at the ORC level.
type RAS_O17_Administration ¶
type RAS_O17_Administration struct {
HL7 HL7Name `hl7:",name=RAS_O17_Administration,type=tg"`
RXA []RXA `hl7:"24,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"25,required,display=Pharmacy/Treatment Route"`
Observation []RAS_O17_Observation `hl7:",display=Observation"`
}
Administration
type RAS_O17_Components ¶
type RAS_O17_Components struct {
HL7 HL7Name `hl7:",name=RAS_O17_Components,type=tg"`
RXC *RXC `hl7:"17,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Components
type RAS_O17_Encoding ¶
type RAS_O17_Encoding struct {
HL7 HL7Name `hl7:",name=RAS_O17_Encoding,type=tg"`
RXE *RXE `hl7:"19,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RAS_O17_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"22,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"23,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RAS_O17_Observation ¶
type RAS_O17_Observation struct {
HL7 HL7Name `hl7:",name=RAS_O17_Observation,type=tg"`
OBX *OBX `hl7:"26,required,display=Observation/Result"`
NTE []NTE `hl7:"27,display=Notes and Comments"`
}
Observation
type RAS_O17_Order ¶
type RAS_O17_Order struct {
HL7 HL7Name `hl7:",name=RAS_O17_Order,type=tg"`
ORC *ORC `hl7:"11,required,display=Common Order"`
Timing []RAS_O17_Timing `hl7:",display=Timing"`
OrderDetail *RAS_O17_OrderDetail `hl7:",display=Order Detail"`
Encoding *RAS_O17_Encoding `hl7:",display=Encoding"`
Administration []RAS_O17_Administration `hl7:",required,display=Administration"`
CTI []CTI `hl7:"28,display=Clinical Trial Identification"`
}
Order
type RAS_O17_OrderDetail ¶
type RAS_O17_OrderDetail struct {
HL7 HL7Name `hl7:",name=RAS_O17_OrderDetail,type=tg"`
RXO *RXO `hl7:"14,required,display=Pharmacy/Treatment Order"`
OrderDetailSupplement *RAS_O17_OrderDetailSupplement `hl7:",display=Order Detail Supplement"`
}
OrderDetail
type RAS_O17_OrderDetailSupplement ¶
type RAS_O17_OrderDetailSupplement struct {
HL7 HL7Name `hl7:",name=RAS_O17_OrderDetailSupplement,type=tg"`
NTE []NTE `hl7:"15,required,display=Notes and Comments"`
RXR []RXR `hl7:"16,required,display=Pharmacy/Treatment Route"`
Components []RAS_O17_Components `hl7:",display=Components"`
}
OrderDetailSupplement
type RAS_O17_Patient ¶
type RAS_O17_Patient struct {
HL7 HL7Name `hl7:",name=RAS_O17_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
AL1 []AL1 `hl7:"8,display=Patient Allergy Information"`
PatientVisit *RAS_O17_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type RAS_O17_PatientVisit ¶
type RAS_O17_PatientVisit struct {
HL7 HL7Name `hl7:",name=RAS_O17_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type RAS_O17_Timing ¶
type RAS_O17_Timing struct {
HL7 HL7Name `hl7:",name=RAS_O17_Timing,type=tg"`
TQ1 *TQ1 `hl7:"12,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"13,display=Timing/Quantity Relationship"`
}
Timing
type RAS_O17_TimingEncoded ¶
type RAS_O17_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RAS_O17_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"20,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"21,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RCD ¶
type RCD struct {
HL7 HL7Name `hl7:",name=RCD,len=19,type=d"`
SegmentFieldName ST `` /* 200-byte string literal not displayed */
Hl7DataType ID `` /* 159-byte string literal not displayed */
MaximumColumnWidth NM `` /* 149-byte string literal not displayed */
}
Row Column Definition
This specifies the format of a column in terms of a segment field name, a data type, and a maximum length.
type RCI_I05 ¶
type RCI_I05 struct {
HL7 HL7Name `hl7:",name=RCI_I05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
Provider []RCI_I05_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
DRG []DRG `hl7:"11,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"12,display=Patient Allergy Information"`
Observation []RCI_I05_Observation `hl7:",display=Observation"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
Return Patient Clinical Information
Retained for backwards compatibility only in version 2.4 and later.
This event is used to request clinical information for a specific patient. Generally, this transaction occurs between one provider and another (typically a laboratory or radiology, etc.). However, it may also be very useful for a payor-to-provider request for clinical observation information to be used in considering a request for treatment authorization.
type RCI_I05_Observation ¶
type RCI_I05_Observation struct {
HL7 HL7Name `hl7:",name=RCI_I05_Observation,type=tg"`
OBR *OBR `hl7:"13,required,display=Observation Request"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
Results []RCI_I05_Results `hl7:",display=Results"`
}
Observation
type RCI_I05_Provider ¶
type RCI_I05_Provider struct {
HL7 HL7Name `hl7:",name=RCI_I05_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RCI_I05_Results ¶
type RCI_I05_Results struct {
HL7 HL7Name `hl7:",name=RCI_I05_Results,type=tg"`
OBX *OBX `hl7:"15,required,display=Observation/Result"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
Results
type RCL_I06 ¶
type RCL_I06 struct {
HL7 HL7Name `hl7:",name=RCL_I06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
Provider []RCL_I06_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
DRG []DRG `hl7:"11,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"12,display=Patient Allergy Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
DSP []DSP `hl7:"14,display=Display Data"`
DSC *DSC `hl7:"15,display=Continuation Pointer"`
}
Return Clinical Data Listing
Retained for backwards compatibility only in version 2.4 and later.
This event code is sent from one healthcare provider to another (typically a laboratory or radiology, etc.) to request a list of available clinical observation information. When the provider is dealing with a community model in which remote requests make transmission of large amounts of data impractical, this event code will provide for interactive lists of transactions from which more specific selections can be made.
type RCL_I06_Provider ¶
type RCL_I06_Provider struct {
HL7 HL7Name `hl7:",name=RCL_I06_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RCP ¶
type RCP struct {
HL7 HL7Name `hl7:",name=RCP,type=s"`
QueryPriority ID `hl7:"1,len=1,table=0091,display=Query Priority"`
QuantityLimitedRequest *CQ `hl7:"2,len=10,display=Quantity Limited Request"`
ResponseModality *CNE `hl7:"3,len=250,table=0394,display=Response Modality"`
ExecutionAndDeliveryTime DTM `hl7:"4,conditional,len=24,format=YMDHM,display=Execution and Delivery Time"`
ModifyIndicator ID `hl7:"5,len=1,table=0395,display=Modify Indicator"`
SortByField []SRT `hl7:"6,len=512,display=Sort-by Field"`
SegmentGroupInclusion []ID `hl7:"7,len=256,table=0391,display=Segment group inclusion"`
}
Response Control Parameter
The RCP segment is used to restrict the amount of data that should be returned in response to query.
type RDE_O11 ¶
type RDE_O11 struct {
HL7 HL7Name `hl7:",name=RDE_O11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *RDE_O11_Patient `hl7:",display=Patient"`
Order []RDE_O11_Order `hl7:",required,display=Order"`
}
Pharmacy/Treatment Encoded Order
This message communicates the pharmacy or treatment application's encoding of the pharmacy/treatment order (ORM message with RXO segment, see above). It may be sent as an unsolicited message to report on either a single order or multiple pharmacy/treatment orders for a patient.
The RDE/RRE message pair can also be used to communicate a refill authorization request; however, a specific trigger event has been assigned. See section 4.13.13 "RDE - Pharmacy/Treatment Refill Authorization Request Message (Event O25)." As a site-specific variant, the original order segments (RXO, RXRs, associated RXCs, and any NTEs) may be sent optionally (for comparison).
type RDE_O11_Component ¶
type RDE_O11_Component struct {
HL7 HL7Name `hl7:",name=RDE_O11_Component,type=tg"`
RXC *RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Component
type RDE_O11_Insurance ¶
type RDE_O11_Insurance struct {
HL7 HL7Name `hl7:",name=RDE_O11_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type RDE_O11_Observation ¶
type RDE_O11_Observation struct {
HL7 HL7Name `hl7:",name=RDE_O11_Observation,type=tg"`
OBX *OBX `hl7:"29,required,display=Observation/Result"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
}
Observation
type RDE_O11_Order ¶
type RDE_O11_Order struct {
HL7 HL7Name `hl7:",name=RDE_O11_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RDE_O11_Timing `hl7:",display=Timing"`
OrderDetail *RDE_O11_OrderDetail `hl7:",display=Order Detail"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
TimingEncoded []RDE_O11_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"27,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"28,display=Pharmacy/Treatment Component Order"`
Observation []RDE_O11_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"31,display=Financial Transaction"`
BLG *BLG `hl7:"32,display=Billing"`
CTI []CTI `hl7:"33,display=Clinical Trial Identification"`
}
Order
type RDE_O11_OrderDetail ¶
type RDE_O11_OrderDetail struct {
HL7 HL7Name `hl7:",name=RDE_O11_OrderDetail,type=tg"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Component []RDE_O11_Component `hl7:",display=Component"`
}
OrderDetail
type RDE_O11_Patient ¶
type RDE_O11_Patient struct {
HL7 HL7Name `hl7:",name=RDE_O11_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *RDE_O11_PatientVisit `hl7:",display=Patient Visit"`
Insurance []RDE_O11_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type RDE_O11_PatientVisit ¶
type RDE_O11_PatientVisit struct {
HL7 HL7Name `hl7:",name=RDE_O11_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type RDE_O11_Timing ¶
type RDE_O11_Timing struct {
HL7 HL7Name `hl7:",name=RDE_O11_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RDE_O11_TimingEncoded ¶
type RDE_O11_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RDE_O11_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"25,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"26,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RDE_O25 ¶
type RDE_O25 struct {
HL7 HL7Name `hl7:",name=RDE_O25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *RDE_O25_Patient `hl7:",display=Patient"`
Order []RDE_O25_Order `hl7:",required,display=Order"`
}
Pharmacy/Treatment Refill Authorization Request Message
The RDE/RRE is used to communicate a refill authorization request originating with the pharmacy. This message replicates the standard RDE message with a different trigger event code to indicate the specific use case of a refill authorization request.
type RDE_O25_Components ¶
type RDE_O25_Components struct {
HL7 HL7Name `hl7:",name=RDE_O25_Components,type=tg"`
RXC *RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Components
type RDE_O25_Insurance ¶
type RDE_O25_Insurance struct {
HL7 HL7Name `hl7:",name=RDE_O25_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type RDE_O25_Observation ¶
type RDE_O25_Observation struct {
HL7 HL7Name `hl7:",name=RDE_O25_Observation,type=tg"`
OBX *OBX `hl7:"29,display=Observation/Result"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
}
Observation
type RDE_O25_Order ¶
type RDE_O25_Order struct {
HL7 HL7Name `hl7:",name=RDE_O25_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RDE_O25_Timing `hl7:",display=Timing"`
OrderDetail *RDE_O25_OrderDetail `hl7:",display=Order Detail"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
TimingEncoded []RDE_O25_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"27,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"28,display=Pharmacy/Treatment Component Order"`
Observation []RDE_O25_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"31,display=Financial Transaction"`
BLG *BLG `hl7:"32,display=Billing"`
CTI []CTI `hl7:"33,display=Clinical Trial Identification"`
}
Order
type RDE_O25_OrderDetail ¶
type RDE_O25_OrderDetail struct {
HL7 HL7Name `hl7:",name=RDE_O25_OrderDetail,type=tg"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Components []RDE_O25_Components `hl7:",display=Components"`
}
OrderDetail
type RDE_O25_Patient ¶
type RDE_O25_Patient struct {
HL7 HL7Name `hl7:",name=RDE_O25_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
PatientVisit *RDE_O25_PatientVisit `hl7:",display=Patient Visit"`
Insurance []RDE_O25_Insurance `hl7:",display=Insurance"`
GT1 *GT1 `hl7:"13,display=Guarantor"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
}
Patient
type RDE_O25_PatientVisit ¶
type RDE_O25_PatientVisit struct {
HL7 HL7Name `hl7:",name=RDE_O25_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type RDE_O25_Timing ¶
type RDE_O25_Timing struct {
HL7 HL7Name `hl7:",name=RDE_O25_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RDE_O25_TimingEncoded ¶
type RDE_O25_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RDE_O25_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"25,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"26,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RDF ¶
type RDF struct {
HL7 HL7Name `hl7:",name=RDF,type=s"`
NumberOfColumnsPerRow NM `hl7:"1,required,len=3,display=Number of Columns per Row"`
ColumnDescription []RCD `hl7:"2,required,len=40,display=Column Description"`
}
Table Row Definition
The RDF segment defines the content of the row data segments (RDT) in the tabular response (RTB).
type RDR_RDR ¶
type RDR_RDR struct {
HL7 HL7Name `hl7:",name=RDR_RDR,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
Definition []RDR_RDR_Definition `hl7:",required,display=Definition"`
DSC *DSC `hl7:"17,display=Continuation Pointer"`
}
Pharmacy/Treatment Dispense Information Response
This query/response pair is retained for backward compatibility only.
type RDR_RDR_Definition ¶
type RDR_RDR_Definition struct {
HL7 HL7Name `hl7:",name=RDR_RDR_Definition,type=tg"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
Patient *RDR_RDR_Patient `hl7:",display=Patient"`
Order []RDR_RDR_Order `hl7:",required,display=Order"`
}
Definition
type RDR_RDR_Dispense ¶
type RDR_RDR_Dispense struct {
HL7 HL7Name `hl7:",name=RDR_RDR_Dispense,type=tg"`
RXD *RXD `hl7:"14,required,display=Pharmacy/Treatment Dispense"`
RXR []RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"16,display=Pharmacy/Treatment Component Order"`
}
Dispense
type RDR_RDR_Encoding ¶
type RDR_RDR_Encoding struct {
HL7 HL7Name `hl7:",name=RDR_RDR_Encoding,type=tg"`
RXE *RXE `hl7:"11,required,display=Pharmacy/Treatment Encoded Order"`
RXR []RXR `hl7:"12,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"13,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RDR_RDR_Order ¶
type RDR_RDR_Order struct {
HL7 HL7Name `hl7:",name=RDR_RDR_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Encoding *RDR_RDR_Encoding `hl7:",display=Encoding"`
Dispense []RDR_RDR_Dispense `hl7:",required,display=Dispense"`
}
Order
type RDR_RDR_Patient ¶
type RDR_RDR_Patient struct {
HL7 HL7Name `hl7:",name=RDR_RDR_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Patient
type RDS_O13 ¶
type RDS_O13 struct {
HL7 HL7Name `hl7:",name=RDS_O13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *RDS_O13_Patient `hl7:",display=Patient"`
Order []RDS_O13_Order `hl7:",required,display=Order"`
}
Pharmacy/treatment dispense
The RDS message may be created by the pharmacy/treatment application for each instance of dispensing a drug or treatment to fill an existing order or orders. In the most common case, the RDS messages would be routed to a Nursing application or to some clinical application, which needs the data about drugs dispensed or treatments given. As a site-specific variant, the original order segments (RXO, RXE and their associated RXR/RXCs) may be sent optionally (for comparison).
type RDS_O13_Component ¶
type RDS_O13_Component struct {
HL7 HL7Name `hl7:",name=RDS_O13_Component,type=tg"`
RXC *RXC `hl7:"17,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
Component
type RDS_O13_Encoding ¶
type RDS_O13_Encoding struct {
HL7 HL7Name `hl7:",name=RDS_O13_Encoding,type=tg"`
RXE *RXE `hl7:"19,required,display=Pharmacy/Treatment Encoded Order"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
TimingEncoded []RDS_O13_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"23,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"24,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RDS_O13_Observation ¶
type RDS_O13_Observation struct {
HL7 HL7Name `hl7:",name=RDS_O13_Observation,type=tg"`
OBX *OBX `hl7:"29,required,display=Observation/Result"`
NTE []NTE `hl7:"30,display=Notes and Comments"`
}
Observation
type RDS_O13_Order ¶
type RDS_O13_Order struct {
HL7 HL7Name `hl7:",name=RDS_O13_Order,type=tg"`
ORC *ORC `hl7:"11,required,display=Common Order"`
Timing []RDS_O13_Timing `hl7:",display=Timing"`
OrderDetail *RDS_O13_OrderDetail `hl7:",display=Order Detail"`
Encoding *RDS_O13_Encoding `hl7:",display=Encoding"`
RXD *RXD `hl7:"25,required,display=Pharmacy/Treatment Dispense"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
RXR []RXR `hl7:"27,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"28,display=Pharmacy/Treatment Component Order"`
Observation []RDS_O13_Observation `hl7:",display=Observation"`
FT1 []FT1 `hl7:"31,display=Financial Transaction"`
}
Order
type RDS_O13_OrderDetail ¶
type RDS_O13_OrderDetail struct {
HL7 HL7Name `hl7:",name=RDS_O13_OrderDetail,type=tg"`
RXO *RXO `hl7:"14,required,display=Pharmacy/Treatment Order"`
OrderDetailSupplement *RDS_O13_OrderDetailSupplement `hl7:",display=Order Detail Supplement"`
}
OrderDetail
type RDS_O13_OrderDetailSupplement ¶
type RDS_O13_OrderDetailSupplement struct {
HL7 HL7Name `hl7:",name=RDS_O13_OrderDetailSupplement,type=tg"`
NTE []NTE `hl7:"15,required,display=Notes and Comments"`
RXR []RXR `hl7:"16,required,display=Pharmacy/Treatment Route"`
Component []RDS_O13_Component `hl7:",display=Component"`
}
OrderDetailSupplement
type RDS_O13_Patient ¶
type RDS_O13_Patient struct {
HL7 HL7Name `hl7:",name=RDS_O13_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
AL1 []AL1 `hl7:"8,display=Patient Allergy Information"`
PatientVisit *RDS_O13_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type RDS_O13_PatientVisit ¶
type RDS_O13_PatientVisit struct {
HL7 HL7Name `hl7:",name=RDS_O13_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"9,required,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
}
PatientVisit
type RDS_O13_Timing ¶
type RDS_O13_Timing struct {
HL7 HL7Name `hl7:",name=RDS_O13_Timing,type=tg"`
TQ1 *TQ1 `hl7:"12,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"13,display=Timing/Quantity Relationship"`
}
Timing
type RDS_O13_TimingEncoded ¶
type RDS_O13_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RDS_O13_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"21,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"22,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RDT ¶
type RDT struct {
HL7 HL7Name `hl7:",name=RDT,type=s"`
ColumnValue VARIES `hl7:"1,required,len=99999,display=Column Value"`
}
Table Row Data
The RDT segment contains the row data of the tabular data response message (TBR).
type RDY_K15 ¶
type RDY_K15 struct {
HL7 HL7Name `hl7:",name=RDY_K15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
DSP []DSP `hl7:"8,display=Display Data"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Display Response in Response to QBP_Q15
The RDY_K15 supports a Display Response to the QBP and contains the MSH, MSA, ERR, QAK, DSP, and the DSC. Its default trigger event is K15. A standard or site-defined response may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined response, that value must begin with Z.
type RDY_Z80 ¶
type RDY_Z80 struct {
HL7 HL7Name `hl7:",name=RDY_Z80,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
DSP []DSP `hl7:"8,display=Display Data"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Display based response - Dispense Information
The purpose of this message/response is to retrieve patient pharmacy dispense history information from the Server.
type RDY_Z98 ¶
type RDY_Z98 struct {
HL7 HL7Name `hl7:",name=RDY_Z98,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
DSP []DSP `hl7:"8,display=Display Data"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Dispense History Response
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type REF_I12 ¶
type REF_I12 struct {
HL7 HL7Name `hl7:",name=REF_I12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
AuthorizationContact *REF_I12_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []REF_I12_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []REF_I12_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []REF_I12_Procedure `hl7:",display=Procedure"`
Observation []REF_I12_Observation `hl7:",display=Observation"`
PatientVisit *REF_I12_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Patient Referral
This event triggers a message to be sent from one healthcare provider to another regarding a specific patient. The referral message may contain patient demographic information, specific medical procedures to be performed (accompanied by previously obtained authorizations) and relevant clinical information pertinent to the patient's case.
type REF_I12_AuthorizationContact ¶
type REF_I12_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=REF_I12_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
AuthorizationContact
type REF_I12_AuthorizationContact2 ¶
type REF_I12_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=REF_I12_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
AuthorizationContact
type REF_I12_Insurance ¶
type REF_I12_Insurance struct {
HL7 HL7Name `hl7:",name=REF_I12_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type REF_I12_Observation ¶
type REF_I12_Observation struct {
HL7 HL7Name `hl7:",name=REF_I12_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
ResultsNotes []REF_I12_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type REF_I12_PatientVisit ¶
type REF_I12_PatientVisit struct {
HL7 HL7Name `hl7:",name=REF_I12_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
PatientVisit
type REF_I12_Procedure ¶
type REF_I12_Procedure struct {
HL7 HL7Name `hl7:",name=REF_I12_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
AuthorizationContact *REF_I12_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type REF_I12_ProviderContact ¶
type REF_I12_ProviderContact struct {
HL7 HL7Name `hl7:",name=REF_I12_ProviderContact,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
ProviderContact
type REF_I12_ResultsNotes ¶
type REF_I12_ResultsNotes struct {
HL7 HL7Name `hl7:",name=REF_I12_ResultsNotes,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ResultsNotes
type REF_I13 ¶
type REF_I13 struct {
HL7 HL7Name `hl7:",name=REF_I13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
AuthorizationContact *REF_I13_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []REF_I13_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []REF_I13_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []REF_I13_Procedure `hl7:",display=Procedure"`
Observation []REF_I13_Observation `hl7:",display=Observation"`
PatientVisit *REF_I13_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Modify Patient Referral
This event triggers a message to be sent from one healthcare provider to another regarding changes to an existing referral. Changes in a referral may include additional instructions from the referring provider, additional clinical information, and even additional information on patient demographics.
type REF_I13_AuthorizationContact ¶
type REF_I13_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=REF_I13_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
AuthorizationContact
type REF_I13_AuthorizationContact2 ¶
type REF_I13_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=REF_I13_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
AuthorizationContact
type REF_I13_Insurance ¶
type REF_I13_Insurance struct {
HL7 HL7Name `hl7:",name=REF_I13_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type REF_I13_Observation ¶
type REF_I13_Observation struct {
HL7 HL7Name `hl7:",name=REF_I13_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
ResultsNotes []REF_I13_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type REF_I13_PatientVisit ¶
type REF_I13_PatientVisit struct {
HL7 HL7Name `hl7:",name=REF_I13_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
PatientVisit
type REF_I13_Procedure ¶
type REF_I13_Procedure struct {
HL7 HL7Name `hl7:",name=REF_I13_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
AuthorizationContact *REF_I13_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type REF_I13_ProviderContact ¶
type REF_I13_ProviderContact struct {
HL7 HL7Name `hl7:",name=REF_I13_ProviderContact,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
ProviderContact
type REF_I13_ResultsNotes ¶
type REF_I13_ResultsNotes struct {
HL7 HL7Name `hl7:",name=REF_I13_ResultsNotes,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ResultsNotes
type REF_I14 ¶
type REF_I14 struct {
HL7 HL7Name `hl7:",name=REF_I14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
AuthorizationContact *REF_I14_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []REF_I14_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []REF_I14_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []REF_I14_Procedure `hl7:",display=Procedure"`
Observation []REF_I14_Observation `hl7:",display=Observation"`
PatientVisit *REF_I14_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Cancel Patient Referral
This event triggers a message to be sent from one healthcare provider to another canceling a referral. A previous referral may have been made in error, or perhaps the cancellation has come from the patient.
type REF_I14_AuthorizationContact ¶
type REF_I14_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=REF_I14_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
AuthorizationContact
type REF_I14_AuthorizationContact2 ¶
type REF_I14_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=REF_I14_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
AuthorizationContact
type REF_I14_Insurance ¶
type REF_I14_Insurance struct {
HL7 HL7Name `hl7:",name=REF_I14_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type REF_I14_Observation ¶
type REF_I14_Observation struct {
HL7 HL7Name `hl7:",name=REF_I14_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
ResultsNotes []REF_I14_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type REF_I14_PatientVisit ¶
type REF_I14_PatientVisit struct {
HL7 HL7Name `hl7:",name=REF_I14_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
PatientVisit
type REF_I14_Procedure ¶
type REF_I14_Procedure struct {
HL7 HL7Name `hl7:",name=REF_I14_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
AuthorizationContact *REF_I14_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type REF_I14_ProviderContact ¶
type REF_I14_ProviderContact struct {
HL7 HL7Name `hl7:",name=REF_I14_ProviderContact,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
ProviderContact
type REF_I14_ResultsNotes ¶
type REF_I14_ResultsNotes struct {
HL7 HL7Name `hl7:",name=REF_I14_ResultsNotes,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ResultsNotes
type REF_I15 ¶
type REF_I15 struct {
HL7 HL7Name `hl7:",name=REF_I15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
AuthorizationContact *REF_I15_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []REF_I15_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []REF_I15_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []REF_I15_Procedure `hl7:",display=Procedure"`
Observation []REF_I15_Observation `hl7:",display=Observation"`
PatientVisit *REF_I15_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Request Patient Referral Status
This event triggers a message to be sent between healthcare providers regarding the status of a patient referral request. A previous referral has been made and acknowledged; however, no response has been received to indicate results and/or procedures performed.
type REF_I15_AuthorizationContact ¶
type REF_I15_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=REF_I15_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
AuthorizationContact
type REF_I15_AuthorizationContact2 ¶
type REF_I15_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=REF_I15_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
AuthorizationContact
type REF_I15_Insurance ¶
type REF_I15_Insurance struct {
HL7 HL7Name `hl7:",name=REF_I15_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type REF_I15_Observation ¶
type REF_I15_Observation struct {
HL7 HL7Name `hl7:",name=REF_I15_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
ResultsNotes []REF_I15_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type REF_I15_PatientVisit ¶
type REF_I15_PatientVisit struct {
HL7 HL7Name `hl7:",name=REF_I15_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
PatientVisit
type REF_I15_Procedure ¶
type REF_I15_Procedure struct {
HL7 HL7Name `hl7:",name=REF_I15_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
AuthorizationContact *REF_I15_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type REF_I15_ProviderContact ¶
type REF_I15_ProviderContact struct {
HL7 HL7Name `hl7:",name=REF_I15_ProviderContact,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
ProviderContact
type REF_I15_ResultsNotes ¶
type REF_I15_ResultsNotes struct {
HL7 HL7Name `hl7:",name=REF_I15_ResultsNotes,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
ResultsNotes
type RER_RER ¶
type RER_RER struct {
HL7 HL7Name `hl7:",name=RER_RER,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
Definition []RER_RER_Definition `hl7:",required,display=Definition"`
DSC *DSC `hl7:"14,display=Continuation Pointer"`
}
Pharmacy/Treatment Encoded Order Information Response
This query/response pair is retained for backward compatibility only.
type RER_RER_Definition ¶
type RER_RER_Definition struct {
HL7 HL7Name `hl7:",name=RER_RER_Definition,type=tg"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
Patient *RER_RER_Patient `hl7:",display=Patient"`
Order []RER_RER_Order `hl7:",required,display=Order"`
}
Definition
type RER_RER_Order ¶
type RER_RER_Order struct {
HL7 HL7Name `hl7:",name=RER_RER_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
RXE *RXE `hl7:"11,required,display=Pharmacy/Treatment Encoded Order"`
RXR []RXR `hl7:"12,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"13,display=Pharmacy/Treatment Component Order"`
}
Order
type RER_RER_Patient ¶
type RER_RER_Patient struct {
HL7 HL7Name `hl7:",name=RER_RER_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Patient
type RF1 ¶
type RF1 struct {
HL7 HL7Name `hl7:",name=RF1,type=s"`
ReferralStatus *CWE `hl7:"1,len=705,table=0283,display=Referral Status"`
ReferralPriority *CWE `hl7:"2,len=705,table=0280,display=Referral Priority"`
ReferralType *CWE `hl7:"3,len=705,table=0281,display=Referral Type"`
ReferralDisposition []CWE `hl7:"4,len=705,table=0282,display=Referral Disposition"`
ReferralCategory *CWE `hl7:"5,len=705,table=0284,display=Referral Category"`
OriginatingReferralIdentifier EI `hl7:"6,required,len=30,display=Originating Referral Identifier"`
EffectiveDate DTM `hl7:"7,len=24,format=YMDHM,display=Effective Date"`
ExpirationDate DTM `hl7:"8,len=24,format=YMDHM,display=Expiration Date"`
ProcessDate DTM `hl7:"9,len=24,format=YMDHM,display=Process Date"`
ReferralReason []CWE `hl7:"10,len=705,table=0336,display=Referral Reason"`
ExternalReferralIdentifier []EI `hl7:"11,len=30,display=External Referral Identifier"`
ReferralDocumentationCompletionStatus *CWE `hl7:"12,len=705,table=0865,display=Referral Documentation Completion Status"`
}
Referral Information
This segment represents information that may be useful when sending referrals from the referring provider to the referred-to provider.
type RFI ¶
type RFI struct {
HL7 HL7Name `hl7:",name=RFI,type=s"`
RequestDate DTM `hl7:"1,required,len=24,format=YMDHM,display=Request Date"`
ResponseDueDate DTM `hl7:"2,required,len=24,format=YMDHM,display=Response Due Date"`
PatientConsent ID `hl7:"3,len=1,table=0136,display=Patient Consent"`
DateAdditionalInformationWasSubmitted DTM `hl7:"4,len=24,format=YMDHM,display=Date Additional Information was submitted"`
}
Request for Information
type RFR ¶
type RFR struct {
HL7 HL7Name `hl7:",name=RFR,len=352,type=d"`
NumericRange NR `` /* 280-byte string literal not displayed */
AdministrativeSex IS `` /* 227-byte string literal not displayed */
AgeRange *NR `` /* 435-byte string literal not displayed */
GestationalAgeRange *NR `` /* 487-byte string literal not displayed */
Species ST `` /* 198-byte string literal not displayed */
RaceSubspecies ST `` /* 351-byte string literal not displayed */
Conditions TX `` /* 347-byte string literal not displayed */
}
Reference Range
Describes a reference range and its supporting detail.
type RGR_RGR ¶
type RGR_RGR struct {
HL7 HL7Name `hl7:",name=RGR_RGR,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
Definition []RGR_RGR_Definition `hl7:",required,display=Definition"`
DSC *DSC `hl7:"17,display=Continuation Pointer"`
}
Pharmacy/Treatment Dose Information Response
This query/response pair is retained for backward compatibility only.
type RGR_RGR_Definition ¶
type RGR_RGR_Definition struct {
HL7 HL7Name `hl7:",name=RGR_RGR_Definition,type=tg"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
Patient *RGR_RGR_Patient `hl7:",display=Patient"`
Order []RGR_RGR_Order `hl7:",required,display=Order"`
}
Definition
type RGR_RGR_Encoding ¶
type RGR_RGR_Encoding struct {
HL7 HL7Name `hl7:",name=RGR_RGR_Encoding,type=tg"`
RXE *RXE `hl7:"11,required,display=Pharmacy/Treatment Encoded Order"`
RXR []RXR `hl7:"12,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"13,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RGR_RGR_Order ¶
type RGR_RGR_Order struct {
HL7 HL7Name `hl7:",name=RGR_RGR_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Encoding *RGR_RGR_Encoding `hl7:",display=Encoding"`
RXG []RXG `hl7:"14,required,display=Pharmacy/Treatment Give"`
RXR []RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"16,display=Pharmacy/Treatment Component Order"`
}
Order
type RGR_RGR_Patient ¶
type RGR_RGR_Patient struct {
HL7 HL7Name `hl7:",name=RGR_RGR_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Patient
type RGS ¶
type RGS struct {
HL7 HL7Name `hl7:",name=RGS,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID - RGS"`
SegmentActionCode ID `hl7:"2,conditional,len=3,table=0206,display=Segment Action Code"`
ResourceGroupID *CWE `hl7:"3,len=250,display=Resource Group ID"`
}
Resource Group
The RGS segment is used to identify relationships between resources identified for a scheduled event. This segment can be used, on a site specified basis, to identify groups of resources that are used together within a scheduled event, or to describe some other relationship between resources. To specify related groups of resources within a message, begin each group with an RGS segment, and then follow that RGS with one or more of the Appointment Information segments (AIG, AIL, AIS, or AIP).
type RGV_O15 ¶
type RGV_O15 struct {
HL7 HL7Name `hl7:",name=RGV_O15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient *RGV_O15_Patient `hl7:",display=Patient"`
Order []RGV_O15_Order `hl7:",required,display=Order"`
}
Pharmacy/Treatment Give
The RDS message's RXD segment carries the dispense data for a given issuance of medication: thus it may describe a single dose, a half-day dose, a daily dose, a refill of a prescription, etc. It does not contain the given instructions or scheduling information. When this "give" (i.e., administration) information needs to be transmitted from the pharmacy or treatment application to another application, it is done with the RGV message.
The RGV message uses the RXG segment to record drug or treatment administration instructions. It may carry information about a single scheduled administration on a drug or treatment, or it may carry information about multiple administrations.
type RGV_O15_Components ¶
type RGV_O15_Components struct {
HL7 HL7Name `hl7:",name=RGV_O15_Components,type=tg"`
RXC *RXC `hl7:"16,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
Components
type RGV_O15_Encoding ¶
type RGV_O15_Encoding struct {
HL7 HL7Name `hl7:",name=RGV_O15_Encoding,type=tg"`
RXE *RXE `hl7:"18,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RGV_O15_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"21,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"22,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RGV_O15_Give ¶
type RGV_O15_Give struct {
HL7 HL7Name `hl7:",name=RGV_O15_Give,type=tg"`
RXG *RXG `hl7:"23,required,display=Pharmacy/Treatment Give"`
TimingGive []RGV_O15_TimingGive `hl7:",required,display=Timing Give"`
RXR []RXR `hl7:"26,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"27,display=Pharmacy/Treatment Component Order"`
Observation []RGV_O15_Observation `hl7:",required,display=Observation"`
}
Give
type RGV_O15_Observation ¶
type RGV_O15_Observation struct {
HL7 HL7Name `hl7:",name=RGV_O15_Observation,type=tg"`
OBX *OBX `hl7:"28,display=Observation/Result"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Observation
type RGV_O15_Order ¶
type RGV_O15_Order struct {
HL7 HL7Name `hl7:",name=RGV_O15_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
Timing []RGV_O15_Timing `hl7:",display=Timing"`
OrderDetail *RGV_O15_OrderDetail `hl7:",display=Order Detail"`
Encoding *RGV_O15_Encoding `hl7:",display=Encoding"`
Give []RGV_O15_Give `hl7:",required,display=Give"`
}
Order
type RGV_O15_OrderDetail ¶
type RGV_O15_OrderDetail struct {
HL7 HL7Name `hl7:",name=RGV_O15_OrderDetail,type=tg"`
RXO *RXO `hl7:"13,required,display=Pharmacy/Treatment Order"`
OrderDetailSupplement *RGV_O15_OrderDetailSupplement `hl7:",display=Order Detail Supplement"`
}
OrderDetail
type RGV_O15_OrderDetailSupplement ¶
type RGV_O15_OrderDetailSupplement struct {
HL7 HL7Name `hl7:",name=RGV_O15_OrderDetailSupplement,type=tg"`
NTE []NTE `hl7:"14,required,display=Notes and Comments"`
RXR []RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
Components []RGV_O15_Components `hl7:",display=Components"`
}
OrderDetailSupplement
type RGV_O15_Patient ¶
type RGV_O15_Patient struct {
HL7 HL7Name `hl7:",name=RGV_O15_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
AL1 []AL1 `hl7:"7,display=Patient Allergy Information"`
PatientVisit *RGV_O15_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type RGV_O15_PatientVisit ¶
type RGV_O15_PatientVisit struct {
HL7 HL7Name `hl7:",name=RGV_O15_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"8,required,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
}
PatientVisit
type RGV_O15_Timing ¶
type RGV_O15_Timing struct {
HL7 HL7Name `hl7:",name=RGV_O15_Timing,type=tg"`
TQ1 *TQ1 `hl7:"11,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"12,display=Timing/Quantity Relationship"`
}
Timing
type RGV_O15_TimingEncoded ¶
type RGV_O15_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RGV_O15_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"19,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"20,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RGV_O15_TimingGive ¶
type RGV_O15_TimingGive struct {
HL7 HL7Name `hl7:",name=RGV_O15_TimingGive,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
TimingGive
type RI ¶
type RI struct {
HL7 HL7Name `hl7:",name=RI,len=206,type=d"`
RepeatPattern IS `` /* 184-byte string literal not displayed */
ExplicitTimeInterval ST `` /* 868-byte string literal not displayed */
}
Repeat Interval
contains the interval between repeated services.
type RMC ¶
type RMC struct {
HL7 HL7Name `hl7:",name=RMC,len=82,type=d"`
RoomType IS `hl7:"1,required,len=20,table=0145,display=Specifies the room type."`
AmountType IS `hl7:"2,len=20,table=0146,display=Specifies amount quantity type"`
CoverageAmount NM `hl7:"3,len=16,display=Specifies amount covered by the insurance as a currency or percentage quantity."`
MoneyOrPercentage MOP `hl7:"4,required,len=23,display=Specifies an amount that may be either currency or a percentage."`
}
Room Coverage
This data type specifies insurance coverage detail for a room.
type RMI ¶
type RMI struct {
HL7 HL7Name `hl7:",name=RMI,type=s"`
RiskManagementIncidentCode *CWE `hl7:"1,len=250,table=0427,display=Risk Management Incident Code"`
DateTimeIncident DTM `hl7:"2,len=24,format=YMDHM,display=Date/Time Incident"`
IncidentTypeCode *CWE `hl7:"3,len=250,table=0428,display=Incident Type Code"`
}
Risk Management Incident
The RMI segment is used to report an occurrence of an incident event pertaining or attaching to a patient encounter.
type ROL ¶
type ROL struct {
HL7 HL7Name `hl7:",name=ROL,type=s"`
RoleInstanceID *EI `hl7:"1,conditional,len=60,display=Role Instance ID"`
ActionCode ID `hl7:"2,required,len=2,table=0287,display=Action Code"`
Role CWE `hl7:"3,required,len=250,table=0443,display=Role-ROL"`
RolePerson []XCN `hl7:"4,required,len=250,display=Role Person"`
RoleBeginDateTime DTM `hl7:"5,len=24,format=YMDHM,display=Role Begin Date/Time"`
RoleEndDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Role End Date/Time"`
RoleDuration *CWE `hl7:"7,len=250,display=Role Duration"`
RoleActionReason *CWE `hl7:"8,len=250,display=Role Action Reason"`
ProviderType []CWE `hl7:"9,len=250,display=Provider Type"`
OrganizationUnitType *CWE `hl7:"10,len=250,table=0406,display=Organization Unit Type"`
OfficeHomeAddressBirthplace []XAD `hl7:"11,len=250,display=Office/Home Address/Birthplace"`
Phone []XTN `hl7:"12,len=250,display=Phone"`
PersonsLocation *PL `hl7:"13,len=1230,display=Person's Location"`
}
Role
The role segment contains the data necessary to add, update, correct, and delete from the record persons involved, as well as their functional involvement with the activity being transmitted.
type ROR_ROR ¶
type ROR_ROR struct {
HL7 HL7Name `hl7:",name=ROR_ROR,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
Definition []ROR_ROR_Definition `hl7:",required,display=Definition"`
DSC *DSC `hl7:"14,display=Continuation Pointer"`
}
Pharmacy Prescription Order Response
This query/response pair is retained for backward compatibility only.
type ROR_ROR_Definition ¶
type ROR_ROR_Definition struct {
HL7 HL7Name `hl7:",name=ROR_ROR_Definition,type=tg"`
QRD *QRD `hl7:"6,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"7,display=Original style query filter"`
Patient *ROR_ROR_Patient `hl7:",display=Patient"`
Order []ROR_ROR_Order `hl7:",required,display=Order"`
}
Definition
type ROR_ROR_Order ¶
type ROR_ROR_Order struct {
HL7 HL7Name `hl7:",name=ROR_ROR_Order,type=tg"`
ORC *ORC `hl7:"10,required,display=Common Order"`
RXO *RXO `hl7:"11,required,display=Pharmacy/Treatment Order"`
RXR []RXR `hl7:"12,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"13,display=Pharmacy/Treatment Component Order"`
}
Order
type ROR_ROR_Patient ¶
type ROR_ROR_Patient struct {
HL7 HL7Name `hl7:",name=ROR_ROR_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Patient
type RPA_I08 ¶
type RPA_I08 struct {
HL7 HL7Name `hl7:",name=RPA_I08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
Authorization1 *RPA_I08_Authorization1 `hl7:",display=Authorization 1"`
Provider []RPA_I08_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"10,required,display=Patient Identification"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"12,display=Guarantor"`
Insurance []RPA_I08_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"16,display=Accident"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG []DRG `hl7:"18,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"19,display=Patient Allergy Information"`
Procedure []RPA_I08_Procedure `hl7:",required,display=Procedure"`
Observation []RPA_I08_Observation `hl7:",display=Observation"`
Visit *RPA_I08_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Return Treatment Authorization Information
This event triggers a message to be sent from a healthcare provider to a payor requesting authorization to perform specific medical procedures or tests on a given patient. The specific medical procedures must be filled out in the PR1 segments. Each repeating PR1 segment may be paired with an AUT segment so that authorization information can be given regarding dollar amounts, number of treatments, and perhaps the estimated length of stay for treatment. The OBR and OBX segments should be used to include any relevant clinical information that may be required to support or process the authorization.
type RPA_I08_Authorization1 ¶
type RPA_I08_Authorization1 struct {
HL7 HL7Name `hl7:",name=RPA_I08_Authorization1,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
Authorization1
type RPA_I08_Authorization2 ¶
type RPA_I08_Authorization2 struct {
HL7 HL7Name `hl7:",name=RPA_I08_Authorization2,type=tg"`
AUT *AUT `hl7:"21,required,display=Authorization Information"`
CTD *CTD `hl7:"22,display=Contact Data"`
}
Authorization2
type RPA_I08_Insurance ¶
type RPA_I08_Insurance struct {
HL7 HL7Name `hl7:",name=RPA_I08_Insurance,type=tg"`
IN1 *IN1 `hl7:"13,required,display=Insurance"`
IN2 *IN2 `hl7:"14,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"15,display=Insurance Additional Information- Certification"`
}
Insurance
type RPA_I08_Observation ¶
type RPA_I08_Observation struct {
HL7 HL7Name `hl7:",name=RPA_I08_Observation,type=tg"`
OBR *OBR `hl7:"23,required,display=Observation Request"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
Results []RPA_I08_Results `hl7:",display=Results"`
}
Observation
type RPA_I08_Procedure ¶
type RPA_I08_Procedure struct {
HL7 HL7Name `hl7:",name=RPA_I08_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
Authorization2 *RPA_I08_Authorization2 `hl7:",display=Authorization 2"`
}
Procedure
type RPA_I08_Provider ¶
type RPA_I08_Provider struct {
HL7 HL7Name `hl7:",name=RPA_I08_Provider,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
Provider
type RPA_I08_Results ¶
type RPA_I08_Results struct {
HL7 HL7Name `hl7:",name=RPA_I08_Results,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
Results
type RPA_I08_Visit ¶
type RPA_I08_Visit struct {
HL7 HL7Name `hl7:",name=RPA_I08_Visit,type=tg"`
PV1 *PV1 `hl7:"27,required,display=Patient Visit"`
PV2 *PV2 `hl7:"28,display=Patient Visit - Additional Information"`
}
Visit
type RPA_I09 ¶
type RPA_I09 struct {
HL7 HL7Name `hl7:",name=RPA_I09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
Authorization1 *RPA_I09_Authorization1 `hl7:",display=Authorization 1"`
Provider []RPA_I09_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"10,required,display=Patient Identification"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"12,display=Guarantor"`
Insurance []RPA_I09_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"16,display=Accident"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG []DRG `hl7:"18,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"19,display=Patient Allergy Information"`
Procedure []RPA_I09_Procedure `hl7:",required,display=Procedure"`
Observation []RPA_I09_Observation `hl7:",display=Observation"`
Visit *RPA_I09_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Return Modification to an Authorization
This event triggers a message sent from a healthcare provider to a payor requesting changes to a previously referenced authorization. For example, a provider may determine that a substitute testing or surgical procedure should be performed on a specified patient.
type RPA_I09_Authorization1 ¶
type RPA_I09_Authorization1 struct {
HL7 HL7Name `hl7:",name=RPA_I09_Authorization1,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
Authorization1
type RPA_I09_Authorization2 ¶
type RPA_I09_Authorization2 struct {
HL7 HL7Name `hl7:",name=RPA_I09_Authorization2,type=tg"`
AUT *AUT `hl7:"21,required,display=Authorization Information"`
CTD *CTD `hl7:"22,display=Contact Data"`
}
Authorization2
type RPA_I09_Insurance ¶
type RPA_I09_Insurance struct {
HL7 HL7Name `hl7:",name=RPA_I09_Insurance,type=tg"`
IN1 *IN1 `hl7:"13,required,display=Insurance"`
IN2 *IN2 `hl7:"14,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"15,display=Insurance Additional Information- Certification"`
}
Insurance
type RPA_I09_Observation ¶
type RPA_I09_Observation struct {
HL7 HL7Name `hl7:",name=RPA_I09_Observation,type=tg"`
OBR *OBR `hl7:"23,required,display=Observation Request"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
Results []RPA_I09_Results `hl7:",display=Results"`
}
Observation
type RPA_I09_Procedure ¶
type RPA_I09_Procedure struct {
HL7 HL7Name `hl7:",name=RPA_I09_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
Authorization2 *RPA_I09_Authorization2 `hl7:",display=Authorization 2"`
}
Procedure
type RPA_I09_Provider ¶
type RPA_I09_Provider struct {
HL7 HL7Name `hl7:",name=RPA_I09_Provider,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
Provider
type RPA_I09_Results ¶
type RPA_I09_Results struct {
HL7 HL7Name `hl7:",name=RPA_I09_Results,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
Results
type RPA_I09_Visit ¶
type RPA_I09_Visit struct {
HL7 HL7Name `hl7:",name=RPA_I09_Visit,type=tg"`
PV1 *PV1 `hl7:"27,required,display=Patient Visit"`
PV2 *PV2 `hl7:"28,display=Patient Visit - Additional Information"`
}
Visit
type RPA_I10 ¶
type RPA_I10 struct {
HL7 HL7Name `hl7:",name=RPA_I10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
Authorization1 *RPA_I10_Authorization1 `hl7:",display=Authorization 1"`
Provider []RPA_I10_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"10,required,display=Patient Identification"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"12,display=Guarantor"`
Insurance []RPA_I10_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"16,display=Accident"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG []DRG `hl7:"18,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"19,display=Patient Allergy Information"`
Procedure []RPA_I10_Procedure `hl7:",required,display=Procedure"`
Observation []RPA_I10_Observation `hl7:",display=Observation"`
Visit *RPA_I10_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Return Resubmission of an Authorization
If a previously submitted request for treatment authorization is rejected or canceled, this event could trigger a resubmission message for a referenced authorization. For example, the payor may have rejected a request until additional clinical information is sent to support the authorization request.
type RPA_I10_Authorization1 ¶
type RPA_I10_Authorization1 struct {
HL7 HL7Name `hl7:",name=RPA_I10_Authorization1,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
Authorization1
type RPA_I10_Authorization2 ¶
type RPA_I10_Authorization2 struct {
HL7 HL7Name `hl7:",name=RPA_I10_Authorization2,type=tg"`
AUT *AUT `hl7:"21,required,display=Authorization Information"`
CTD *CTD `hl7:"22,display=Contact Data"`
}
Authorization2
type RPA_I10_Insurance ¶
type RPA_I10_Insurance struct {
HL7 HL7Name `hl7:",name=RPA_I10_Insurance,type=tg"`
IN1 *IN1 `hl7:"13,required,display=Insurance"`
IN2 *IN2 `hl7:"14,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"15,display=Insurance Additional Information- Certification"`
}
Insurance
type RPA_I10_Observation ¶
type RPA_I10_Observation struct {
HL7 HL7Name `hl7:",name=RPA_I10_Observation,type=tg"`
OBR *OBR `hl7:"23,required,display=Observation Request"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
Results []RPA_I10_Results `hl7:",display=Results"`
}
Observation
type RPA_I10_Procedure ¶
type RPA_I10_Procedure struct {
HL7 HL7Name `hl7:",name=RPA_I10_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
Authorization2 *RPA_I10_Authorization2 `hl7:",display=Authorization 2"`
}
Procedure
type RPA_I10_Provider ¶
type RPA_I10_Provider struct {
HL7 HL7Name `hl7:",name=RPA_I10_Provider,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
Provider
type RPA_I10_Results ¶
type RPA_I10_Results struct {
HL7 HL7Name `hl7:",name=RPA_I10_Results,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
Results
type RPA_I10_Visit ¶
type RPA_I10_Visit struct {
HL7 HL7Name `hl7:",name=RPA_I10_Visit,type=tg"`
PV1 *PV1 `hl7:"27,required,display=Patient Visit"`
PV2 *PV2 `hl7:"28,display=Patient Visit - Additional Information"`
}
Visit
type RPA_I11 ¶
type RPA_I11 struct {
HL7 HL7Name `hl7:",name=RPA_I11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
Authorization1 *RPA_I11_Authorization1 `hl7:",display=Authorization 1"`
Provider []RPA_I11_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"10,required,display=Patient Identification"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"12,display=Guarantor"`
Insurance []RPA_I11_Insurance `hl7:",display=Insurance"`
ACC *ACC `hl7:"16,display=Accident"`
DG1 []DG1 `hl7:"17,display=Diagnosis"`
DRG []DRG `hl7:"18,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"19,display=Patient Allergy Information"`
Procedure []RPA_I11_Procedure `hl7:",required,display=Procedure"`
Observation []RPA_I11_Observation `hl7:",display=Observation"`
Visit *RPA_I11_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"29,display=Notes and Comments"`
}
Return Cancellation of an Authorization
This event may trigger the cancellation of an authorization. It may be used by the provider to indicate that an authorized service was not performed, or perhaps that the patient changed to another provider. A payor may use this request to reject a submitted authorization request from a provider.
type RPA_I11_Authorization1 ¶
type RPA_I11_Authorization1 struct {
HL7 HL7Name `hl7:",name=RPA_I11_Authorization1,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
Authorization1
type RPA_I11_Authorization2 ¶
type RPA_I11_Authorization2 struct {
HL7 HL7Name `hl7:",name=RPA_I11_Authorization2,type=tg"`
AUT *AUT `hl7:"21,required,display=Authorization Information"`
CTD *CTD `hl7:"22,display=Contact Data"`
}
Authorization2
type RPA_I11_Insurance ¶
type RPA_I11_Insurance struct {
HL7 HL7Name `hl7:",name=RPA_I11_Insurance,type=tg"`
IN1 *IN1 `hl7:"13,required,display=Insurance"`
IN2 *IN2 `hl7:"14,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"15,display=Insurance Additional Information- Certification"`
}
Insurance
type RPA_I11_Observation ¶
type RPA_I11_Observation struct {
HL7 HL7Name `hl7:",name=RPA_I11_Observation,type=tg"`
OBR *OBR `hl7:"23,required,display=Observation Request"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
Results []RPA_I11_Results `hl7:",display=Results"`
}
Observation
type RPA_I11_Procedure ¶
type RPA_I11_Procedure struct {
HL7 HL7Name `hl7:",name=RPA_I11_Procedure,type=tg"`
PR1 *PR1 `hl7:"20,required,display=Procedures"`
Authorization2 *RPA_I11_Authorization2 `hl7:",display=Authorization 2"`
}
Procedure
type RPA_I11_Provider ¶
type RPA_I11_Provider struct {
HL7 HL7Name `hl7:",name=RPA_I11_Provider,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
Provider
type RPA_I11_Results ¶
type RPA_I11_Results struct {
HL7 HL7Name `hl7:",name=RPA_I11_Results,type=tg"`
OBX *OBX `hl7:"25,required,display=Observation/Result"`
NTE []NTE `hl7:"26,display=Notes and Comments"`
}
Results
type RPA_I11_Visit ¶
type RPA_I11_Visit struct {
HL7 HL7Name `hl7:",name=RPA_I11_Visit,type=tg"`
PV1 *PV1 `hl7:"27,required,display=Patient Visit"`
PV2 *PV2 `hl7:"28,display=Patient Visit - Additional Information"`
}
Visit
type RPI_I01 ¶
type RPI_I01 struct {
HL7 HL7Name `hl7:",name=RPI_I01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
Provider []RPI_I01_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RPI_I01_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Return Insurance Information
This event triggers a message to be sent from one healthcare provider to another to request insurance information for a specified patient.
type RPI_I01_GuarantorInsurance ¶
type RPI_I01_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RPI_I01_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"9,display=Guarantor"`
Insurance []RPI_I01_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RPI_I01_Insurance ¶
type RPI_I01_Insurance struct {
HL7 HL7Name `hl7:",name=RPI_I01_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type RPI_I01_Provider ¶
type RPI_I01_Provider struct {
HL7 HL7Name `hl7:",name=RPI_I01_Provider,type=tg"`
PRD *PRD `hl7:"5,required,display=Provider Data"`
CTD []CTD `hl7:"6,display=Contact Data"`
}
Provider
type RPI_I04 ¶
type RPI_I04 struct {
HL7 HL7Name `hl7:",name=RPI_I04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
Provider []RPI_I04_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RPI_I04_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Return Patient Demographic Data
This event triggers a request from one healthcare provider to another for patient demographic information, including insurance and billing information. Typically, this transaction would occur between one provider to another, but it could also be directed to a payor.
type RPI_I04_GuarantorInsurance ¶
type RPI_I04_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RPI_I04_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"9,display=Guarantor"`
Insurance []RPI_I04_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RPI_I04_Insurance ¶
type RPI_I04_Insurance struct {
HL7 HL7Name `hl7:",name=RPI_I04_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type RPI_I04_Provider ¶
type RPI_I04_Provider struct {
HL7 HL7Name `hl7:",name=RPI_I04_Provider,type=tg"`
PRD *PRD `hl7:"5,required,display=Provider Data"`
CTD []CTD `hl7:"6,display=Contact Data"`
}
Provider
type RPL_I02 ¶
type RPL_I02 struct {
HL7 HL7Name `hl7:",name=RPL_I02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
Provider []RPL_I02_Provider `hl7:",required,display=Provider"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
DSP []DSP `hl7:"8,display=Display Data"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Return Patient Selection Display List
This trigger event occurs when the inquirer specifies a request for a name lookup listing. Generally, this request is used by the responder when insufficient data is on hand for a positive match. In this case, the requester may ask for a list of possible candidates from which to make a selection. This event code is also used by the responder to signify that the return information contains a list of information rather than information specific to a single patient.
type RPL_I02_Provider ¶
type RPL_I02_Provider struct {
HL7 HL7Name `hl7:",name=RPL_I02_Provider,type=tg"`
PRD *PRD `hl7:"5,required,display=Provider Data"`
CTD []CTD `hl7:"6,display=Contact Data"`
}
Provider
type RPR_I03 ¶
type RPR_I03 struct {
HL7 HL7Name `hl7:",name=RPR_I03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
Provider []RPR_I03_Provider `hl7:",required,display=Provider"`
PID []PID `hl7:"7,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Return Patient Selection List
This trigger event occurs when the inquirer specifies a request for a listing of patient names. This event differs from event I02 (request/receipts of patient selection display list) in that it returns the patient list in repeating PID segments instead of repeating DSP segments.
type RPR_I03_Provider ¶
type RPR_I03_Provider struct {
HL7 HL7Name `hl7:",name=RPR_I03_Provider,type=tg"`
PRD *PRD `hl7:"5,required,display=Provider Data"`
CTD []CTD `hl7:"6,display=Contact Data"`
}
Provider
type RPT ¶
type RPT struct {
HL7 HL7Name `hl7:",name=RPT,len=984,type=d"`
RepeatPatternCode CWE `` /* 205-byte string literal not displayed */
CalendarAlignment ID `` /* 216-byte string literal not displayed */
PhaseRangeBeginValue NM `` /* 293-byte string literal not displayed */
PhaseRangeEndValue NM `` /* 181-byte string literal not displayed */
PeriodQuantity NM `` /* 170-byte string literal not displayed */
PeriodUnits IS `` /* 243-byte string literal not displayed */
InstitutionSpecifiedTime ID `` /* 239-byte string literal not displayed */
Event ID `` /* 156-byte string literal not displayed */
EventOffsetQuantity NM `` /* 424-byte string literal not displayed */
EventOffsetUnits IS `` /* 250-byte string literal not displayed */
GeneralTimingSpecification GTS `hl7:"11,len=200,display=The General Timing Specification as defined by the Version 3 Data Types document."`
}
Repeat Pattern
The repeat pattern data type should be used where it is necessary to define the frequency at which an event is to take place. This data type provides a way to define repeat pattern codes "on the fly". The repeat pattern code is equivalent to the TQ data type, component 2, sub-component 1 (repeat pattern). The additional components define the meaning of the repeat pattern code. Components 2 - 10 are used to define relatively simple repeat patterns. Component 11 is provided to define complex repeat patterns. This data type forms a bridge between the 2.x Repeat Pattern concept from Quantity/Timing, and the Version 3.0 GTS General Timing Specification. Component 1 is the 2.x concept of repeat pattern. Components 2-7 are derived from the version 3.0 data type PIVL. Components 8-10 are derived from the version 3.0 EIVL data type. If a repeat pattern cannot be defined using components 2-10, then component 11, General Timing Specification is provided. This allows the full literal form of the version 3.0 GTS to be specified.
type RQ1 ¶
type RQ1 struct {
HL7 HL7Name `hl7:",name=RQ1,type=s"`
AnticipatedPrice ST `hl7:"1,len=10,display=Anticipated Price"`
ManufacturerIdentifier *CWE `hl7:"2,conditional,len=705,table=0385,display=Manufacturer Identifier"`
ManufacturersCatalog ST `hl7:"3,conditional,len=16,display=Manufacturer's Catalog"`
VendorID *CWE `hl7:"4,conditional,len=250,display=Vendor ID"`
VendorCatalog ST `hl7:"5,conditional,len=16,display=Vendor Catalog"`
Taxable ID `hl7:"6,len=1,table=0136,display=Taxable"`
SubstituteAllowed ID `hl7:"7,len=1,table=0136,display=Substitute Allowed"`
}
Requisition Detail-1
RQ1 contains additional detail for each non-stock requisitioned item. This segment definition is paired with a preceding RQD segment.
type RQA_I08 ¶
type RQA_I08 struct {
HL7 HL7Name `hl7:",name=RQA_I08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
Authorization *RQA_I08_Authorization `hl7:",display=Authorization"`
Provider []RQA_I08_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQA_I08_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []RQA_I08_Procedure `hl7:",display=Procedure"`
Observation []RQA_I08_Observation `hl7:",display=Observation"`
Visit *RQA_I08_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Request for Treatment Authorization Information
This event triggers a message to be sent from a healthcare provider to a payor requesting authorization to perform specific medical procedures or tests on a given patient. The specific medical procedures must be filled out in the PR1 segments. Each repeating PR1 segment may be paired with an AUT segment so that authorization information can be given regarding dollar amounts, number of treatments, and perhaps the estimated length of stay for treatment. The OBR and OBX segments should be used to include any relevant clinical information that may be required to support or process the authorization.
type RQA_I08_Authorization ¶
type RQA_I08_Authorization struct {
HL7 HL7Name `hl7:",name=RQA_I08_Authorization,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
Authorization
type RQA_I08_Authorization2 ¶
type RQA_I08_Authorization2 struct {
HL7 HL7Name `hl7:",name=RQA_I08_Authorization2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
Authorization
type RQA_I08_GuarantorInsurance ¶
type RQA_I08_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQA_I08_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []RQA_I08_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQA_I08_Insurance ¶
type RQA_I08_Insurance struct {
HL7 HL7Name `hl7:",name=RQA_I08_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type RQA_I08_Observation ¶
type RQA_I08_Observation struct {
HL7 HL7Name `hl7:",name=RQA_I08_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
Results []RQA_I08_Results `hl7:",display=Results"`
}
Observation
type RQA_I08_Procedure ¶
type RQA_I08_Procedure struct {
HL7 HL7Name `hl7:",name=RQA_I08_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
Authorization *RQA_I08_Authorization2 `hl7:",display=Authorization"`
}
Procedure
type RQA_I08_Provider ¶
type RQA_I08_Provider struct {
HL7 HL7Name `hl7:",name=RQA_I08_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RQA_I08_Results ¶
type RQA_I08_Results struct {
HL7 HL7Name `hl7:",name=RQA_I08_Results,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Results
type RQA_I08_Visit ¶
type RQA_I08_Visit struct {
HL7 HL7Name `hl7:",name=RQA_I08_Visit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
Visit
type RQA_I09 ¶
type RQA_I09 struct {
HL7 HL7Name `hl7:",name=RQA_I09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
Authorization *RQA_I09_Authorization `hl7:",display=Authorization"`
Provider []RQA_I09_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQA_I09_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []RQA_I09_Procedure `hl7:",display=Procedure"`
Observation []RQA_I09_Observation `hl7:",display=Observation"`
Visit *RQA_I09_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Request for Modification to an Authorization
This event triggers a message sent from a healthcare provider to a payor requesting changes to a previously referenced authorization. For example, a provider may determine that a substitute testing or surgical procedure should be performed on a specified patient.
type RQA_I09_Authorization ¶
type RQA_I09_Authorization struct {
HL7 HL7Name `hl7:",name=RQA_I09_Authorization,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
Authorization
type RQA_I09_Authorization2 ¶
type RQA_I09_Authorization2 struct {
HL7 HL7Name `hl7:",name=RQA_I09_Authorization2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
Authorization
type RQA_I09_GuarantorInsurance ¶
type RQA_I09_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQA_I09_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []RQA_I09_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQA_I09_Insurance ¶
type RQA_I09_Insurance struct {
HL7 HL7Name `hl7:",name=RQA_I09_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type RQA_I09_Observation ¶
type RQA_I09_Observation struct {
HL7 HL7Name `hl7:",name=RQA_I09_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
Results []RQA_I09_Results `hl7:",display=Results"`
}
Observation
type RQA_I09_Procedure ¶
type RQA_I09_Procedure struct {
HL7 HL7Name `hl7:",name=RQA_I09_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
Authorization *RQA_I09_Authorization2 `hl7:",display=Authorization"`
}
Procedure
type RQA_I09_Provider ¶
type RQA_I09_Provider struct {
HL7 HL7Name `hl7:",name=RQA_I09_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RQA_I09_Results ¶
type RQA_I09_Results struct {
HL7 HL7Name `hl7:",name=RQA_I09_Results,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Results
type RQA_I09_Visit ¶
type RQA_I09_Visit struct {
HL7 HL7Name `hl7:",name=RQA_I09_Visit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
Visit
type RQA_I10 ¶
type RQA_I10 struct {
HL7 HL7Name `hl7:",name=RQA_I10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
Authorization *RQA_I10_Authorization `hl7:",display=Authorization"`
Provider []RQA_I10_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQA_I10_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []RQA_I10_Procedure `hl7:",display=Procedure"`
Observation []RQA_I10_Observation `hl7:",display=Observation"`
Visit *RQA_I10_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Request for Resubmission of an Authorization
If a previously submitted request for treatment authorization is rejected or canceled, this event could trigger a resubmission message for a referenced authorization. For example, the payor may have rejected a request until additional clinical information is sent to support the authorization request.
type RQA_I10_Authorization ¶
type RQA_I10_Authorization struct {
HL7 HL7Name `hl7:",name=RQA_I10_Authorization,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
Authorization
type RQA_I10_Authorization2 ¶
type RQA_I10_Authorization2 struct {
HL7 HL7Name `hl7:",name=RQA_I10_Authorization2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
Authorization
type RQA_I10_GuarantorInsurance ¶
type RQA_I10_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQA_I10_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []RQA_I10_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQA_I10_Insurance ¶
type RQA_I10_Insurance struct {
HL7 HL7Name `hl7:",name=RQA_I10_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type RQA_I10_Observation ¶
type RQA_I10_Observation struct {
HL7 HL7Name `hl7:",name=RQA_I10_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
Results []RQA_I10_Results `hl7:",display=Results"`
}
Observation
type RQA_I10_Procedure ¶
type RQA_I10_Procedure struct {
HL7 HL7Name `hl7:",name=RQA_I10_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
Authorization *RQA_I10_Authorization2 `hl7:",display=Authorization"`
}
Procedure
type RQA_I10_Provider ¶
type RQA_I10_Provider struct {
HL7 HL7Name `hl7:",name=RQA_I10_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RQA_I10_Results ¶
type RQA_I10_Results struct {
HL7 HL7Name `hl7:",name=RQA_I10_Results,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Results
type RQA_I10_Visit ¶
type RQA_I10_Visit struct {
HL7 HL7Name `hl7:",name=RQA_I10_Visit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
Visit
type RQA_I11 ¶
type RQA_I11 struct {
HL7 HL7Name `hl7:",name=RQA_I11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
RF1 *RF1 `hl7:"4,display=Referral Information"`
Authorization *RQA_I11_Authorization `hl7:",display=Authorization"`
Provider []RQA_I11_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"9,required,display=Patient Identification"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQA_I11_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
ACC *ACC `hl7:"15,display=Accident"`
DG1 []DG1 `hl7:"16,display=Diagnosis"`
DRG []DRG `hl7:"17,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"18,display=Patient Allergy Information"`
Procedure []RQA_I11_Procedure `hl7:",display=Procedure"`
Observation []RQA_I11_Observation `hl7:",display=Observation"`
Visit *RQA_I11_Visit `hl7:",display=Visit"`
NTE []NTE `hl7:"28,display=Notes and Comments"`
}
Request Cancellation of an Authorization
This event may trigger the cancellation of an authorization. It may be used by the provider to indicate that an authorized service was not performed, or perhaps that the patient changed to another provider. A payor may use this request to reject a submitted authorization request from a provider.
type RQA_I11_Authorization ¶
type RQA_I11_Authorization struct {
HL7 HL7Name `hl7:",name=RQA_I11_Authorization,type=tg"`
AUT *AUT `hl7:"5,required,display=Authorization Information"`
CTD *CTD `hl7:"6,display=Contact Data"`
}
Authorization
type RQA_I11_Authorization2 ¶
type RQA_I11_Authorization2 struct {
HL7 HL7Name `hl7:",name=RQA_I11_Authorization2,type=tg"`
AUT *AUT `hl7:"20,required,display=Authorization Information"`
CTD *CTD `hl7:"21,display=Contact Data"`
}
Authorization
type RQA_I11_GuarantorInsurance ¶
type RQA_I11_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQA_I11_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"11,display=Guarantor"`
Insurance []RQA_I11_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQA_I11_Insurance ¶
type RQA_I11_Insurance struct {
HL7 HL7Name `hl7:",name=RQA_I11_Insurance,type=tg"`
IN1 *IN1 `hl7:"12,required,display=Insurance"`
IN2 *IN2 `hl7:"13,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"14,display=Insurance Additional Information- Certification"`
}
Insurance
type RQA_I11_Observation ¶
type RQA_I11_Observation struct {
HL7 HL7Name `hl7:",name=RQA_I11_Observation,type=tg"`
OBR *OBR `hl7:"22,required,display=Observation Request"`
NTE []NTE `hl7:"23,display=Notes and Comments"`
Results []RQA_I11_Results `hl7:",display=Results"`
}
Observation
type RQA_I11_Procedure ¶
type RQA_I11_Procedure struct {
HL7 HL7Name `hl7:",name=RQA_I11_Procedure,type=tg"`
PR1 *PR1 `hl7:"19,required,display=Procedures"`
Authorization *RQA_I11_Authorization2 `hl7:",display=Authorization"`
}
Procedure
type RQA_I11_Provider ¶
type RQA_I11_Provider struct {
HL7 HL7Name `hl7:",name=RQA_I11_Provider,type=tg"`
PRD *PRD `hl7:"7,required,display=Provider Data"`
CTD []CTD `hl7:"8,display=Contact Data"`
}
Provider
type RQA_I11_Results ¶
type RQA_I11_Results struct {
HL7 HL7Name `hl7:",name=RQA_I11_Results,type=tg"`
OBX *OBX `hl7:"24,required,display=Observation/Result"`
NTE []NTE `hl7:"25,display=Notes and Comments"`
}
Results
type RQA_I11_Visit ¶
type RQA_I11_Visit struct {
HL7 HL7Name `hl7:",name=RQA_I11_Visit,type=tg"`
PV1 *PV1 `hl7:"26,required,display=Patient Visit"`
PV2 *PV2 `hl7:"27,display=Patient Visit - Additional Information"`
}
Visit
type RQC_I05 ¶
type RQC_I05 struct {
HL7 HL7Name `hl7:",name=RQC_I05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
Provider []RQC_I05_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"10,display=Guarantor"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
Request Patient Clinical Information
Retained for backwards compatibility only in version 2.4 and later.
This event is used to request clinical information for a specific patient. Generally, this transaction occurs between one provider and another (typically a laboratory or radiology, etc.). However, it may also be very useful for a payor-to-provider request for clinical observation information to be used in considering a request for treatment authorization.
type RQC_I05_Provider ¶
type RQC_I05_Provider struct {
HL7 HL7Name `hl7:",name=RQC_I05_Provider,type=tg"`
PRD *PRD `hl7:"6,required,display=Provider Data"`
CTD []CTD `hl7:"7,display=Contact Data"`
}
Provider
type RQC_I06 ¶
type RQC_I06 struct {
HL7 HL7Name `hl7:",name=RQC_I06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
Provider []RQC_I06_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"8,required,display=Patient Identification"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
GT1 *GT1 `hl7:"10,display=Guarantor"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
}
Request Clinical Data Listing
Retained for backwards compatibility only in version 2.4 and later.
This event code is sent from one healthcare provider to another (typically a laboratory or radiology, etc.) to request a list of available clinical observation information. When the provider is dealing with a community model in which remote requests make transmission of large amounts of data impractical, this event code will provide for interactive lists of transactions from which more specific selections can be made.
type RQC_I06_Provider ¶
type RQC_I06_Provider struct {
HL7 HL7Name `hl7:",name=RQC_I06_Provider,type=tg"`
PRD *PRD `hl7:"6,required,display=Provider Data"`
CTD []CTD `hl7:"7,display=Contact Data"`
}
Provider
type RQD ¶
type RQD struct {
HL7 HL7Name `hl7:",name=RQD,type=s"`
RequisitionLineNumber SI `hl7:"1,len=4,display=Requisition Line Number"`
ItemCodeInternal *CWE `hl7:"2,conditional,len=250,display=Item Code - Internal"`
ItemCodeExternal *CWE `hl7:"3,conditional,len=250,display=Item Code - External"`
HospitalItemCode *CWE `hl7:"4,conditional,len=250,display=Hospital Item Code"`
RequisitionQuantity NM `hl7:"5,len=6,display=Requisition Quantity"`
RequisitionUnitOfMeasure *CWE `hl7:"6,len=250,display=Requisition Unit of Measure"`
CostCenterAccountNumber IS `hl7:"7,len=30,table=0319,display=Cost Center Account Number"`
ItemNaturalAccountCode IS `hl7:"8,len=30,table=0320,display=Item Natural Account Code"`
DeliverToID *CWE `hl7:"9,len=250,display=Deliver To ID"`
DateNeeded DT `hl7:"10,len=8,format=YMD,display=Date Needed"`
}
Requisition Detail
RQD contains the detail for each requisitioned item.
type RQI_I01 ¶
type RQI_I01 struct {
HL7 HL7Name `hl7:",name=RQI_I01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Provider []RQI_I01_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"6,required,display=Patient Identification"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQI_I01_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
}
Request Insurance Information
This event triggers a message to be sent from one healthcare provider to another to request insurance information for a specified patient
type RQI_I01_GuarantorInsurance ¶
type RQI_I01_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQI_I01_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"8,display=Guarantor"`
Insurance []RQI_I01_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQI_I01_Insurance ¶
type RQI_I01_Insurance struct {
HL7 HL7Name `hl7:",name=RQI_I01_Insurance,type=tg"`
IN1 *IN1 `hl7:"9,required,display=Insurance"`
IN2 *IN2 `hl7:"10,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"11,display=Insurance Additional Information- Certification"`
}
Insurance
type RQI_I01_Provider ¶
type RQI_I01_Provider struct {
HL7 HL7Name `hl7:",name=RQI_I01_Provider,type=tg"`
PRD *PRD `hl7:"4,required,display=Provider Data"`
CTD []CTD `hl7:"5,display=Contact Data"`
}
Provider
type RQI_I02 ¶
type RQI_I02 struct {
HL7 HL7Name `hl7:",name=RQI_I02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Provider []RQI_I02_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"6,required,display=Patient Identification"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQI_I02_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
}
Request Patient Selection Display List
This trigger event occurs when the inquirer specifies a request for a name lookup listing. Generally, this request is used by the responder when insufficient data is on hand for a positive match. In this case, the requester may ask for a list of possible candidates from which to make a selection. This event code is also used by the responder to signify that the return information contains a list of information rather than information specific to a single patient.
type RQI_I02_GuarantorInsurance ¶
type RQI_I02_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQI_I02_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"8,display=Guarantor"`
Insurance []RQI_I02_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQI_I02_Insurance ¶
type RQI_I02_Insurance struct {
HL7 HL7Name `hl7:",name=RQI_I02_Insurance,type=tg"`
IN1 *IN1 `hl7:"9,required,display=Insurance"`
IN2 *IN2 `hl7:"10,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"11,display=Insurance Additional Information- Certification"`
}
Insurance
type RQI_I02_Provider ¶
type RQI_I02_Provider struct {
HL7 HL7Name `hl7:",name=RQI_I02_Provider,type=tg"`
PRD *PRD `hl7:"4,required,display=Provider Data"`
CTD []CTD `hl7:"5,display=Contact Data"`
}
Provider
type RQI_I03 ¶
type RQI_I03 struct {
HL7 HL7Name `hl7:",name=RQI_I03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Provider []RQI_I03_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"6,required,display=Patient Identification"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
GuarantorInsurance *RQI_I03_GuarantorInsurance `hl7:",display=Guarantor Insurance"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
}
Request Patient Selection List
This trigger event occurs when the inquirer specifies a request for a listing of patient names. This event differs from event I02 (request/receipts of patient selection display list) in that it returns the patient list in repeating PID segments instead of repeating DSP segments.
type RQI_I03_GuarantorInsurance ¶
type RQI_I03_GuarantorInsurance struct {
HL7 HL7Name `hl7:",name=RQI_I03_GuarantorInsurance,type=tg"`
GT1 []GT1 `hl7:"8,display=Guarantor"`
Insurance []RQI_I03_Insurance `hl7:",required,display=Insurance"`
}
GuarantorInsurance
type RQI_I03_Insurance ¶
type RQI_I03_Insurance struct {
HL7 HL7Name `hl7:",name=RQI_I03_Insurance,type=tg"`
IN1 *IN1 `hl7:"9,required,display=Insurance"`
IN2 *IN2 `hl7:"10,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"11,display=Insurance Additional Information- Certification"`
}
Insurance
type RQI_I03_Provider ¶
type RQI_I03_Provider struct {
HL7 HL7Name `hl7:",name=RQI_I03_Provider,type=tg"`
PRD *PRD `hl7:"4,required,display=Provider Data"`
CTD []CTD `hl7:"5,display=Contact Data"`
}
Provider
type RQP_I04 ¶
type RQP_I04 struct {
HL7 HL7Name `hl7:",name=RQP_I04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
Provider []RQP_I04_Provider `hl7:",required,display=Provider"`
PID *PID `hl7:"6,required,display=Patient Identification"`
NK1 []NK1 `hl7:"7,display=Next of Kin / Associated Parties"`
GT1 []GT1 `hl7:"8,display=Guarantor"`
NTE []NTE `hl7:"9,display=Notes and Comments"`
}
Request Patient Demographic Data
This event triggers a request from one healthcare provider to another for patient demographic information, including insurance and billing information. Typically, this transaction would occur between one provider to another, but it could also be directed to a payor.
type RQP_I04_Provider ¶
type RQP_I04_Provider struct {
HL7 HL7Name `hl7:",name=RQP_I04_Provider,type=tg"`
PRD *PRD `hl7:"4,required,display=Provider Data"`
CTD []CTD `hl7:"5,display=Contact Data"`
}
Provider
type RQQ_Q09 ¶
type RQQ_Q09 struct {
HL7 HL7Name `hl7:",name=RQQ_Q09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
ERQ *ERQ `hl7:"3,required,display=Event replay query"`
DSC *DSC `hl7:"4,display=Continuation Pointer"`
}
Event Replay Query
This section is retained for backward compatibility as of V2.4.
The Event Replay Query under version 2.3 provides a way for the querying system to request data formatted very similar to the format that would have been used were this data to be sent as an update in response to a trigger event.
The RQQ is used to request data formatted as an event replay response.
type RRA_O18 ¶
type RRA_O18 struct {
HL7 HL7Name `hl7:",name=RRA_O18,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *RRA_O18_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Administration Acknowledgement
The RAS/RRA message may be created by the administering application (e.g., nursing application) for each instance of administration for an existing order. If the administering application wants to report several administrations of medication/treatment for a given order with a single RAS message, each instance is reported by a separate (repeating) RXA segment. In addition, the administration records for a group of orders may be sent in a single message by creating repeating groups of segments at the ORC level.
type RRA_O18_Administration ¶
type RRA_O18_Administration struct {
HL7 HL7Name `hl7:",name=RRA_O18_Administration,type=tg"`
RXA []RXA `hl7:"12,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"13,required,display=Pharmacy/Treatment Route"`
}
Administration
type RRA_O18_Order ¶
type RRA_O18_Order struct {
HL7 HL7Name `hl7:",name=RRA_O18_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []RRA_O18_Timing `hl7:",display=Timing"`
Administration *RRA_O18_Administration `hl7:",display=Administration"`
}
Order
type RRA_O18_Patient ¶
type RRA_O18_Patient struct {
HL7 HL7Name `hl7:",name=RRA_O18_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type RRA_O18_Response ¶
type RRA_O18_Response struct {
HL7 HL7Name `hl7:",name=RRA_O18_Response,type=tg"`
Patient *RRA_O18_Patient `hl7:",display=Patient"`
Order []RRA_O18_Order `hl7:",required,display=Order"`
}
Response
type RRA_O18_Timing ¶
type RRA_O18_Timing struct {
HL7 HL7Name `hl7:",name=RRA_O18_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type RRD_O14 ¶
type RRD_O14 struct {
HL7 HL7Name `hl7:",name=RRD_O14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *RRD_O14_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Dispense Acknowledgement
The RDS/RRD message may be created by the pharmacy/treatment application for each instance of dispensing a drug or treatment to fill an existing order or orders. In the most common case, the RDS messages would be routed to a Nursing application or to some clinical application, which needs the data about drugs dispensed or treatments given. As a site-specific variant, the original order segments (RXO, RXE and their associated RXR/RXCs) may be sent optionally (for comparison).
type RRD_O14_Dispense ¶
type RRD_O14_Dispense struct {
HL7 HL7Name `hl7:",name=RRD_O14_Dispense,type=tg"`
RXD *RXD `hl7:"12,required,display=Pharmacy/Treatment Dispense"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
RXR []RXR `hl7:"14,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"15,display=Pharmacy/Treatment Component Order"`
}
Dispense
type RRD_O14_Order ¶
type RRD_O14_Order struct {
HL7 HL7Name `hl7:",name=RRD_O14_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []RRD_O14_Timing `hl7:",display=Timing"`
Dispense *RRD_O14_Dispense `hl7:",display=Dispense"`
}
Order
type RRD_O14_Patient ¶
type RRD_O14_Patient struct {
HL7 HL7Name `hl7:",name=RRD_O14_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type RRD_O14_Response ¶
type RRD_O14_Response struct {
HL7 HL7Name `hl7:",name=RRD_O14_Response,type=tg"`
Patient *RRD_O14_Patient `hl7:",display=Patient"`
Order []RRD_O14_Order `hl7:",required,display=Order"`
}
Response
type RRD_O14_Timing ¶
type RRD_O14_Timing struct {
HL7 HL7Name `hl7:",name=RRD_O14_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type RRE_O12 ¶
type RRE_O12 struct {
HL7 HL7Name `hl7:",name=RRE_O12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *RRE_O12_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Encoded Order Acknowledgement
This message communicates the pharmacy or treatment application's encoding of the pharmacy/treatment order (ORM message with RXO segment, see above). It may be sent as an unsolicited message to report on either a single order or multiple pharmacy/treatment orders for a patient. The RDE/RRE message pair can also be used to communicate a refill authorization request; however, a specific trigger event has been assigned. See section 4.13.13 "RDE - Pharmacy/Treatment Refill Authorization Request Message (Event O25)." As a site-specific variant, the original order segments (RXO, RXRs, associated RXCs, and any NTEs) may be sent optionally (for comparison).
type RRE_O12_Encoding ¶
type RRE_O12_Encoding struct {
HL7 HL7Name `hl7:",name=RRE_O12_Encoding,type=tg"`
RXE *RXE `hl7:"12,required,display=Pharmacy/Treatment Encoded Order"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
TimingEncoded []RRE_O12_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"16,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"17,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RRE_O12_Order ¶
type RRE_O12_Order struct {
HL7 HL7Name `hl7:",name=RRE_O12_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []RRE_O12_Timing `hl7:",display=Timing"`
Encoding *RRE_O12_Encoding `hl7:",display=Encoding"`
}
Order
type RRE_O12_Patient ¶
type RRE_O12_Patient struct {
HL7 HL7Name `hl7:",name=RRE_O12_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type RRE_O12_Response ¶
type RRE_O12_Response struct {
HL7 HL7Name `hl7:",name=RRE_O12_Response,type=tg"`
Patient *RRE_O12_Patient `hl7:",display=Patient"`
Order []RRE_O12_Order `hl7:",required,display=Order"`
}
Response
type RRE_O12_Timing ¶
type RRE_O12_Timing struct {
HL7 HL7Name `hl7:",name=RRE_O12_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type RRE_O12_TimingEncoded ¶
type RRE_O12_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RRE_O12_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RRE_O26 ¶
type RRE_O26 struct {
HL7 HL7Name `hl7:",name=RRE_O26,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *RRE_O26_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Refill Authorization Request Acknowledgment
The RDE/RRE is used to communicate a refill authorization request originating with the pharmacy. This message replicates the standard RDE message with a different trigger event code to indicate the specific use case of a refill authorization request.
type RRE_O26_Encoding ¶
type RRE_O26_Encoding struct {
HL7 HL7Name `hl7:",name=RRE_O26_Encoding,type=tg"`
RXE *RXE `hl7:"12,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RRE_O26_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"16,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RRE_O26_Order ¶
type RRE_O26_Order struct {
HL7 HL7Name `hl7:",name=RRE_O26_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []RRE_O26_Timing `hl7:",display=Timing"`
Encoding *RRE_O26_Encoding `hl7:",display=Encoding"`
}
Order
type RRE_O26_Patient ¶
type RRE_O26_Patient struct {
HL7 HL7Name `hl7:",name=RRE_O26_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type RRE_O26_Response ¶
type RRE_O26_Response struct {
HL7 HL7Name `hl7:",name=RRE_O26_Response,type=tg"`
Patient *RRE_O26_Patient `hl7:",display=Patient"`
Order []RRE_O26_Order `hl7:",required,display=Order"`
}
Response
type RRE_O26_Timing ¶
type RRE_O26_Timing struct {
HL7 HL7Name `hl7:",name=RRE_O26_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type RRE_O26_TimingEncoded ¶
type RRE_O26_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RRE_O26_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RRG_O16 ¶
type RRG_O16 struct {
HL7 HL7Name `hl7:",name=RRG_O16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Response *RRG_O16_Response `hl7:",display=Response"`
}
Pharmacy/Treatment Give Acknowledgement
The RDS message's RXD segment carries the dispense data for a given issuance of medication: thus it may describe a single dose, a half-day dose, a daily dose, a refill of a prescription, etc. It does not contain the given instructions or scheduling information. When this "give" (i.e., administration) information needs to be transmitted from the pharmacy or treatment application to another application, it is done with the RGV message.
The RGV message uses the RXG segment to record drug or treatment administration instructions. It may carry information about a single scheduled administration on a drug or treatment, or it may carry information about multiple administrations.
type RRG_O16_Give ¶
type RRG_O16_Give struct {
HL7 HL7Name `hl7:",name=RRG_O16_Give,type=tg"`
RXG *RXG `hl7:"12,required,display=Pharmacy/Treatment Give"`
TimingGive []RRG_O16_TimingGive `hl7:",required,display=Timing Give"`
RXR []RXR `hl7:"15,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"16,display=Pharmacy/Treatment Component Order"`
}
Give
type RRG_O16_Order ¶
type RRG_O16_Order struct {
HL7 HL7Name `hl7:",name=RRG_O16_Order,type=tg"`
ORC *ORC `hl7:"9,required,display=Common Order"`
Timing []RRG_O16_Timing `hl7:",display=Timing"`
Give *RRG_O16_Give `hl7:",display=Give"`
}
Order
type RRG_O16_Patient ¶
type RRG_O16_Patient struct {
HL7 HL7Name `hl7:",name=RRG_O16_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NTE []NTE `hl7:"8,display=Notes and Comments"`
}
Patient
type RRG_O16_Response ¶
type RRG_O16_Response struct {
HL7 HL7Name `hl7:",name=RRG_O16_Response,type=tg"`
Patient *RRG_O16_Patient `hl7:",display=Patient"`
Order []RRG_O16_Order `hl7:",required,display=Order"`
}
Response
type RRG_O16_Timing ¶
type RRG_O16_Timing struct {
HL7 HL7Name `hl7:",name=RRG_O16_Timing,type=tg"`
TQ1 *TQ1 `hl7:"10,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"11,display=Timing/Quantity Relationship"`
}
Timing
type RRG_O16_TimingGive ¶
type RRG_O16_TimingGive struct {
HL7 HL7Name `hl7:",name=RRG_O16_TimingGive,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
TimingGive
type RRI_I12 ¶
type RRI_I12 struct {
HL7 HL7Name `hl7:",name=RRI_I12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
AuthorizationContact *RRI_I12_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []RRI_I12_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"10,required,display=Patient Identification"`
ACC *ACC `hl7:"11,display=Accident"`
DG1 []DG1 `hl7:"12,display=Diagnosis"`
DRG []DRG `hl7:"13,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
Procedure []RRI_I12_Procedure `hl7:",display=Procedure"`
Observation []RRI_I12_Observation `hl7:",display=Observation"`
PatientVisit *RRI_I12_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Patient Referral Response
This event triggers a message to be sent from one healthcare provider to another regarding a specific patient. The referral message may contain patient demographic information, specific medical procedures to be performed (accompanied by previously obtained authorizations) and relevant clinical information pertinent to the patient's case.
type RRI_I12_AuthorizationContact ¶
type RRI_I12_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=RRI_I12_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
AuthorizationContact
type RRI_I12_AuthorizationContact2 ¶
type RRI_I12_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=RRI_I12_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"16,required,display=Authorization Information"`
CTD *CTD `hl7:"17,display=Contact Data"`
}
AuthorizationContact
type RRI_I12_Observation ¶
type RRI_I12_Observation struct {
HL7 HL7Name `hl7:",name=RRI_I12_Observation,type=tg"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
ResultsNotes []RRI_I12_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type RRI_I12_PatientVisit ¶
type RRI_I12_PatientVisit struct {
HL7 HL7Name `hl7:",name=RRI_I12_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"22,required,display=Patient Visit"`
PV2 *PV2 `hl7:"23,display=Patient Visit - Additional Information"`
}
PatientVisit
type RRI_I12_Procedure ¶
type RRI_I12_Procedure struct {
HL7 HL7Name `hl7:",name=RRI_I12_Procedure,type=tg"`
PR1 *PR1 `hl7:"15,required,display=Procedures"`
AuthorizationContact *RRI_I12_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type RRI_I12_ProviderContact ¶
type RRI_I12_ProviderContact struct {
HL7 HL7Name `hl7:",name=RRI_I12_ProviderContact,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
ProviderContact
type RRI_I12_ResultsNotes ¶
type RRI_I12_ResultsNotes struct {
HL7 HL7Name `hl7:",name=RRI_I12_ResultsNotes,type=tg"`
OBX *OBX `hl7:"20,required,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
ResultsNotes
type RRI_I13 ¶
type RRI_I13 struct {
HL7 HL7Name `hl7:",name=RRI_I13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
AuthorizationContact *RRI_I13_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []RRI_I13_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"10,required,display=Patient Identification"`
ACC *ACC `hl7:"11,display=Accident"`
DG1 []DG1 `hl7:"12,display=Diagnosis"`
DRG []DRG `hl7:"13,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
Procedure []RRI_I13_Procedure `hl7:",display=Procedure"`
Observation []RRI_I13_Observation `hl7:",display=Observation"`
PatientVisit *RRI_I13_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Modify Patient Referral Response
This event triggers a message to be sent from one healthcare provider to another regarding changes to an existing referral. Changes in a referral may include additional instructions from the referring provider, additional clinical information, and even additional information on patient demographics.
type RRI_I13_AuthorizationContact ¶
type RRI_I13_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=RRI_I13_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
AuthorizationContact
type RRI_I13_AuthorizationContact2 ¶
type RRI_I13_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=RRI_I13_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"16,required,display=Authorization Information"`
CTD *CTD `hl7:"17,display=Contact Data"`
}
AuthorizationContact
type RRI_I13_Observation ¶
type RRI_I13_Observation struct {
HL7 HL7Name `hl7:",name=RRI_I13_Observation,type=tg"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
ResultsNotes []RRI_I13_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type RRI_I13_PatientVisit ¶
type RRI_I13_PatientVisit struct {
HL7 HL7Name `hl7:",name=RRI_I13_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"22,required,display=Patient Visit"`
PV2 *PV2 `hl7:"23,display=Patient Visit - Additional Information"`
}
PatientVisit
type RRI_I13_Procedure ¶
type RRI_I13_Procedure struct {
HL7 HL7Name `hl7:",name=RRI_I13_Procedure,type=tg"`
PR1 *PR1 `hl7:"15,required,display=Procedures"`
AuthorizationContact *RRI_I13_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type RRI_I13_ProviderContact ¶
type RRI_I13_ProviderContact struct {
HL7 HL7Name `hl7:",name=RRI_I13_ProviderContact,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
ProviderContact
type RRI_I13_ResultsNotes ¶
type RRI_I13_ResultsNotes struct {
HL7 HL7Name `hl7:",name=RRI_I13_ResultsNotes,type=tg"`
OBX *OBX `hl7:"20,required,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
ResultsNotes
type RRI_I14 ¶
type RRI_I14 struct {
HL7 HL7Name `hl7:",name=RRI_I14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
AuthorizationContact *RRI_I14_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []RRI_I14_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"10,required,display=Patient Identification"`
ACC *ACC `hl7:"11,display=Accident"`
DG1 []DG1 `hl7:"12,display=Diagnosis"`
DRG []DRG `hl7:"13,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
Procedure []RRI_I14_Procedure `hl7:",display=Procedure"`
Observation []RRI_I14_Observation `hl7:",display=Observation"`
PatientVisit *RRI_I14_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Cancel Patient Referral Response
This event triggers a message to be sent from one healthcare provider to another canceling a referral. A previous referral may have been made in error, or perhaps the cancellation has come from the patient.
type RRI_I14_AuthorizationContact ¶
type RRI_I14_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=RRI_I14_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
AuthorizationContact
type RRI_I14_AuthorizationContact2 ¶
type RRI_I14_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=RRI_I14_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"16,required,display=Authorization Information"`
CTD *CTD `hl7:"17,display=Contact Data"`
}
AuthorizationContact
type RRI_I14_Observation ¶
type RRI_I14_Observation struct {
HL7 HL7Name `hl7:",name=RRI_I14_Observation,type=tg"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
ResultsNotes []RRI_I14_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type RRI_I14_PatientVisit ¶
type RRI_I14_PatientVisit struct {
HL7 HL7Name `hl7:",name=RRI_I14_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"22,required,display=Patient Visit"`
PV2 *PV2 `hl7:"23,display=Patient Visit - Additional Information"`
}
PatientVisit
type RRI_I14_Procedure ¶
type RRI_I14_Procedure struct {
HL7 HL7Name `hl7:",name=RRI_I14_Procedure,type=tg"`
PR1 *PR1 `hl7:"15,required,display=Procedures"`
AuthorizationContact *RRI_I14_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type RRI_I14_ProviderContact ¶
type RRI_I14_ProviderContact struct {
HL7 HL7Name `hl7:",name=RRI_I14_ProviderContact,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
ProviderContact
type RRI_I14_ResultsNotes ¶
type RRI_I14_ResultsNotes struct {
HL7 HL7Name `hl7:",name=RRI_I14_ResultsNotes,type=tg"`
OBX *OBX `hl7:"20,required,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
ResultsNotes
type RRI_I15 ¶
type RRI_I15 struct {
HL7 HL7Name `hl7:",name=RRI_I15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,display=Message Acknowledgment"`
RF1 *RF1 `hl7:"5,display=Referral Information"`
AuthorizationContact *RRI_I15_AuthorizationContact `hl7:",display=Authorization Contact"`
ProviderContact []RRI_I15_ProviderContact `hl7:",required,display=Provider Contact"`
PID *PID `hl7:"10,required,display=Patient Identification"`
ACC *ACC `hl7:"11,display=Accident"`
DG1 []DG1 `hl7:"12,display=Diagnosis"`
DRG []DRG `hl7:"13,display=Diagnosis Related Group"`
AL1 []AL1 `hl7:"14,display=Patient Allergy Information"`
Procedure []RRI_I15_Procedure `hl7:",display=Procedure"`
Observation []RRI_I15_Observation `hl7:",display=Observation"`
PatientVisit *RRI_I15_PatientVisit `hl7:",display=Patient Visit"`
NTE []NTE `hl7:"24,display=Notes and Comments"`
}
Return Request Patient Referral Status
This event triggers a message to be sent between healthcare providers regarding the status of a patient referral request. A previous referral has been made and acknowledged; however, no response has been received to indicate results and/or procedures performed.
type RRI_I15_AuthorizationContact ¶
type RRI_I15_AuthorizationContact struct {
HL7 HL7Name `hl7:",name=RRI_I15_AuthorizationContact,type=tg"`
AUT *AUT `hl7:"6,required,display=Authorization Information"`
CTD *CTD `hl7:"7,display=Contact Data"`
}
AuthorizationContact
type RRI_I15_AuthorizationContact2 ¶
type RRI_I15_AuthorizationContact2 struct {
HL7 HL7Name `hl7:",name=RRI_I15_AuthorizationContact2,type=tg"`
AUT *AUT `hl7:"16,required,display=Authorization Information"`
CTD *CTD `hl7:"17,display=Contact Data"`
}
AuthorizationContact
type RRI_I15_Observation ¶
type RRI_I15_Observation struct {
HL7 HL7Name `hl7:",name=RRI_I15_Observation,type=tg"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
ResultsNotes []RRI_I15_ResultsNotes `hl7:",display=Results Notes"`
}
Observation
type RRI_I15_PatientVisit ¶
type RRI_I15_PatientVisit struct {
HL7 HL7Name `hl7:",name=RRI_I15_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"22,required,display=Patient Visit"`
PV2 *PV2 `hl7:"23,display=Patient Visit - Additional Information"`
}
PatientVisit
type RRI_I15_Procedure ¶
type RRI_I15_Procedure struct {
HL7 HL7Name `hl7:",name=RRI_I15_Procedure,type=tg"`
PR1 *PR1 `hl7:"15,required,display=Procedures"`
AuthorizationContact *RRI_I15_AuthorizationContact2 `hl7:",display=Authorization Contact"`
}
Procedure
type RRI_I15_ProviderContact ¶
type RRI_I15_ProviderContact struct {
HL7 HL7Name `hl7:",name=RRI_I15_ProviderContact,type=tg"`
PRD *PRD `hl7:"8,required,display=Provider Data"`
CTD []CTD `hl7:"9,display=Contact Data"`
}
ProviderContact
type RRI_I15_ResultsNotes ¶
type RRI_I15_ResultsNotes struct {
HL7 HL7Name `hl7:",name=RRI_I15_ResultsNotes,type=tg"`
OBX *OBX `hl7:"20,required,display=Observation/Result"`
NTE []NTE `hl7:"21,display=Notes and Comments"`
}
ResultsNotes
type RSP_E03 ¶
type RSP_E03 struct {
HL7 HL7Name `hl7:",name=RSP_E03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QueryAck *RSP_E03_QueryAck `hl7:",required,display=Query Ack"`
}
HealthCare Services Invoice Status Query Response
This message is used to respond to a QPB_E03 – Query HealthCare Services Invoice. It provides Invoice and invoice processing information to a Provider.
type RSP_E03_InvoiceProcessingResultsInfo ¶
type RSP_E03_InvoiceProcessingResultsInfo struct {
HL7 HL7Name `hl7:",name=RSP_E03_InvoiceProcessingResultsInfo,type=tg"`
IPR *IPR `hl7:"8,required,display=Invoice Processing Results"`
}
InvoiceProcessingResultsInfo
type RSP_E03_QueryAck ¶
type RSP_E03_QueryAck struct {
HL7 HL7Name `hl7:",name=RSP_E03_QueryAck,type=tg"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
InvoiceProcessingResultsInfo []RSP_E03_InvoiceProcessingResultsInfo `hl7:",display=Invoice Processing Results Info"`
}
QueryAck
type RSP_E22 ¶
type RSP_E22 struct {
HL7 HL7Name `hl7:",name=RSP_E22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC []UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QueryAck *RSP_E22_QueryAck `hl7:",required,display=Query Ack"`
}
Authorization Request StatusResponse
This message is used to respond to a QPB_E22 – Query Authorization Request Status. It provides Authorization status information to a Provider.
type RSP_E22_AuthorizationInfo ¶
type RSP_E22_AuthorizationInfo struct {
HL7 HL7Name `hl7:",name=RSP_E22_AuthorizationInfo,type=tg"`
IVC *IVC `hl7:"8,required,display=Invoice"`
PSG *PSG `hl7:"9,required,display=Product/Service Group"`
PslItemInfo []RSP_E22_PslItemInfo `hl7:",required,display=Psl Item Info"`
}
AuthorizationInfo
type RSP_E22_PslItemInfo ¶
type RSP_E22_PslItemInfo struct {
HL7 HL7Name `hl7:",name=RSP_E22_PslItemInfo,type=tg"`
PSL *PSL `hl7:"10,required,display=Product/Service Line Item"`
}
PslItemInfo
type RSP_E22_QueryAck ¶
type RSP_E22_QueryAck struct {
HL7 HL7Name `hl7:",name=RSP_E22_QueryAck,type=tg"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
AuthorizationInfo *RSP_E22_AuthorizationInfo `hl7:",display=Authorization Info"`
}
QueryAck
type RSP_K11 ¶
type RSP_K11 struct {
HL7 HL7Name `hl7:",name=RSP_K11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
DSC *DSC `hl7:"8,display=Continuation Pointer"`
}
Segment Pattern Response in Response to QBP_Q11
The RSP_K11 supports a Segment Pattern Response to the QBP and contains the MSH, MSA, ERR, QAK, QPD, variable content segments, and the DSC. Its default trigger event is K11. A standard or site-defined response may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined response, that value must begin with Z.
type RSP_K21 ¶
type RSP_K21 struct {
HL7 HL7Name `hl7:",name=RSP_K21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
QueryResponse *RSP_K21_QueryResponse `hl7:",display=Query Response"`
DSC *DSC `hl7:"13,display=Continuation Pointer"`
}
Get Person Demographics Response
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of an identifier for a person, and the response of the demographics for that person.
type RSP_K21_QueryResponse ¶
type RSP_K21_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_K21_QueryResponse,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PD1 *PD1 `hl7:"9,display=Patient Additional Demographic"`
ARV []ARV `hl7:"10,display=Access Restrictions"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
QRI *QRI `hl7:"12,required,display=Query Response Instance"`
}
QueryResponse
type RSP_K22 ¶
type RSP_K22 struct {
HL7 HL7Name `hl7:",name=RSP_K22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
QueryResponse []RSP_K22_QueryResponse `hl7:",display=Query Response"`
DSC *DSC `hl7:"12,display=Continuation Pointer"`
}
Find Candidates Response
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of a set of demographics for a person, and the response is the list of candidates considered by the MPI to match that set.
Each returned person, specified by a PID segment, can also have an optional QRI - Query Response Instance segment containing information about the quality of the match.
type RSP_K22_QueryResponse ¶
type RSP_K22_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_K22_QueryResponse,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PD1 *PD1 `hl7:"9,display=Patient Additional Demographic"`
NK1 []NK1 `hl7:"10,display=Next of Kin / Associated Parties"`
QRI *QRI `hl7:"11,display=Query Response Instance"`
}
QueryResponse
type RSP_K23 ¶
type RSP_K23 struct {
HL7 HL7Name `hl7:",name=RSP_K23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
QueryResponse *RSP_K23_QueryResponse `hl7:",display=Query Response"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Get Corresponding Identifiers Response
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of an identifier for a person, and the response is a list of identifiers for that person from the domains specified.
type RSP_K23_QueryResponse ¶
type RSP_K23_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_K23_QueryResponse,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
}
QueryResponse
type RSP_K24 ¶
type RSP_K24 struct {
HL7 HL7Name `hl7:",name=RSP_K24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
QueryResponse *RSP_K24_QueryResponse `hl7:",display=Query Response"`
DSC *DSC `hl7:"9,display=Continuation Pointer"`
}
Allocate Identifiers Response
This query/response is designed for interaction between a client system and an MPI (Master Person Index). The query consists of domains in which identifiers should be allocated. The response is new identifiers in those domains.
This event is not meant to cause the creation of a new person record, or to bind identifiers to a particular person record. The events A28 - Add person information and A24 - Link patient information should be used for that purpose. This event is meant to simply reserve the use of identifiers.
type RSP_K24_QueryResponse ¶
type RSP_K24_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_K24_QueryResponse,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
}
QueryResponse
type RSP_K25 ¶
type RSP_K25 struct {
HL7 HL7Name `hl7:",name=RSP_K25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"8,required,display=Response Control Parameter"`
Staff []RSP_K25_Staff `hl7:",required,display=Staff"`
DSC *DSC `hl7:"16,display=Continuation Pointer"`
}
Personnel Information by Segment Response
The purpose of this query/response pair is to retrieve all available personnel information based upon the values of one or more commonly used search parameter.
type RSP_K25_Staff ¶
type RSP_K25_Staff struct {
HL7 HL7Name `hl7:",name=RSP_K25_Staff,type=tg"`
STF *STF `hl7:"9,required,display=Staff Identification"`
PRA []PRA `hl7:"10,display=Practitioner Detail"`
ORG []ORG `hl7:"11,display=Practitioner Organization Unit"`
AFF []AFF `hl7:"12,display=Professional Affiliation"`
LAN []LAN `hl7:"13,display=Language Detail"`
EDU []EDU `hl7:"14,display=Educational Detail"`
CER []CER `hl7:"15,display=Certificate Detail"`
}
Staff
type RSP_K31 ¶
type RSP_K31 struct {
HL7 HL7Name `hl7:",name=RSP_K31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"8,required,display=Response Control Parameter"`
Response []RSP_K31_Response `hl7:",required,display=Response"`
DSC *DSC `hl7:"33,display=Continuation Pointer"`
}
Pharmacy Response - Dispense History
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type RSP_K31_Components ¶
type RSP_K31_Components struct {
HL7 HL7Name `hl7:",name=RSP_K31_Components,type=tg"`
RXC *RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Components
type RSP_K31_Encoding ¶
type RSP_K31_Encoding struct {
HL7 HL7Name `hl7:",name=RSP_K31_Encoding,type=tg"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RSP_K31_TimingEncoded `hl7:",required,display=Timing Encoded"`
RXR []RXR `hl7:"26,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"27,display=Pharmacy/Treatment Component Order"`
}
Encoding
type RSP_K31_Observation ¶
type RSP_K31_Observation struct {
HL7 HL7Name `hl7:",name=RSP_K31_Observation,type=tg"`
OBX *OBX `hl7:"31,display=Observation/Result"`
NTE []NTE `hl7:"32,display=Notes and Comments"`
}
Observation
type RSP_K31_Order ¶
type RSP_K31_Order struct {
HL7 HL7Name `hl7:",name=RSP_K31_Order,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RSP_K31_Timing `hl7:",display=Timing"`
OrderDetail *RSP_K31_OrderDetail `hl7:",display=Order Detail"`
Encoding *RSP_K31_Encoding `hl7:",display=Encoding"`
RXD *RXD `hl7:"28,required,display=Pharmacy/Treatment Dispense"`
RXR []RXR `hl7:"29,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"30,display=Pharmacy/Treatment Component Order"`
Observation []RSP_K31_Observation `hl7:",required,display=Observation"`
}
Order
type RSP_K31_OrderDetail ¶
type RSP_K31_OrderDetail struct {
HL7 HL7Name `hl7:",name=RSP_K31_OrderDetail,type=tg"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Components []RSP_K31_Components `hl7:",display=Components"`
}
OrderDetail
type RSP_K31_Patient ¶
type RSP_K31_Patient struct {
HL7 HL7Name `hl7:",name=RSP_K31_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
PD1 *PD1 `hl7:"10,display=Patient Additional Demographic"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
AL1 []AL1 `hl7:"12,display=Patient Allergy Information"`
PatientVisit *RSP_K31_PatientVisit `hl7:",display=Patient Visit"`
}
Patient
type RSP_K31_PatientVisit ¶
type RSP_K31_PatientVisit struct {
HL7 HL7Name `hl7:",name=RSP_K31_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"13,required,display=Patient Visit"`
PV2 *PV2 `hl7:"14,display=Patient Visit - Additional Information"`
}
PatientVisit
type RSP_K31_Response ¶
type RSP_K31_Response struct {
HL7 HL7Name `hl7:",name=RSP_K31_Response,type=tg"`
Patient *RSP_K31_Patient `hl7:",display=Patient"`
Order []RSP_K31_Order `hl7:",required,display=Order"`
}
Response
type RSP_K31_Timing ¶
type RSP_K31_Timing struct {
HL7 HL7Name `hl7:",name=RSP_K31_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RSP_K31_TimingEncoded ¶
type RSP_K31_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RSP_K31_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RSP_Z82 ¶
type RSP_Z82 struct {
HL7 HL7Name `hl7:",name=RSP_Z82,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"8,required,display=Response Control Parameter"`
QueryResponse []RSP_Z82_QueryResponse `hl7:",required,display=Query Response"`
DSC *DSC `hl7:"33,display=Continuation Pointer"`
}
Dispense History Response
The purpose of this query/response is to retrieve patient pharmacy dispense history information from the Server.
type RSP_Z82_CommonOrder ¶
type RSP_Z82_CommonOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z82_CommonOrder,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RSP_Z82_Timing `hl7:",display=Timing"`
OrderDetail *RSP_Z82_OrderDetail `hl7:",display=Order Detail"`
EncodedOrder *RSP_Z82_EncodedOrder `hl7:",display=Encoded Order"`
RXD *RXD `hl7:"28,required,display=Pharmacy/Treatment Dispense"`
RXR []RXR `hl7:"29,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"30,display=Pharmacy/Treatment Component Order"`
Observation []RSP_Z82_Observation `hl7:",required,display=Observation"`
}
CommonOrder
type RSP_Z82_EncodedOrder ¶
type RSP_Z82_EncodedOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z82_EncodedOrder,type=tg"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RSP_Z82_TimingEncoded `hl7:",display=Timing Encoded"`
RXR []RXR `hl7:"26,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"27,display=Pharmacy/Treatment Component Order"`
}
EncodedOrder
type RSP_Z82_Observation ¶
type RSP_Z82_Observation struct {
HL7 HL7Name `hl7:",name=RSP_Z82_Observation,type=tg"`
OBX *OBX `hl7:"31,display=Observation/Result"`
NTE []NTE `hl7:"32,display=Notes and Comments"`
}
Observation
type RSP_Z82_OrderDetail ¶
type RSP_Z82_OrderDetail struct {
HL7 HL7Name `hl7:",name=RSP_Z82_OrderDetail,type=tg"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Treatment *RSP_Z82_Treatment `hl7:",display=Treatment"`
}
OrderDetail
type RSP_Z82_Patient ¶
type RSP_Z82_Patient struct {
HL7 HL7Name `hl7:",name=RSP_Z82_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
PD1 *PD1 `hl7:"10,display=Patient Additional Demographic"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
Visit *RSP_Z82_Visit `hl7:",display=Visit"`
}
Patient
type RSP_Z82_QueryResponse ¶
type RSP_Z82_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_Z82_QueryResponse,type=tg"`
Patient *RSP_Z82_Patient `hl7:",display=Patient"`
CommonOrder []RSP_Z82_CommonOrder `hl7:",required,display=Common Order"`
}
QueryResponse
type RSP_Z82_Timing ¶
type RSP_Z82_Timing struct {
HL7 HL7Name `hl7:",name=RSP_Z82_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RSP_Z82_TimingEncoded ¶
type RSP_Z82_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RSP_Z82_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RSP_Z82_Treatment ¶
type RSP_Z82_Treatment struct {
HL7 HL7Name `hl7:",name=RSP_Z82_Treatment,type=tg"`
RXC []RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Treatment
type RSP_Z82_Visit ¶
type RSP_Z82_Visit struct {
HL7 HL7Name `hl7:",name=RSP_Z82_Visit,type=tg"`
AL1 []AL1 `hl7:"12,required,display=Patient Allergy Information"`
PV1 *PV1 `hl7:"13,required,display=Patient Visit"`
PV2 *PV2 `hl7:"14,display=Patient Visit - Additional Information"`
}
Visit
type RSP_Z84 ¶
type RSP_Z84 struct {
HL7 HL7Name `hl7:",name=RSP_Z84,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RSP_Z84_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Who Am I Response
The purpose of this query/response pair is to find the identity of the patient for specified medical record number(s).
type RSP_Z84_RowDefinition ¶
type RSP_Z84_RowDefinition struct {
HL7 HL7Name `hl7:",name=RSP_Z84_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RSP_Z86 ¶
type RSP_Z86 struct {
HL7 HL7Name `hl7:",name=RSP_Z86,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
QueryResponse []RSP_Z86_QueryResponse `hl7:",required,display=Query Response"`
DSC *DSC `hl7:"34,display=Continuation Pointer"`
}
Pharmacy Information Comprehensive Response
The purpose of this query/response is to retrieve patient pharmacy history information from the Server.
type RSP_Z86_Administration ¶
type RSP_Z86_Administration struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Administration,type=tg"`
RXA *RXA `hl7:"29,required,display=Pharmacy/Treatment Administration"`
RXR []RXR `hl7:"30,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"31,display=Pharmacy/Treatment Component Order"`
}
Administration
type RSP_Z86_CommonOrder ¶
type RSP_Z86_CommonOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z86_CommonOrder,type=tg"`
ORC *ORC `hl7:"12,required,display=Common Order"`
Timing []RSP_Z86_Timing `hl7:",display=Timing"`
OrderDetail *RSP_Z86_OrderDetail `hl7:",display=Order Detail"`
EncodedOrder *RSP_Z86_EncodedOrder `hl7:",display=Encoded Order"`
Dispense *RSP_Z86_Dispense `hl7:",display=Dispense"`
Give *RSP_Z86_Give `hl7:",display=Give"`
Administration *RSP_Z86_Administration `hl7:",display=Administration"`
Observation []RSP_Z86_Observation `hl7:",required,display=Observation"`
}
CommonOrder
type RSP_Z86_Dispense ¶
type RSP_Z86_Dispense struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Dispense,type=tg"`
RXD *RXD `hl7:"23,required,display=Pharmacy/Treatment Dispense"`
RXR []RXR `hl7:"24,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"25,display=Pharmacy/Treatment Component Order"`
}
Dispense
type RSP_Z86_EncodedOrder ¶
type RSP_Z86_EncodedOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z86_EncodedOrder,type=tg"`
RXE *RXE `hl7:"18,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RSP_Z86_TimingEncoded `hl7:",display=Timing Encoded"`
RXR []RXR `hl7:"21,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"22,display=Pharmacy/Treatment Component Order"`
}
EncodedOrder
type RSP_Z86_Give ¶
type RSP_Z86_Give struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Give,type=tg"`
RXG *RXG `hl7:"26,required,display=Pharmacy/Treatment Give"`
RXR []RXR `hl7:"27,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"28,display=Pharmacy/Treatment Component Order"`
}
Give
type RSP_Z86_Observation ¶
type RSP_Z86_Observation struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Observation,type=tg"`
OBX *OBX `hl7:"32,display=Observation/Result"`
NTE []NTE `hl7:"33,display=Notes and Comments"`
}
Observation
type RSP_Z86_OrderDetail ¶
type RSP_Z86_OrderDetail struct {
HL7 HL7Name `hl7:",name=RSP_Z86_OrderDetail,type=tg"`
RXO *RXO `hl7:"15,required,display=Pharmacy/Treatment Order"`
RXR []RXR `hl7:"16,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"17,display=Pharmacy/Treatment Component Order"`
}
OrderDetail
type RSP_Z86_Patient ¶
type RSP_Z86_Patient struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PD1 *PD1 `hl7:"9,display=Patient Additional Demographic"`
NTE []NTE `hl7:"10,display=Notes and Comments"`
AL1 []AL1 `hl7:"11,display=Patient Allergy Information"`
}
Patient
type RSP_Z86_QueryResponse ¶
type RSP_Z86_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_Z86_QueryResponse,type=tg"`
Patient *RSP_Z86_Patient `hl7:",display=Patient"`
CommonOrder []RSP_Z86_CommonOrder `hl7:",required,display=Common Order"`
}
QueryResponse
type RSP_Z86_Timing ¶
type RSP_Z86_Timing struct {
HL7 HL7Name `hl7:",name=RSP_Z86_Timing,type=tg"`
TQ1 *TQ1 `hl7:"13,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"14,display=Timing/Quantity Relationship"`
}
Timing
type RSP_Z86_TimingEncoded ¶
type RSP_Z86_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RSP_Z86_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"19,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"20,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RSP_Z88 ¶
type RSP_Z88 struct {
HL7 HL7Name `hl7:",name=RSP_Z88,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"8,required,display=Response Control Parameter"`
QueryResponse []RSP_Z88_QueryResponse `hl7:",required,display=Query Response"`
DSC *DSC `hl7:"33,required,display=Continuation Pointer"`
}
Dispense Information Response
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type RSP_Z88_Allergy ¶
type RSP_Z88_Allergy struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Allergy,type=tg"`
AL1 []AL1 `hl7:"12,required,display=Patient Allergy Information"`
Visit *RSP_Z88_Visit `hl7:",display=Visit"`
}
Allergy
type RSP_Z88_CommonOrder ¶
type RSP_Z88_CommonOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z88_CommonOrder,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RSP_Z88_Timing `hl7:",display=Timing"`
OrderDetail *RSP_Z88_OrderDetail `hl7:",display=Order Detail"`
OrderEncoded *RSP_Z88_OrderEncoded `hl7:",display=Order Encoded"`
RXD *RXD `hl7:"28,required,display=Pharmacy/Treatment Dispense"`
RXR []RXR `hl7:"29,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"30,display=Pharmacy/Treatment Component Order"`
Observation []RSP_Z88_Observation `hl7:",required,display=Observation"`
}
CommonOrder
type RSP_Z88_Component ¶
type RSP_Z88_Component struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Component,type=tg"`
RXC []RXC `hl7:"21,required,display=Pharmacy/Treatment Component Order"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Component
type RSP_Z88_Observation ¶
type RSP_Z88_Observation struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Observation,type=tg"`
OBX *OBX `hl7:"31,display=Observation/Result"`
NTE []NTE `hl7:"32,display=Notes and Comments"`
}
Observation
type RSP_Z88_OrderDetail ¶
type RSP_Z88_OrderDetail struct {
HL7 HL7Name `hl7:",name=RSP_Z88_OrderDetail,type=tg"`
RXO *RXO `hl7:"18,required,display=Pharmacy/Treatment Order"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
RXR []RXR `hl7:"20,required,display=Pharmacy/Treatment Route"`
Component *RSP_Z88_Component `hl7:",display=Component"`
}
OrderDetail
type RSP_Z88_OrderEncoded ¶
type RSP_Z88_OrderEncoded struct {
HL7 HL7Name `hl7:",name=RSP_Z88_OrderEncoded,type=tg"`
RXE *RXE `hl7:"23,required,display=Pharmacy/Treatment Encoded Order"`
TimingEncoded []RSP_Z88_TimingEncoded `hl7:",display=Timing Encoded"`
RXR []RXR `hl7:"26,required,display=Pharmacy/Treatment Route"`
RXC []RXC `hl7:"27,display=Pharmacy/Treatment Component Order"`
}
OrderEncoded
type RSP_Z88_Patient ¶
type RSP_Z88_Patient struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
PD1 *PD1 `hl7:"10,display=Patient Additional Demographic"`
NTE []NTE `hl7:"11,display=Notes and Comments"`
Allergy *RSP_Z88_Allergy `hl7:",display=Allergy"`
}
Patient
type RSP_Z88_QueryResponse ¶
type RSP_Z88_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_Z88_QueryResponse,type=tg"`
Patient *RSP_Z88_Patient `hl7:",display=Patient"`
CommonOrder []RSP_Z88_CommonOrder `hl7:",required,display=Common Order"`
}
QueryResponse
type RSP_Z88_Timing ¶
type RSP_Z88_Timing struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RSP_Z88_TimingEncoded ¶
type RSP_Z88_TimingEncoded struct {
HL7 HL7Name `hl7:",name=RSP_Z88_TimingEncoded,type=tg"`
TQ1 *TQ1 `hl7:"24,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"25,display=Timing/Quantity Relationship"`
}
TimingEncoded
type RSP_Z88_Visit ¶
type RSP_Z88_Visit struct {
HL7 HL7Name `hl7:",name=RSP_Z88_Visit,type=tg"`
PV1 *PV1 `hl7:"13,required,display=Patient Visit"`
PV2 *PV2 `hl7:"14,display=Patient Visit - Additional Information"`
}
Visit
type RSP_Z90 ¶
type RSP_Z90 struct {
HL7 HL7Name `hl7:",name=RSP_Z90,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RCP *RCP `hl7:"8,required,display=Response Control Parameter"`
QueryResponse []RSP_Z90_QueryResponse `hl7:",required,display=Query Response"`
DSC *DSC `hl7:"25,required,display=Continuation Pointer"`
}
Lab Results History Response
The purpose of this query/response pair is to retrieve patient laboratory results information from the Server.
type RSP_Z90_CommonOrder ¶
type RSP_Z90_CommonOrder struct {
HL7 HL7Name `hl7:",name=RSP_Z90_CommonOrder,type=tg"`
ORC *ORC `hl7:"15,required,display=Common Order"`
Timing []RSP_Z90_Timing `hl7:",display=Timing"`
OBR *OBR `hl7:"18,required,display=Observation Request"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
CTD *CTD `hl7:"20,display=Contact Data"`
Observation []RSP_Z90_Observation `hl7:",required,display=Observation"`
}
CommonOrder
type RSP_Z90_Observation ¶
type RSP_Z90_Observation struct {
HL7 HL7Name `hl7:",name=RSP_Z90_Observation,type=tg"`
OBX *OBX `hl7:"21,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Observation
type RSP_Z90_Patient ¶
type RSP_Z90_Patient struct {
HL7 HL7Name `hl7:",name=RSP_Z90_Patient,type=tg"`
PID *PID `hl7:"9,required,display=Patient Identification"`
PD1 *PD1 `hl7:"10,display=Patient Additional Demographic"`
NK1 []NK1 `hl7:"11,display=Next of Kin / Associated Parties"`
NTE []NTE `hl7:"12,display=Notes and Comments"`
Visit *RSP_Z90_Visit `hl7:",display=Visit"`
}
Patient
type RSP_Z90_QueryResponse ¶
type RSP_Z90_QueryResponse struct {
HL7 HL7Name `hl7:",name=RSP_Z90_QueryResponse,type=tg"`
Patient *RSP_Z90_Patient `hl7:",display=Patient"`
CommonOrder []RSP_Z90_CommonOrder `hl7:",required,display=Common Order"`
Specimen []RSP_Z90_Specimen `hl7:",display=Specimen"`
}
QueryResponse
type RSP_Z90_Specimen ¶
type RSP_Z90_Specimen struct {
HL7 HL7Name `hl7:",name=RSP_Z90_Specimen,type=tg"`
SPM *SPM `hl7:"23,required,display=Specimen"`
OBX []OBX `hl7:"24,display=Observation/Result"`
}
Specimen
type RSP_Z90_Timing ¶
type RSP_Z90_Timing struct {
HL7 HL7Name `hl7:",name=RSP_Z90_Timing,type=tg"`
TQ1 *TQ1 `hl7:"16,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"17,display=Timing/Quantity Relationship"`
}
Timing
type RSP_Z90_Visit ¶
type RSP_Z90_Visit struct {
HL7 HL7Name `hl7:",name=RSP_Z90_Visit,type=tg"`
PV1 *PV1 `hl7:"13,required,display=Patient Visit"`
PV2 *PV2 `hl7:"14,display=Patient Visit - Additional Information"`
}
Visit
type RTB_K13 ¶
type RTB_K13 struct {
HL7 HL7Name `hl7:",name=RTB_K13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_K13_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Tabular Response in Response to QBP_Q13
The RTB_K13 supports a Tabular Response to the QBP and contains the MSH, MSA, ERR, QAK, QPD, RDF, RDT and the DSC. Its default trigger event is K13. A standard or site-defined response may use this trigger event or may specify a unique trigger event value in its Query Profile. If a unique trigger event value is chosen for a site-defined response, that value must begin with Z.
The RTB_K13 structure requires that, if any RDT segments are returned, they be preceded by an RDF segment containing the row definition specification for the RDT segments. If no RDF was sent in the query, the default RDF is returned in the RTB_K13.
type RTB_K13_RowDefinition ¶
type RTB_K13_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_K13_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RTB_Z74 ¶
type RTB_Z74 struct {
HL7 HL7Name `hl7:",name=RTB_Z74,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
SFT []SFT `hl7:"4,display=Software Segment"`
UAC *UAC `hl7:"5,display=User Authentication Credential"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_Z74_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Tabular response - Information about Phone Calls
Returns response sorted by Phone Number
type RTB_Z74_RowDefinition ¶
type RTB_Z74_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_Z74_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RTB_Z76 ¶
type RTB_Z76 struct {
HL7 HL7Name `hl7:",name=RTB_Z76,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_Z76_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Tabular response - Tabular Patient List
The purpose of this message/response is to find patient records that closely (as specified by the Client) match a set of input criteria using a specified algorithm.
Response returns requested columns from the Virtual Table. If no columns were requested, all columns are returned.
type RTB_Z76_RowDefinition ¶
type RTB_Z76_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_Z76_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RTB_Z92 ¶
type RTB_Z92 struct {
HL7 HL7Name `hl7:",name=RTB_Z92,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_Z92_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Who Am I Response
The purpose of this query/response pair is to find the identity of the patient for specified medical record number(s)
type RTB_Z92_RowDefinition ¶
type RTB_Z92_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_Z92_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RTB_Z94 ¶
type RTB_Z94 struct {
HL7 HL7Name `hl7:",name=RTB_Z94,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_Z94_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Tabular Dispense History Response
The purpose of this query/response pair is to find medications dispensed between specified date range for specified medical record numbers.
type RTB_Z94_RowDefinition ¶
type RTB_Z94_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_Z94_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RTB_Z96 ¶
type RTB_Z96 struct {
HL7 HL7Name `hl7:",name=RTB_Z96,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
MSA *MSA `hl7:"4,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"5,display=Error"`
QAK *QAK `hl7:"6,required,display=Query Acknowledgment"`
QPD *QPD `hl7:"7,required,display=Query Parameter Definition"`
RowDefinition *RTB_Z96_RowDefinition `hl7:",display=Row Definition"`
DSC *DSC `hl7:"10,display=Continuation Pointer"`
}
Tabular Dispense History Response
The purpose of this query/response pair is to retrieve patient pharmacy dispense history information from the Server.
type RTB_Z96_RowDefinition ¶
type RTB_Z96_RowDefinition struct {
HL7 HL7Name `hl7:",name=RTB_Z96_RowDefinition,type=tg"`
RDF *RDF `hl7:"8,required,display=Table Row Definition"`
RDT []RDT `hl7:"9,display=Table Row Data"`
}
RowDefinition
type RXA ¶
type RXA struct {
HL7 HL7Name `hl7:",name=RXA,type=s"`
GiveSubIDCounter NM `hl7:"1,required,len=4,display=Give Sub-ID Counter"`
AdministrationSubIDCounter NM `hl7:"2,required,len=4,display=Administration Sub-ID Counter"`
DateTimeStartOfAdministration DTM `hl7:"3,required,len=24,format=YMDHM,display=Date/Time Start of Administration"`
DateTimeEndOfAdministration DTM `hl7:"4,required,len=24,format=YMDHM,display=Date/Time End of Administration"`
AdministeredCode CWE `hl7:"5,required,len=250,table=0292,display=Administered Code"`
AdministeredAmount NM `hl7:"6,required,len=20,display=Administered Amount"`
AdministeredUnits *CWE `hl7:"7,conditional,len=250,display=Administered Units"`
AdministeredDosageForm *CWE `hl7:"8,len=250,display=Administered Dosage Form"`
AdministrationNotes []CWE `hl7:"9,len=250,display=Administration Notes"`
AdministeringProvider []XCN `hl7:"10,len=250,display=Administering Provider"`
AdministeredAtLocation LA2 `hl7:"11,len=200,display=Administered-at Location"`
AdministeredPerTimeUnit ST `hl7:"12,conditional,len=20,display=Administered Per (Time Unit)"`
AdministeredStrength NM `hl7:"13,len=20,display=Administered Strength"`
AdministeredStrengthUnits *CWE `hl7:"14,len=250,display=Administered Strength Units"`
SubstanceLotNumber []ST `hl7:"15,len=20,display=Substance Lot Number"`
SubstanceExpirationDate []DTM `hl7:"16,len=24,format=YMDHM,display=Substance Expiration Date"`
SubstanceManufacturerName []CWE `hl7:"17,len=250,table=0227,display=Substance Manufacturer Name"`
SubstanceTreatmentRefusalReason []CWE `hl7:"18,len=250,display=Substance/Treatment Refusal Reason"`
Indication []CWE `hl7:"19,len=250,display=Indication"`
CompletionStatus ID `hl7:"20,len=2,table=0322,display=Completion Status"`
ActionCode ID `hl7:"21,len=2,table=0206,display=Action Code - RXA"`
SystemEntryDateTime DTM `hl7:"22,len=24,format=YMDHM,display=System Entry Date/Time"`
AdministeredDrugStrengthVolume NM `hl7:"23,len=5,display=Administered Drug Strength Volume"`
AdministeredDrugStrengthVolumeUnits *CWE `hl7:"24,len=250,display=Administered Drug Strength Volume Units"`
AdministeredBarcodeIdentifier *CWE `hl7:"25,len=60,display=Administered Barcode Identifier"`
PharmacyOrderType ID `hl7:"26,len=1,table=0480,display=Pharmacy Order Type"`
AdministerAt *PL `hl7:"27,len=180,display=Administer-at"`
AdministeredAtAddress *XAD `hl7:"28,len=106,display=Administered-at Address"`
}
Pharmacy/Treatment Administration
The ORC must have the filler order number and the order control code RE. As a site-specific variant, the RXO and associated RXCs and/or the RXE (and associated RXCs) may be present if the receiving application needs any of their data. The RXA carries the administration data.
type RXC ¶
type RXC struct {
HL7 HL7Name `hl7:",name=RXC,type=s"`
RXComponentType ID `hl7:"1,required,len=1,table=0166,display=RX Component Type"`
ComponentCode CWE `hl7:"2,required,len=250,display=Component Code"`
ComponentAmount NM `hl7:"3,required,len=20,display=Component Amount"`
ComponentUnits CWE `hl7:"4,required,len=250,display=Component Units"`
ComponentStrength NM `hl7:"5,len=20,display=Component Strength"`
ComponentStrengthUnits *CWE `hl7:"6,len=250,display=Component Strength Units"`
SupplementaryCode []CWE `hl7:"7,len=250,display=Supplementary Code"`
ComponentDrugStrengthVolume NM `hl7:"8,len=5,display=Component Drug Strength Volume"`
ComponentDrugStrengthVolumeUnits *CWE `hl7:"9,len=250,display=Component Drug Strength Volume Units"`
}
Pharmacy/Treatment Component Order
If the drug or treatment ordered with the RXO segment is a compound drug OR an IV solution, AND there is not a coded value for OBR-4-universal service ID , which specifies the components (base and all additives), then the components (the base and additives) are specified by two or more RXC segments. The policy of the pharmacy or treatment application on substitutions at the RXC level is identical to that for the RXO level.
type RXD ¶
type RXD struct {
HL7 HL7Name `hl7:",name=RXD,type=s"`
DispenseSubIDCounter NM `hl7:"1,required,len=4,display=Dispense Sub-ID Counter"`
DispenseGiveCode CWE `hl7:"2,required,len=250,table=0292,display=Dispense/Give Code"`
DateTimeDispensed DTM `hl7:"3,required,len=24,format=YMDHM,display=Date/Time Dispensed"`
ActualDispenseAmount NM `hl7:"4,required,len=20,display=Actual Dispense Amount"`
ActualDispenseUnits *CWE `hl7:"5,conditional,len=250,display=Actual Dispense Units"`
ActualDosageForm *CWE `hl7:"6,len=250,display=Actual Dosage Form"`
PrescriptionNumber ST `hl7:"7,required,len=20,display=Prescription Number"`
NumberOfRefillsRemaining NM `hl7:"8,conditional,len=20,display=Number of Refills Remaining"`
DispenseNotes []ST `hl7:"9,len=200,display=Dispense Notes"`
DispensingProvider []XCN `hl7:"10,len=200,display=Dispensing Provider"`
SubstitutionStatus ID `hl7:"11,len=1,table=0167,display=Substitution Status"`
TotalDailyDose *CQ `hl7:"12,len=10,display=Total Daily Dose"`
DispenseToLocation LA2 `hl7:"13,len=200,display=Dispense-to Location"`
NeedsHumanReview ID `hl7:"14,len=1,table=0136,display=Needs Human Review"`
PharmacyTreatmentSuppliersSpecialDispensingInstructions []CWE `hl7:"15,len=250,display=Pharmacy/Treatment Supplier's Special Dispensing Instructions"`
ActualStrength NM `hl7:"16,len=20,display=Actual Strength"`
ActualStrengthUnit *CWE `hl7:"17,len=250,display=Actual Strength Unit"`
SubstanceLotNumber []ST `hl7:"18,len=20,display=Substance Lot Number"`
SubstanceExpirationDate []DTM `hl7:"19,len=24,format=YMDHM,display=Substance Expiration Date"`
SubstanceManufacturerName []CWE `hl7:"20,len=250,table=0227,display=Substance Manufacturer Name"`
Indication []CWE `hl7:"21,len=250,display=Indication"`
DispensePackageSize NM `hl7:"22,len=20,display=Dispense Package Size"`
DispensePackageSizeUnit *CWE `hl7:"23,len=250,display=Dispense Package Size Unit"`
DispensePackageMethod ID `hl7:"24,len=2,table=0321,display=Dispense Package Method"`
SupplementaryCode []CWE `hl7:"25,len=250,display=Supplementary Code"`
InitiatingLocation *CWE `hl7:"26,len=250,display=Initiating Location"`
PackagingAssemblyLocation *CWE `hl7:"27,len=250,display=Packaging/Assembly Location"`
ActualDrugStrengthVolume NM `hl7:"28,len=5,display=Actual Drug Strength Volume"`
ActualDrugStrengthVolumeUnits *CWE `hl7:"29,len=250,display=Actual Drug Strength Volume Units"`
DispenseToPharmacy *CWE `hl7:"30,len=180,display=Dispense to Pharmacy"`
DispenseToPharmacyAddress *XAD `hl7:"31,len=106,display=Dispense to Pharmacy Address"`
PharmacyOrderType ID `hl7:"32,len=1,table=0480,display=Pharmacy Order Type"`
DispenseType *CWE `hl7:"33,len=250,table=0484,display=Dispense Type"`
}
Pharmacy/Treatment Dispense
type RXE ¶
type RXE struct {
HL7 HL7Name `hl7:",name=RXE,type=s"`
QuantityTiming TQ `hl7:"1,len=705,display=Quantity/Timing"`
GiveCode CWE `hl7:"2,required,len=250,display=Give Code"`
GiveAmountMinimum NM `hl7:"3,required,len=20,display=Give Amount - Minimum"`
GiveAmountMaximum NM `hl7:"4,len=20,display=Give Amount - Maximum"`
GiveUnits CWE `hl7:"5,required,len=250,display=Give Units"`
GiveDosageForm *CWE `hl7:"6,len=250,display=Give Dosage Form"`
ProvidersAdministrationInstructions []CWE `hl7:"7,len=250,display=Provider's Administration Instructions"`
DeliverToLocation LA1 `hl7:"8,len=200,display=Deliver-To Location"`
SubstitutionStatus ID `hl7:"9,len=1,table=0167,display=Substitution Status"`
DispenseAmount NM `hl7:"10,conditional,len=20,display=Dispense Amount"`
DispenseUnits *CWE `hl7:"11,conditional,len=250,display=Dispense Units"`
NumberOfRefills NM `hl7:"12,len=3,display=Number Of Refills"`
OrderingProvidersDEANumber []XCN `hl7:"13,conditional,len=250,display=Ordering Provider's DEA Number"`
PharmacistTreatmentSuppliersVerifierID []XCN `hl7:"14,len=250,display=Pharmacist/Treatment Supplier's Verifier ID"`
PrescriptionNumber ST `hl7:"15,conditional,len=20,display=Prescription Number"`
NumberOfRefillsRemaining NM `hl7:"16,conditional,len=20,display=Number of Refills Remaining"`
NumberOfRefillsDosesDispensed NM `hl7:"17,conditional,len=20,display=Number of Refills/Doses Dispensed"`
DTOfMostRecentRefillOrDoseDispensed DTM `hl7:"18,conditional,len=24,format=YMDHM,display=D/T of Most Recent Refill or Dose Dispensed"`
TotalDailyDose *CQ `hl7:"19,conditional,len=10,display=Total Daily Dose"`
NeedsHumanReview ID `hl7:"20,len=1,table=0136,display=Needs Human Review"`
PharmacyTreatmentSuppliersSpecialDispensingInstructions []CWE `hl7:"21,len=250,display=Pharmacy/Treatment Supplier's Special Dispensing Instructions"`
GivePerTimeUnit ST `hl7:"22,conditional,len=20,display=Give Per (Time Unit)"`
GiveRateAmount ST `hl7:"23,len=6,display=Give Rate Amount"`
GiveRateUnits *CWE `hl7:"24,len=250,display=Give Rate Units"`
GiveStrength NM `hl7:"25,len=20,display=Give Strength"`
GiveStrengthUnits *CWE `hl7:"26,len=250,display=Give Strength Units"`
GiveIndication []CWE `hl7:"27,len=250,display=Give Indication"`
DispensePackageSize NM `hl7:"28,len=20,display=Dispense Package Size"`
DispensePackageSizeUnit *CWE `hl7:"29,len=250,display=Dispense Package Size Unit"`
DispensePackageMethod ID `hl7:"30,len=2,table=0321,display=Dispense Package Method"`
SupplementaryCode []CWE `hl7:"31,len=250,display=Supplementary Code"`
OriginalOrderDateTime DTM `hl7:"32,len=24,format=YMDHM,display=Original Order Date/Time"`
GiveDrugStrengthVolume NM `hl7:"33,len=5,display=Give Drug Strength Volume"`
GiveDrugStrengthVolumeUnits *CWE `hl7:"34,len=250,display=Give Drug Strength Volume Units"`
ControlledSubstanceSchedule *CWE `hl7:"35,len=60,table=0477,display=Controlled Substance Schedule"`
FormularyStatus ID `hl7:"36,len=1,table=0478,display=Formulary Status"`
PharmaceuticalSubstanceAlternative []CWE `hl7:"37,len=60,display=Pharmaceutical Substance Alternative"`
PharmacyOfMostRecentFill *CWE `hl7:"38,len=250,display=Pharmacy of Most Recent Fill"`
InitialDispenseAmount NM `hl7:"39,len=250,display=Initial Dispense Amount"`
DispensingPharmacy *CWE `hl7:"40,len=250,display=Dispensing Pharmacy"`
DispensingPharmacyAddress *XAD `hl7:"41,len=250,display=Dispensing Pharmacy Address"`
DeliverToPatientLocation *PL `hl7:"42,len=80,display=Deliver-to Patient Location"`
DeliverToAddress *XAD `hl7:"43,len=250,display=Deliver-to Address"`
PharmacyOrderType ID `hl7:"44,len=1,table=0480,display=Pharmacy Order Type"`
}
Pharmacy/Treatment Encoded Order
The RXE segment details the pharmacy or treatment application's encoding of the order. It also contains several pharmacy-specific order status fields, such as RXE-16-number of refills remaining , RXE-17-number of refills/doses dispensed, RXE-18-D/T of most recent refill or dose dispensed , and RXE-19-total daily dose.
type RXG ¶
type RXG struct {
HL7 HL7Name `hl7:",name=RXG,type=s"`
GiveSubIDCounter NM `hl7:"1,required,len=4,display=Give Sub-ID Counter"`
DispenseSubIDCounter NM `hl7:"2,len=4,display=Dispense Sub-ID Counter"`
QuantityTiming TQ `hl7:"3,len=705,display=Quantity/Timing"`
GiveCode CWE `hl7:"4,required,len=250,table=0292,display=Give Code"`
GiveAmountMinimum NM `hl7:"5,required,len=20,display=Give Amount - Minimum"`
GiveAmountMaximum NM `hl7:"6,len=20,display=Give Amount - Maximum"`
GiveUnits CWE `hl7:"7,required,len=250,display=Give Units"`
GiveDosageForm *CWE `hl7:"8,len=250,display=Give Dosage Form"`
AdministrationNotes []CWE `hl7:"9,len=250,display=Administration Notes"`
SubstitutionStatus ID `hl7:"10,len=1,table=0167,display=Substitution Status"`
DispenseToLocation LA2 `hl7:"11,len=200,display=Dispense-to Location"`
NeedsHumanReview ID `hl7:"12,len=1,table=0136,display=Needs Human Review"`
PharmacyTreatmentSuppliersSpecialAdministrationInstructions []CWE `hl7:"13,len=250,display=Pharmacy/Treatment Supplier's Special Administration Instructions"`
GivePerTImeUnit ST `hl7:"14,conditional,len=20,display=Give Per (TIme Unit)"`
GiveRateAmount ST `hl7:"15,len=6,display=Give Rate Amount"`
GiveRateUnits *CWE `hl7:"16,len=250,display=Give Rate Units"`
GiveStrength NM `hl7:"17,len=20,display=Give Strength"`
GiveStrengthUnits *CWE `hl7:"18,len=250,display=Give Strength Units"`
SubstanceLotNumber []ST `hl7:"19,len=20,display=Substance Lot Number"`
SubstanceExpirationDate []DTM `hl7:"20,len=24,format=YMDHM,display=Substance Expiration Date"`
SubstanceManufacturerName []CWE `hl7:"21,len=250,table=0227,display=Substance Manufacturer Name"`
Indication []CWE `hl7:"22,len=250,display=Indication"`
GiveDrugStrengthVolume NM `hl7:"23,len=5,display=Give Drug Strength Volume"`
GiveDrugStrengthVolumeUnits *CWE `hl7:"24,len=250,display=Give Drug Strength Volume Units"`
GiveBarcodeIdentifier *CWE `hl7:"25,len=60,display=Give Barcode Identifier"`
PharmacyOrderType ID `hl7:"26,len=1,table=0480,display=Pharmacy Order Type"`
DispenseToPharmacy *CWE `hl7:"27,len=180,display=Dispense to Pharmacy"`
DispenseToPharmacyAddress *XAD `hl7:"28,len=106,display=Dispense to Pharmacy Address"`
DeliverToPatientLocation *PL `hl7:"29,len=80,display=Deliver-to Patient Location"`
DeliverToAddress *XAD `hl7:"30,len=250,display=Deliver-to Address"`
}
Pharmacy/Treatment Give
type RXO ¶
type RXO struct {
HL7 HL7Name `hl7:",name=RXO,type=s"`
RequestedGiveCode *CWE `hl7:"1,conditional,len=250,display=Requested Give Code"`
RequestedGiveAmountMinimum NM `hl7:"2,conditional,len=20,display=Requested Give Amount - Minimum"`
RequestedGiveAmountMaximum NM `hl7:"3,len=20,display=Requested Give Amount - Maximum"`
RequestedGiveUnits *CWE `hl7:"4,conditional,len=250,display=Requested Give Units"`
RequestedDosageForm *CWE `hl7:"5,conditional,len=250,display=Requested Dosage Form"`
ProvidersPharmacyTreatmentInstructions []CWE `hl7:"6,len=250,display=Provider's Pharmacy/Treatment Instructions"`
ProvidersAdministrationInstructions []CWE `hl7:"7,len=250,display=Provider's Administration Instructions"`
DeliverToLocation LA1 `hl7:"8,len=200,display=Deliver-To Location"`
AllowSubstitutions ID `hl7:"9,len=1,table=0161,display=Allow Substitutions"`
RequestedDispenseCode *CWE `hl7:"10,len=250,display=Requested Dispense Code"`
RequestedDispenseAmount NM `hl7:"11,len=20,display=Requested Dispense Amount"`
RequestedDispenseUnits *CWE `hl7:"12,len=250,display=Requested Dispense Units"`
NumberOfRefills NM `hl7:"13,len=3,display=Number Of Refills"`
OrderingProvidersDEANumber []XCN `hl7:"14,conditional,len=250,display=Ordering Provider's DEA Number"`
PharmacistTreatmentSuppliersVerifierID []XCN `hl7:"15,conditional,len=250,display=Pharmacist/Treatment Supplier's Verifier ID"`
NeedsHumanReview ID `hl7:"16,len=1,table=0136,display=Needs Human Review"`
RequestedGivePerTimeUnit ST `hl7:"17,conditional,len=20,display=Requested Give Per (Time Unit)"`
RequestedGiveStrength NM `hl7:"18,len=20,display=Requested Give Strength"`
RequestedGiveStrengthUnits *CWE `hl7:"19,len=250,display=Requested Give Strength Units"`
Indication []CWE `hl7:"20,len=250,display=Indication"`
RequestedGiveRateAmount ST `hl7:"21,len=6,display=Requested Give Rate Amount"`
RequestedGiveRateUnits *CWE `hl7:"22,len=250,display=Requested Give Rate Units"`
TotalDailyDose *CQ `hl7:"23,len=10,display=Total Daily Dose"`
SupplementaryCode []CWE `hl7:"24,len=250,display=Supplementary Code"`
RequestedDrugStrengthVolume NM `hl7:"25,len=5,display=Requested Drug Strength Volume"`
RequestedDrugStrengthVolumeUnits *CWE `hl7:"26,len=250,display=Requested Drug Strength Volume Units"`
PharmacyOrderType ID `hl7:"27,len=1,table=0480,display=Pharmacy Order Type"`
DispensingInterval NM `hl7:"28,len=20,display=Dispensing Interval"`
MedicationInstanceIdentifier *EI `hl7:"29,len=60,display=Medication Instance Identifier"`
SegmentInstanceIdentifier *EI `hl7:"30,len=60,display=Segment Instance Identifier"`
MoodCode *CNE `hl7:"31,conditional,len=2,table=0725,display=Mood Code"`
DispensingPharmacy *CWE `hl7:"32,len=250,display=Dispensing Pharmacy"`
DispensingPharmacyAddress *XAD `hl7:"33,len=250,display=Dispensing Pharmacy Address"`
DeliverToPatientLocation *PL `hl7:"34,len=80,display=Deliver-to Patient Location"`
DeliverToAddress *XAD `hl7:"35,len=250,display=Deliver-to Address"`
}
Pharmacy/Treatment Order
This is the "master" pharmacy/treatment order segment. It contains order data not specific to components or additives. Unlike the OBR, it does not contain status fields or other data that are results-only.
type RXR ¶
type RXR struct {
HL7 HL7Name `hl7:",name=RXR,type=s"`
Route CWE `hl7:"1,required,len=250,table=0162,display=Route"`
AdministrationSite *CWE `hl7:"2,len=250,table=0550,display=Administration Site"`
AdministrationDevice *CWE `hl7:"3,len=250,table=0164,display=Administration Device"`
AdministrationMethod *CWE `hl7:"4,len=250,table=0165,display=Administration Method"`
RoutingInstruction *CWE `hl7:"5,len=250,display=Routing Instruction"`
AdministrationSiteModifier *CWE `hl7:"6,len=250,table=0495,display=Administration Site Modifier"`
}
Pharmacy/Treatment Route
The Pharmacy/Treatment Route segment contains the alternative combination of route, site, administration device, and administration method that are prescribed as they apply to a particular order. The pharmacy, treatment staff and/or nursing staff has a choice between the routes based on either their professional judgment or administration instructions provided by the physician.
type SAC ¶
type SAC struct {
HL7 HL7Name `hl7:",name=SAC,type=s"`
ExternalAccessionIdentifier *EI `hl7:"1,len=427,display=External Accession Identifier"`
AccessionIdentifier *EI `hl7:"2,len=427,display=Accession Identifier"`
ContainerIdentifier *EI `hl7:"3,conditional,len=427,display=Container Identifier"`
PrimaryParentContainerIdentifier *EI `hl7:"4,conditional,len=427,display=Primary (Parent) Container Identifier"`
EquipmentContainerIdentifier *EI `hl7:"5,len=427,display=Equipment Container Identifier"`
SpecimenSource *SPS `hl7:"6,conditional,len=300,display=Specimen Source"`
RegistrationDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Registration Date/Time"`
ContainerStatus *CWE `hl7:"8,len=705,table=0370,display=Container Status"`
CarrierType *CWE `hl7:"9,len=705,table=0378,display=Carrier Type"`
CarrierIdentifier *EI `hl7:"10,len=705,display=Carrier Identifier"`
PositionInCarrier *NA `hl7:"11,len=80,display=Position in Carrier"`
TrayType *CWE `hl7:"12,len=705,table=0379,display=Tray Type - SAC"`
TrayIdentifier *EI `hl7:"13,len=427,display=Tray Identifier"`
PositionInTray *NA `hl7:"14,len=80,display=Position in Tray"`
Location []CWE `hl7:"15,len=705,display=Location"`
ContainerHeight NM `hl7:"16,len=20,display=Container Height"`
ContainerDiameter NM `hl7:"17,len=20,display=Container Diameter"`
BarrierDelta NM `hl7:"18,len=20,display=Barrier Delta"`
BottomDelta NM `hl7:"19,len=20,display=Bottom Delta"`
ContainerHeightDiameterDeltaUnits *CWE `hl7:"20,len=705,display=Container Height/Diameter/Delta Units"`
ContainerVolume NM `hl7:"21,len=20,display=Container Volume"`
AvailableSpecimenVolume NM `hl7:"22,len=20,display=Available Specimen Volume"`
InitialSpecimenVolume NM `hl7:"23,len=20,display=Initial Specimen Volume"`
VolumeUnits *CWE `hl7:"24,len=705,display=Volume Units"`
SeparatorType *CWE `hl7:"25,len=705,table=0380,display=Separator Type"`
CapType *CWE `hl7:"26,len=705,table=0381,display=Cap Type"`
Additive []CWE `hl7:"27,len=705,table=0371,display=Additive"`
SpecimenComponent *CWE `hl7:"28,len=705,table=0372,display=Specimen Component"`
DilutionFactor *SN `hl7:"29,len=36,display=Dilution Factor"`
Treatment *CWE `hl7:"30,len=705,table=0373,display=Treatment"`
Temperature *SN `hl7:"31,len=36,display=Temperature"`
HemolysisIndex NM `hl7:"32,len=20,display=Hemolysis Index"`
HemolysisIndexUnits *CWE `hl7:"33,len=705,display=Hemolysis Index Units"`
LipemiaIndex NM `hl7:"34,len=20,display=Lipemia Index"`
LipemiaIndexUnits *CWE `hl7:"35,len=705,display=Lipemia Index Units"`
IcterusIndex NM `hl7:"36,len=20,display=Icterus Index"`
IcterusIndexUnits *CWE `hl7:"37,len=705,display=Icterus Index Units"`
FibrinIndex NM `hl7:"38,len=20,display=Fibrin Index"`
FibrinIndexUnits *CWE `hl7:"39,len=705,display=Fibrin Index Units"`
SystemInducedContaminants []CWE `hl7:"40,len=705,table=0374,display=System Induced Contaminants"`
DrugInterference []CWE `hl7:"41,len=705,table=0382,display=Drug Interference"`
ArtificialBlood *CWE `hl7:"42,len=705,table=0375,display=Artificial Blood"`
SpecialHandlingCode []CWE `hl7:"43,len=705,table=0376,display=Special Handling Code"`
OtherEnvironmentalFactors []CWE `hl7:"44,len=705,table=0377,display=Other Environmental Factors"`
}
Specimen Container Detail
The container detail segment is the data necessary to maintain the containers that are being used throughout the Laboratory Automation System.
The specimens in many laboratories are transported and processed in containers (e.g., sample tubes). When SPM and SAC are used in the same message, then the conceptually duplicate attributes will be valued only in the SPM. This applies to SAC-6 - Specimen Source, SAC-27 - Additives, and SAC-43 - Special Handling Considerations.
type SAD ¶
type SAD struct {
HL7 HL7Name `hl7:",name=SAD,len=184,type=d"`
StreetOrMailingAddress ST `` /* 296-byte string literal not displayed */
StreetName ST `hl7:"2,len=50,display=Street Name"`
DwellingNumber ST `hl7:"3,len=12,display=Dwelling Number"`
}
Street Address
This data type specifies an entity's street address and associated detail.
type SCD ¶
type SCD struct {
HL7 HL7Name `hl7:",name=SCD,type=s"`
CycleStartTime TM `hl7:"1,len=16,format=HM,display=Cycle Start Time"`
CycleCount NM `hl7:"2,len=16,display=Cycle Count"`
TempMax *CQ `hl7:"3,len=36,display=Temp Max"`
TempMin *CQ `hl7:"4,len=36,display=Temp Min"`
LoadNumber NM `hl7:"5,len=16,display=Load Number"`
ConditionTime *CQ `hl7:"6,len=16,display=Condition Time"`
SterilizeTime *CQ `hl7:"7,len=16,display=Sterilize Time"`
ExhaustTime *CQ `hl7:"8,len=16,display=Exhaust Time"`
TotalCycleTime *CQ `hl7:"9,len=16,display=Total Cycle Time"`
DeviceStatus *CWE `hl7:"10,len=4,table=0682,display=Device Status"`
CycleStartDateTime DTM `hl7:"11,len=24,format=YMDHM,display=Cycle Start Date/Time"`
DryTime *CQ `hl7:"12,len=16,display=Dry Time"`
LeakRate *CQ `hl7:"13,len=16,display=Leak Rate"`
ControlTemperature *CQ `hl7:"14,len=36,display=Control Temperature"`
SterilizerTemperature *CQ `hl7:"15,len=36,display=Sterilizer Temperature"`
CycleCompleteTime TM `hl7:"16,len=16,format=HM,display=Cycle Complete Time"`
UnderTemperature *CQ `hl7:"17,len=36,display=Under Temperature"`
OverTemperature *CQ `hl7:"18,len=36,display=Over Temperature"`
AbortCycle *CNE `hl7:"19,len=4,table=0532,display=Abort Cycle"`
Alarm *CNE `hl7:"20,len=4,table=0532,display=Alarm"`
LongInChargePhase *CNE `hl7:"21,len=4,table=0532,display=Long in Charge Phase"`
LongInExhaustPhase *CNE `hl7:"22,len=4,table=0532,display=Long in Exhaust Phase"`
LongInFastExhaustPhase *CNE `hl7:"23,len=4,table=0532,display=Long in Fast Exhaust Phase"`
Reset *CNE `hl7:"24,len=4,table=0532,display=Reset"`
OperatorUnload *XCN `hl7:"25,len=15,display=Operator - Unload"`
DoorOpen *CNE `hl7:"26,len=4,table=0532,display=Door Open"`
ReadingFailure *CNE `hl7:"27,len=4,table=0532,display=Reading Failure"`
CycleType *CWE `hl7:"28,len=3,table=0702,display=Cycle Type"`
ThermalRinseTime *CQ `hl7:"29,len=16,display=Thermal Rinse Time"`
WashTime *CQ `hl7:"30,len=16,display=Wash Time"`
InjectionRate *CQ `hl7:"31,len=16,display=Injection Rate"`
ProcedureCode *CNE `hl7:"32,len=705,table=0088,display=Procedure Code"`
PatientIdentifierList []CX `hl7:"33,len=250,display=Patient Identifier List"`
AttendingDoctor *XCN `hl7:"34,len=250,table=0010,display=Attending Doctor"`
DilutionFactor *SN `hl7:"35,len=36,display=Dilution Factor"`
FillTime *CQ `hl7:"36,len=16,display=Fill Time"`
InletTemperature *CQ `hl7:"37,len=36,display=Inlet Temperature"`
}
Anti-Microbial Cycle Data
The SCD segment contains cycle data representing an instance of a sterilization or decontamination.
type SCH ¶
type SCH struct {
HL7 HL7Name `hl7:",name=SCH,type=s"`
PlacerAppointmentID *EI `hl7:"1,conditional,len=75,display=Placer Appointment ID"`
FillerAppointmentID *EI `hl7:"2,conditional,len=75,display=Filler Appointment ID"`
OccurrenceNumber NM `hl7:"3,conditional,len=5,display=Occurrence Number"`
PlacerGroupNumber *EI `hl7:"4,len=22,display=Placer Group Number"`
ScheduleID *CWE `hl7:"5,len=250,display=Schedule ID"`
EventReason CWE `hl7:"6,required,len=250,display=Event Reason"`
AppointmentReason *CWE `hl7:"7,len=250,table=0276,display=Appointment Reason"`
AppointmentType *CWE `hl7:"8,len=250,table=0277,display=Appointment Type"`
AppointmentDuration NM `hl7:"9,len=20,display=Appointment Duration"`
AppointmentDurationUnits CNE `hl7:"10,len=250,display=Appointment Duration Units"`
AppointmentTimingQuantity []TQ `hl7:"11,len=200,display=Appointment Timing Quantity"`
PlacerContactPerson []XCN `hl7:"12,len=250,display=Placer Contact Person"`
PlacerContactPhoneNumber *XTN `hl7:"13,len=250,display=Placer Contact Phone Number"`
PlacerContactAddress []XAD `hl7:"14,len=250,display=Placer Contact Address"`
PlacerContactLocation *PL `hl7:"15,len=80,display=Placer Contact Location"`
FillerContactPerson []XCN `hl7:"16,required,len=250,display=Filler Contact Person"`
FillerContactPhoneNumber *XTN `hl7:"17,len=250,display=Filler Contact Phone Number"`
FillerContactAddress []XAD `hl7:"18,len=250,display=Filler Contact Address"`
FillerContactLocation *PL `hl7:"19,len=80,display=Filler Contact Location"`
EnteredByPerson []XCN `hl7:"20,required,len=250,display=Entered By Person"`
EnteredByPhoneNumber []XTN `hl7:"21,len=250,display=Entered By Phone Number"`
EnteredByLocation *PL `hl7:"22,len=80,display=Entered By Location"`
ParentPlacerAppointmentID *EI `hl7:"23,len=75,display=Parent Placer Appointment ID"`
ParentFillerAppointmentID *EI `hl7:"24,conditional,len=75,display=Parent Filler Appointment ID"`
FillerStatusCode *CWE `hl7:"25,len=250,table=0278,display=Filler Status Code"`
PlacerOrderNumber []EI `hl7:"26,conditional,len=427,display=Placer Order Number"`
FillerOrderNumber []EI `hl7:"27,conditional,len=427,display=Filler Order Number"`
}
Scheduling Activity Information
The SCH segment contains general information about the scheduled appointment.
type SCN_S37 ¶
type SCN_S37 struct {
HL7 HL7Name `hl7:",name=SCN_S37,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
AntiMicrobialDeviceCycleData []SCN_S37_AntiMicrobialDeviceCycleData `hl7:",required,display=Anti Microbial Device Cycle Data"`
}
Notification of Anti-Microbial Device Cycle Data
This message is sent from a filler application to notify other applications that anti-microbial device cycle data has been generated. The information in the SCN segment and the other detail segments as appropriate describe details of a sterilization or decontamination cycle.
type SCN_S37_AntiMicrobialDeviceCycleData ¶
type SCN_S37_AntiMicrobialDeviceCycleData struct {
HL7 HL7Name `hl7:",name=SCN_S37_AntiMicrobialDeviceCycleData,type=tg"`
SDD *SDD `hl7:"4,required,display=Sterilization Device Data"`
SCD []SCD `hl7:"5,display=Anti-Microbial Cycle Data"`
}
AntiMicrobialDeviceCycleData
type SCP ¶
type SCP struct {
HL7 HL7Name `hl7:",name=SCP,type=s"`
NumberOfDecontaminationSterilizationDevices NM `hl7:"1,len=2,display=Number Of Decontamination/Sterilization Devices"`
LaborCalculationType *CWE `hl7:"2,len=250,table=0651,display=Labor Calculation Type"`
DateFormat *CWE `hl7:"3,len=250,table=0653,display=Date Format"`
DeviceNumber *EI `hl7:"4,len=8,display=Device Number"`
DeviceName ST `hl7:"5,len=999,display=Device Name"`
DeviceModelName ST `hl7:"6,len=2,display=Device Model Name"`
DeviceType *CWE `hl7:"7,len=250,table=0657,display=Device Type"`
LotControl *CWE `hl7:"8,len=250,table=0659,display=Lot Control"`
}
Sterilizer Configuration
The sterilization configuration segment contains information specific to configuration of a sterilizer or washer for processing sterilization or decontamination loads.
type SCV ¶
type SCV struct {
HL7 HL7Name `hl7:",name=SCV,len=41,type=d"`
ParameterClass *CWE `` /* 260-byte string literal not displayed */
ParameterValue ST `hl7:"2,len=20,display=The second component is the actual data value for that parameter."`
}
Scheduling Class Value Pair
This data type is used to communicate parameters and preferences to the filler application regarding the selection of an appropriate time slot, resource, location, or filler override criterion for an appointment.
type SDD ¶
type SDD struct {
HL7 HL7Name `hl7:",name=SDD,type=s"`
LotNumber *EI `hl7:"1,len=11,display=Lot Number"`
DeviceNumber *EI `hl7:"2,len=8,display=Device Number"`
DeviceName ST `hl7:"3,len=999,display=Device Name"`
DeviceDataState IS `hl7:"4,len=1,table=0667,display=Device Data State"`
LoadStatus IS `hl7:"5,len=3,table=0669,display=Load Status"`
ControlCode NM `hl7:"6,len=3,display=Control Code"`
OperatorName ST `hl7:"7,len=15,display=Operator Name"`
}
Sterilization Device Data
The SDD segment contains the attributes of an instance of a cycle that provides sterilization or decontamination of medical supplies.
type SDN_S36 ¶
type SDN_S36 struct {
HL7 HL7Name `hl7:",name=SDN_S36,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
AntiMicrobialDeviceData []SDN_S36_AntiMicrobialDeviceData `hl7:",required,display=Anti Microbial Device Data"`
}
Notification of Anti-Microbial Device Data
This message is sent from a filler application to notify other applications that anti-microbial device data has been generated. The information in the SDN segment and the other detail segments as appropriate describe the detail of a device during a sterilization or decontamination cycle.
type SDN_S36_AntiMicrobialDeviceData ¶
type SDN_S36_AntiMicrobialDeviceData struct {
HL7 HL7Name `hl7:",name=SDN_S36_AntiMicrobialDeviceData,type=tg"`
SDD *SDD `hl7:"4,required,display=Sterilization Device Data"`
SCD []SCD `hl7:"5,display=Anti-Microbial Cycle Data"`
}
AntiMicrobialDeviceData
type SDR_S31 ¶
type SDR_S31 struct {
HL7 HL7Name `hl7:",name=SDR_S31,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
AntiMicrobialDeviceData []SDR_S31_AntiMicrobialDeviceData `hl7:",required,display=Anti Microbial Device Data"`
}
Request Sterilization Anti-Microbial Device Data
This trigger event is sent by the placer application to the filler application to request anti-microbial device data created during the decontamination/sterilization of medical supplies. In the context of this message segment, the term 'device' refers to a sterilizer or a washer. Sterilizers perform a sterilization process and washers perform a decontamination process.
type SDR_S31_AntiMicrobialDeviceData ¶
type SDR_S31_AntiMicrobialDeviceData struct {
HL7 HL7Name `hl7:",name=SDR_S31_AntiMicrobialDeviceData,type=tg"`
SDD *SDD `hl7:"4,required,display=Sterilization Device Data"`
SCD []SCD `hl7:"5,display=Anti-Microbial Cycle Data"`
}
AntiMicrobialDeviceData
type SFT ¶
type SFT struct {
HL7 HL7Name `hl7:",name=SFT,type=s"`
SoftwareVendorOrganization XON `hl7:"1,required,len=567,display=Software Vendor Organization"`
SoftwareCertifiedVersionOrReleaseNumber ST `hl7:"2,required,len=15,display=Software Certified Version or Release Number"`
SoftwareProductName ST `hl7:"3,required,len=20,display=Software Product Name"`
SoftwareBinaryID ST `hl7:"4,required,len=20,display=Software Binary ID"`
SoftwareProductInformation TX `hl7:"5,len=1024,display=Software Product Information"`
SoftwareInstallDate DTM `hl7:"6,len=24,format=YMDHM,display=Software Install Date"`
}
Software Segment
This segment provides additional information about the software product(s) used as a Sending Application. The primary purpose of this segment is for diagnostic use. There may be additional uses per site-specific agreements.
Example: MSH [{ SFT }] ...
type SI ¶
type SI = string
Sequence ID
A non-negative integer in the form of a NM field. The uses of this data type are defined in the chapters defining the segments and messages in which it appears.
Maximum Length: 4. This allows for a number between 0 and 9999 to be specified.
type SID ¶
type SID struct {
HL7 HL7Name `hl7:",name=SID,type=s"`
ApplicationMethodIdentifier *CWE `hl7:"1,conditional,len=705,display=Application / Method Identifier"`
SubstanceLotNumber ST `hl7:"2,conditional,len=20,display=Substance Lot Number"`
SubstanceContainerIdentifier ST `hl7:"3,conditional,len=200,display=Substance Container Identifier"`
SubstanceManufacturerIdentifier *CWE `hl7:"4,conditional,len=705,table=0385,display=Substance Manufacturer Identifier"`
}
Substance Identifier
The Substance Identifier segment contains data necessary to identify the substance (e.g., reagents) used in the production of analytical test results. The combination of these fields must uniquely identify the substance, i.e., depending on the manufacturer all or some fields are required (this is the reason the optionality is 'C' (conditional)). If the analysis requires multiple substances, this segment is repeated for each substance. The segment(s) should be attached to the TCD segment.
type SIU_S12 ¶
type SIU_S12 struct {
HL7 HL7Name `hl7:",name=SIU_S12,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S12_Patient `hl7:",display=Patient"`
Resources []SIU_S12_Resources `hl7:",required,display=Resources"`
}
Notification of New Appointment Booking
This message is sent from a filler application to notify other applications that a new appointment has been booked. The information provided in the SCH segment and the other detail segments as appropriate describe the appointment that has been booked by the filler application.
type SIU_S12_GeneralResource ¶
type SIU_S12_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S12_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S12_LocationResource ¶
type SIU_S12_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S12_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S12_Patient ¶
type SIU_S12_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S12_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S12_PersonnelResource ¶
type SIU_S12_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S12_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S12_Resources ¶
type SIU_S12_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S12_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S12_Service `hl7:",display=Service"`
GeneralResource []SIU_S12_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S12_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S12_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S12_Service ¶
type SIU_S12_Service struct {
HL7 HL7Name `hl7:",name=SIU_S12_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S13 ¶
type SIU_S13 struct {
HL7 HL7Name `hl7:",name=SIU_S13,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S13_Patient `hl7:",display=Patient"`
Resources []SIU_S13_Resources `hl7:",required,display=Resources"`
}
Notification of Appointment Rescheduling
This message is sent from a filler application to notify other applications that an existing appointment has been rescheduled. The information in the SCH segment and the other detail segments as appropriate describe the new date(s) and time(s) to which the previously booked appointment has been moved. Additionally, it describes the unchanged information in the previously booked appointment.
This transaction should not be used to reschedule an appointment that has begun but has not been completed. In such cases, and only if it logical to do so, the appointment should be discontinued and a new schedule request should be submitted. Likewise, this transaction should not be used to reschedule a parent appointment, in which one or more children have begun or have already taken place. Again, the parent appointment should be discontinued, and a new schedule request should be made. This procedure removes any ambiguity between applications that may arise with an attempt to modify an appointment that is in progress.
type SIU_S13_GeneralResource ¶
type SIU_S13_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S13_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S13_LocationResource ¶
type SIU_S13_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S13_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S13_Patient ¶
type SIU_S13_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S13_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S13_PersonnelResource ¶
type SIU_S13_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S13_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S13_Resources ¶
type SIU_S13_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S13_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S13_Service `hl7:",display=Service"`
GeneralResource []SIU_S13_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S13_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S13_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S13_Service ¶
type SIU_S13_Service struct {
HL7 HL7Name `hl7:",name=SIU_S13_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S14 ¶
type SIU_S14 struct {
HL7 HL7Name `hl7:",name=SIU_S14,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S14_Patient `hl7:",display=Patient"`
Resources []SIU_S14_Resources `hl7:",required,display=Resources"`
}
Notification of Appointment Modification
This message notifies other applications that an existing appointment has been modified on the filler application. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed.
type SIU_S14_GeneralResource ¶
type SIU_S14_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S14_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S14_LocationResource ¶
type SIU_S14_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S14_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S14_Patient ¶
type SIU_S14_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S14_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S14_PersonnelResource ¶
type SIU_S14_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S14_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S14_Resources ¶
type SIU_S14_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S14_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S14_Service `hl7:",display=Service"`
GeneralResource []SIU_S14_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S14_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S14_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S14_Service ¶
type SIU_S14_Service struct {
HL7 HL7Name `hl7:",name=SIU_S14_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S15 ¶
type SIU_S15 struct {
HL7 HL7Name `hl7:",name=SIU_S15,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S15_Patient `hl7:",display=Patient"`
Resources []SIU_S15_Resources `hl7:",required,display=Resources"`
}
Notification of Appointment Cancellation
A notification of appointment cancellation is sent by the filler application to other applications when an existing appointment has been canceled. A cancel event is used to stop a valid appointment from taking place. For example, if a patient scheduled for an exam cancels his/her appointment, then the appointment is canceled on the filler application.
This trigger event can be used to cancel a parent appointment, in which none of the children of the appointment have either begun or been completed. Any child appointments that exist on the filler and placer applications should be considered canceled. If one or more child appointments have begun or have been completed, then this trigger event should not be used. Instead, the S16 (notification of appointment discontinuation) event should be used.
type SIU_S15_GeneralResource ¶
type SIU_S15_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S15_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S15_LocationResource ¶
type SIU_S15_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S15_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S15_Patient ¶
type SIU_S15_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S15_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S15_PersonnelResource ¶
type SIU_S15_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S15_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S15_Resources ¶
type SIU_S15_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S15_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S15_Service `hl7:",display=Service"`
GeneralResource []SIU_S15_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S15_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S15_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S15_Service ¶
type SIU_S15_Service struct {
HL7 HL7Name `hl7:",name=SIU_S15_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S16 ¶
type SIU_S16 struct {
HL7 HL7Name `hl7:",name=SIU_S16,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S16_Patient `hl7:",display=Patient"`
Resources []SIU_S16_Resources `hl7:",required,display=Resources"`
}
Notification of Appointment Discontinuation
A notification of appointment discontinuation is sent by the filler application to notify other applications that an appointment in progress has been stopped, or that the remaining occurrences of a parent appointment will not occur. If none of the child appointments of a parent appointment have taken place, then a cancel trigger event should be sent instead.
type SIU_S16_GeneralResource ¶
type SIU_S16_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S16_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S16_LocationResource ¶
type SIU_S16_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S16_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S16_Patient ¶
type SIU_S16_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S16_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S16_PersonnelResource ¶
type SIU_S16_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S16_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S16_Resources ¶
type SIU_S16_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S16_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S16_Service `hl7:",display=Service"`
GeneralResource []SIU_S16_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S16_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S16_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S16_Service ¶
type SIU_S16_Service struct {
HL7 HL7Name `hl7:",name=SIU_S16_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S17 ¶
type SIU_S17 struct {
HL7 HL7Name `hl7:",name=SIU_S17,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S17_Patient `hl7:",display=Patient"`
Resources []SIU_S17_Resources `hl7:",required,display=Resources"`
}
Notification of Appointment Deletion
A notification of appointment deletion is sent by the filler application to other applications when an appointment that had been entered in error has been removed from the system. A delete trigger event should only be used when an appointment has been erroneously scheduled. It must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. This trigger event should not be used for any appointment that has already begun, or that has already been completed. Likewise, it should not be used for any parent appointment if any child appointments have either begun or been completed.
The delete trigger event should be implemented with careful forethought, as it typically has different effects and repercussions in various applications. In some applications, a delete event cannot be undone. This means that if a delete transaction was sent erroneously, recovery will be difficult or impossible. In other applications, a delete transaction will not result in the physical deletion of the record(s), but will set a status or a flag. In these cases, the filler and/or placer appointment identifiers (the numbers or codes that uniquely identify the scheduled appointment or request to the placer and filler applications) probably cannot be reused. Since these applications maintain a record of deleted appointments, the reuse of an identifier will likely cause a conflict in the applications' processing of transactions.
type SIU_S17_GeneralResource ¶
type SIU_S17_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S17_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S17_LocationResource ¶
type SIU_S17_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S17_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S17_Patient ¶
type SIU_S17_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S17_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S17_PersonnelResource ¶
type SIU_S17_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S17_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S17_Resources ¶
type SIU_S17_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S17_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S17_Service `hl7:",display=Service"`
GeneralResource []SIU_S17_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S17_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S17_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S17_Service ¶
type SIU_S17_Service struct {
HL7 HL7Name `hl7:",name=SIU_S17_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S18 ¶
type SIU_S18 struct {
HL7 HL7Name `hl7:",name=SIU_S18,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S18_Patient `hl7:",display=Patient"`
Resources []SIU_S18_Resources `hl7:",required,display=Resources"`
}
Notification of Addition of Service/Resource on Appointment
The notification of addition of service/resource is triggered on the filler application when a new service or resource has been added to an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed.
type SIU_S18_GeneralResource ¶
type SIU_S18_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S18_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S18_LocationResource ¶
type SIU_S18_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S18_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S18_Patient ¶
type SIU_S18_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S18_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S18_PersonnelResource ¶
type SIU_S18_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S18_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S18_Resources ¶
type SIU_S18_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S18_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S18_Service `hl7:",display=Service"`
GeneralResource []SIU_S18_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S18_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S18_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S18_Service ¶
type SIU_S18_Service struct {
HL7 HL7Name `hl7:",name=SIU_S18_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S19 ¶
type SIU_S19 struct {
HL7 HL7Name `hl7:",name=SIU_S19,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S19_Patient `hl7:",display=Patient"`
Resources []SIU_S19_Resources `hl7:",required,display=Resources"`
}
Notification of Modification of Service/Resource on Appointment
The notification of modification of service/resource is triggered on the filler application when the information pertaining to an existing service or resource has been changed for an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed.
This trigger event should not be used when an existing resource or service has been replaced in relation to an existing appointment. Instead, use two other trigger events: S20 (notification of cancellation of service/ resource on appointment), as well as S18 (notification of addition of service/resource on appointment).
type SIU_S19_GeneralResource ¶
type SIU_S19_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S19_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S19_LocationResource ¶
type SIU_S19_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S19_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S19_Patient ¶
type SIU_S19_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S19_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S19_PersonnelResource ¶
type SIU_S19_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S19_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S19_Resources ¶
type SIU_S19_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S19_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S19_Service `hl7:",display=Service"`
GeneralResource []SIU_S19_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S19_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S19_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S19_Service ¶
type SIU_S19_Service struct {
HL7 HL7Name `hl7:",name=SIU_S19_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S20 ¶
type SIU_S20 struct {
HL7 HL7Name `hl7:",name=SIU_S20,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S20_Patient `hl7:",display=Patient"`
Resources []SIU_S20_Resources `hl7:",required,display=Resources"`
}
Notification of Cancellation of Service/Resource on Appointment
This trigger event notifies other applications that a service or resource has been removed from an existing scheduled appointment that has not yet begun. A cancel event is used to stop a valid service or resource from participating in the appointment. For example, if a portable X-ray machine scheduled for an exam is no longer needed, then the resource is canceled on the filler application. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed.
type SIU_S20_GeneralResource ¶
type SIU_S20_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S20_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S20_LocationResource ¶
type SIU_S20_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S20_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S20_Patient ¶
type SIU_S20_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S20_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S20_PersonnelResource ¶
type SIU_S20_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S20_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S20_Resources ¶
type SIU_S20_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S20_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S20_Service `hl7:",display=Service"`
GeneralResource []SIU_S20_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S20_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S20_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S20_Service ¶
type SIU_S20_Service struct {
HL7 HL7Name `hl7:",name=SIU_S20_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S21 ¶
type SIU_S21 struct {
HL7 HL7Name `hl7:",name=SIU_S21,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S21_Patient `hl7:",display=Patient"`
Resources []SIU_S21_Resources `hl7:",required,display=Resources"`
}
Notification of Discontinuation of Service/Resource on Appointment
A notification of discontinuation of service/resource is sent by the filler application to other applications when the remaining children of a parent appointment no longer require a particular service or resource. In other words, this trigger event is sent to discontinue the performance of a service or resource in a parent appointment that has already begun. If the first appointment in a set of recurring appointments has not yet taken place, then a cancel trigger event should be sent instead. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed.
type SIU_S21_GeneralResource ¶
type SIU_S21_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S21_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S21_LocationResource ¶
type SIU_S21_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S21_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S21_Patient ¶
type SIU_S21_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S21_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S21_PersonnelResource ¶
type SIU_S21_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S21_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S21_Resources ¶
type SIU_S21_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S21_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S21_Service `hl7:",display=Service"`
GeneralResource []SIU_S21_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S21_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S21_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S21_Service ¶
type SIU_S21_Service struct {
HL7 HL7Name `hl7:",name=SIU_S21_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S22 ¶
type SIU_S22 struct {
HL7 HL7Name `hl7:",name=SIU_S22,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S22_Patient `hl7:",display=Patient"`
Resources []SIU_S22_Resources `hl7:",required,display=Resources"`
}
Notification of Deletion of Service/Resource on Appointment
A notification of deletion of service/resource is sent by the filler application to other applications when a scheduled appointment requiring a service or resource entered in error has been removed from the system. A delete trigger event should only be used in those circumstances when a service or resource has been erroneously attached to an appointment, and must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from taking place.
type SIU_S22_GeneralResource ¶
type SIU_S22_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S22_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S22_LocationResource ¶
type SIU_S22_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S22_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S22_Patient ¶
type SIU_S22_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S22_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S22_PersonnelResource ¶
type SIU_S22_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S22_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S22_Resources ¶
type SIU_S22_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S22_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S22_Service `hl7:",display=Service"`
GeneralResource []SIU_S22_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S22_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S22_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S22_Service ¶
type SIU_S22_Service struct {
HL7 HL7Name `hl7:",name=SIU_S22_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S23 ¶
type SIU_S23 struct {
HL7 HL7Name `hl7:",name=SIU_S23,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S23_Patient `hl7:",display=Patient"`
Resources []SIU_S23_Resources `hl7:",required,display=Resources"`
}
Notification of Blocked Schedule Time Slot(s)
A notification of blocked schedule time slots is sent by the filler application to other applications when a schedule has had one or more time slots blocked and made unavailable for reasons other than the scheduling of an appointment. For example, if an exam room is unavailable for several hours because of maintenance needs or contamination, a user may block off those several hours on the exam room's schedule. Similarly, if a physician is unavailable because he or she has taken vacation time, his or her schedule may be blocked off for the duration of the vacation. When these types of conditions exist, the filler application may use this transaction to notify other applications that the resources controlled by schedules are unavailable.
type SIU_S23_GeneralResource ¶
type SIU_S23_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S23_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S23_LocationResource ¶
type SIU_S23_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S23_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S23_Patient ¶
type SIU_S23_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S23_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S23_PersonnelResource ¶
type SIU_S23_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S23_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S23_Resources ¶
type SIU_S23_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S23_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S23_Service `hl7:",display=Service"`
GeneralResource []SIU_S23_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S23_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S23_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S23_Service ¶
type SIU_S23_Service struct {
HL7 HL7Name `hl7:",name=SIU_S23_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S24 ¶
type SIU_S24 struct {
HL7 HL7Name `hl7:",name=SIU_S24,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S24_Patient `hl7:",display=Patient"`
Resources []SIU_S24_Resources `hl7:",required,display=Resources"`
}
Notification of Opened (Un-Blocked) Schedule Time Slot(s)
A notification of blocked schedule time slots is sent by the filler application to other applications when a schedule has one or more time slots open up ("un-blocked") and become available for use. Typically, the blocked period of time on a schedule is simply allowed to expire, because the blocked amount of time is generally used for non-appointment activities. This transaction can be used either to discontinue the blocked status on the schedule, or to reverse a previous block made in error. For the purposes of this transaction, discontinuing a block currently in progress (the blocked period has started, but not yet completed) and canceling a blocked period in the future are not significantly different. Therefore, a separate discontinue block transaction is not necessary. If this transaction is received prior to the inception of a blocked period, then the entire block period is simply canceled according to the data provided in the transaction. If the transaction is received after the blocked period has begun, but prior to the end of the blocked period, then the blocked period is discontinued according to the data provided in the transactions. Applications may decide how to handle transactions that attempt to open a blocked period that has both started and ended in the past; however, these transactions can generally be ignored.
type SIU_S24_GeneralResource ¶
type SIU_S24_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S24_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S24_LocationResource ¶
type SIU_S24_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S24_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S24_Patient ¶
type SIU_S24_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S24_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S24_PersonnelResource ¶
type SIU_S24_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S24_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S24_Resources ¶
type SIU_S24_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S24_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S24_Service `hl7:",display=Service"`
GeneralResource []SIU_S24_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S24_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S24_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S24_Service ¶
type SIU_S24_Service struct {
HL7 HL7Name `hl7:",name=SIU_S24_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SIU_S26 ¶
type SIU_S26 struct {
HL7 HL7Name `hl7:",name=SIU_S26,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SCH *SCH `hl7:"2,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"3,display=Timing/Quantity"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SIU_S26_Patient `hl7:",display=Patient"`
Resources []SIU_S26_Resources `hl7:",required,display=Resources"`
}
Notification That Patient Did Not Show Up for Scheduled Appointment
A notification that a patient did not show up for an appointment. For example, if a patient was scheduled for a clinic visit, and never arrived for that appointment, this trigger event can be used to set a status on the appointment record for statistical purposes, as well as to free resources assigned to the appointment (or any other application level actions that must be taken in the event a patient does not appear for an appointment).
Patient Administration events can be used to indicate that a patient has arrived for an appointment, e.g., A01 (admit/visit notification), A04 (register a patient), A05 (pre-admit a patient), or A10 (patient arriving - tracking) as possible examples. Similarly, Patient Administration transactions can be used to identify the end of an appointment, e.g., A03 (discharge/end visit) or A09 (patient departing - tracking) as possible examples.
type SIU_S26_GeneralResource ¶
type SIU_S26_GeneralResource struct {
HL7 HL7Name `hl7:",name=SIU_S26_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SIU_S26_LocationResource ¶
type SIU_S26_LocationResource struct {
HL7 HL7Name `hl7:",name=SIU_S26_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SIU_S26_Patient ¶
type SIU_S26_Patient struct {
HL7 HL7Name `hl7:",name=SIU_S26_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PD1 *PD1 `hl7:"6,display=Patient Additional Demographic"`
PV1 *PV1 `hl7:"7,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"9,display=Observation/Result"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SIU_S26_PersonnelResource ¶
type SIU_S26_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SIU_S26_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SIU_S26_Resources ¶
type SIU_S26_Resources struct {
HL7 HL7Name `hl7:",name=SIU_S26_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SIU_S26_Service `hl7:",display=Service"`
GeneralResource []SIU_S26_GeneralResource `hl7:",display=General Resource"`
LocationResource []SIU_S26_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SIU_S26_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SIU_S26_Service ¶
type SIU_S26_Service struct {
HL7 HL7Name `hl7:",name=SIU_S26_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SLN_S34 ¶
type SLN_S34 struct {
HL7 HL7Name `hl7:",name=SLN_S34,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SLT []SLT `hl7:"4,required,display=Sterilization Lot Segment"`
}
Notification of New Sterilization Lot
This message is sent from a filler application to notify other applications that a new sterilization lot has been created. The information provided in the SLT segment describes the new sterilization lot that has been created by the filler application.
type SLN_S35 ¶
type SLN_S35 struct {
HL7 HL7Name `hl7:",name=SLN_S35,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SLT []SLT `hl7:"4,required,display=Sterilization Lot Segment"`
}
Notification of Sterilization Lot Deletion
This message is sent from a filler application to notify other applications that a sterilization lot has been deleted. The information provided in the SLT segment describes the sterilization lot that has been deleted by the filler application.
type SLR_S28 ¶
type SLR_S28 struct {
HL7 HL7Name `hl7:",name=SLR_S28,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SLT []SLT `hl7:"4,required,display=Sterilization Lot Segment"`
}
Request New Sterilization Lot
A placer application (Sterilizer) sends a transaction with this trigger event to a filler application (Instrument-tracking system) to request that a new sterilization lot be added. If it is successful, the filler application returns an application acknowledgment (if requested under the enhanced acknowledgment mode, or if the original acknowledgment mode is in use).
type SLR_S29 ¶
type SLR_S29 struct {
HL7 HL7Name `hl7:",name=SLR_S29,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SLT []SLT `hl7:"4,required,display=Sterilization Lot Segment"`
}
Request Sterilization Lot Deletion
A request sterilization lot deletion is sent by the placer application to the filler application to request that a lot that had been created in error be removed from the system. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. If it is successful, an application acknowledgment is returned.
type SLT ¶
type SLT struct {
HL7 HL7Name `hl7:",name=SLT,type=s"`
DeviceNumber *EI `hl7:"1,len=8,display=Device Number"`
DeviceName ST `hl7:"2,len=999,display=Device Name"`
LotNumber *EI `hl7:"3,len=11,display=Lot Number"`
ItemIdentifier *EI `hl7:"4,len=250,display=Item Identifier"`
BarCode ST `hl7:"5,len=30,display=Bar Code"`
}
Sterilization Lot Segment
The SLT segment defines requests, responses, and notifications of sterilization lots and supply item descriptions. This message may be used for CPD (Central Supply) and OR (Sub-sterile area outside of an Operating Room) mode.
type SMD_S32 ¶
type SMD_S32 struct {
HL7 HL7Name `hl7:",name=SMD_S32,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
AntiMicrobialDeviceCycleData []SMD_S32_AntiMicrobialDeviceCycleData `hl7:",required,display=Anti Microbial Device Cycle Data"`
}
Request Anti-Microbial Device Cycle Data
This trigger event is sent by the placer application to the filler application to request anti-microbial device cycle data created during the decontamination/sterilization of medical supplies. In the context of this message segment, the term 'device' refers to a sterilizer or a washer. Sterilizers perform a sterilization process and washers perform a decontamination process.
type SMD_S32_AntiMicrobialDeviceCycleData ¶
type SMD_S32_AntiMicrobialDeviceCycleData struct {
HL7 HL7Name `hl7:",name=SMD_S32_AntiMicrobialDeviceCycleData,type=tg"`
SDD *SDD `hl7:"4,required,display=Sterilization Device Data"`
SCD []SCD `hl7:"5,display=Anti-Microbial Cycle Data"`
}
AntiMicrobialDeviceCycleData
type SN ¶
type SN struct {
HL7 HL7Name `hl7:",name=SN,len=36,type=d"`
Comparator ST `` /* 180-byte string literal not displayed */
Num1 NM `hl7:"2,len=15,display=A number."`
SeparatorSuffix ST `hl7:"3,len=1,display='-' or '+' or '/' or '.' or ':'"`
Num2 NM `hl7:"4,len=15,display=A number or null depending on the measurement."`
}
Structured Numeric
The structured numeric data type is used to unambiguously express numeric clinical results along with qualifications. This enables receiving systems to store the components separately, and facilitates the use of numeric database queries. The corresponding sets of values indicated with the <comparator> and <separator/suffix> components are intended to be the authoritative and complete set of values. If additional values are needed for the <comparator> and <separator/suffix> components, they should be submitted to HL7 for inclusion in the Standard.
type SPD ¶
type SPD struct {
HL7 HL7Name `hl7:",name=SPD,len=112,type=d"`
SpecialtyName ST `hl7:"1,required,len=50,display=Identifies the providers specialty."`
GoverningBoard ST `hl7:"2,len=50,display=Identifies the governing body providing for the specialty."`
EligibleOrCertified ID `` /* 133-byte string literal not displayed */
DateOfCertification DT `hl7:"4,len=8,format=YMD,display=Specifies when certification occurred."`
}
Specialty Description
This data type specifies the practitioners specialty and related information.
type SPM ¶
type SPM struct {
HL7 HL7Name `hl7:",name=SPM,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - SPM"`
SpecimenID *EIP `hl7:"2,len=855,display=Specimen ID"`
SpecimenParentIDs []EIP `hl7:"3,len=855,display=Specimen Parent IDs"`
SpecimenType CWE `hl7:"4,required,len=705,table=0487,display=Specimen Type"`
SpecimenTypeModifier []CWE `hl7:"5,len=705,table=0541,display=Specimen Type Modifier"`
SpecimenAdditives []CWE `hl7:"6,len=705,table=0371,display=Specimen Additives"`
SpecimenCollectionMethod *CWE `hl7:"7,len=705,table=0488,display=Specimen Collection Method"`
SpecimenSourceSite *CWE `hl7:"8,len=705,display=Specimen Source Site"`
SpecimenSourceSiteModifier []CWE `hl7:"9,len=705,table=0542,display=Specimen Source Site Modifier"`
SpecimenCollectionSite *CWE `hl7:"10,len=705,table=0543,display=Specimen Collection Site"`
SpecimenRole []CWE `hl7:"11,len=705,table=0369,display=Specimen Role"`
SpecimenCollectionAmount *CQ `hl7:"12,len=20,display=Specimen Collection Amount"`
GroupedSpecimenCount NM `hl7:"13,conditional,len=6,display=Grouped Specimen Count"`
SpecimenDescription []ST `hl7:"14,len=250,display=Specimen Description"`
SpecimenHandlingCode []CWE `hl7:"15,len=705,table=0376,display=Specimen Handling Code"`
SpecimenRiskCode []CWE `hl7:"16,len=705,table=0489,display=Specimen Risk Code"`
SpecimenCollectionDateTime *DR `hl7:"17,len=49,display=Specimen Collection Date/Time"`
SpecimenReceivedDateTime DTM `hl7:"18,len=24,format=YMDHM,display=Specimen Received Date/Time"`
SpecimenExpirationDateTime DTM `hl7:"19,len=24,format=YMDHM,display=Specimen Expiration Date/Time"`
SpecimenAvailability ID `hl7:"20,len=1,table=0136,display=Specimen Availability"`
SpecimenRejectReason []CWE `hl7:"21,len=705,table=0490,display=Specimen Reject Reason"`
SpecimenQuality *CWE `hl7:"22,len=705,table=0491,display=Specimen Quality"`
SpecimenAppropriateness *CWE `hl7:"23,len=705,table=0492,display=Specimen Appropriateness"`
SpecimenCondition []CWE `hl7:"24,len=705,table=0493,display=Specimen Condition"`
SpecimenCurrentQuantity *CQ `hl7:"25,len=722,display=Specimen Current Quantity"`
NumberOfSpecimenContainers NM `hl7:"26,len=4,display=Number of Specimen Containers"`
ContainerType *CWE `hl7:"27,len=705,display=Container Type"`
ContainerCondition *CWE `hl7:"28,len=705,table=0544,display=Container Condition"`
SpecimenChildRole *CWE `hl7:"29,len=705,table=0494,display=Specimen Child Role"`
}
Specimen
The intent of this segment is to describe the characteristics of a specimen. It differs from the intent of the OBR in that the OBR addresses order-specific information. It differs from the SAC segment in that the SAC addresses specimen container attributes. An advantage afforded by a separate specimen segment is that it generalizes the multiple relationships among order(s), results, specimen(s) and specimen container(s).
type SPQ_Q08 ¶
type SPQ_Q08 struct {
HL7 HL7Name `hl7:",name=SPQ_Q08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
SPR *SPR `hl7:"3,required,display=Stored Procedure Request Definition"`
RDF *RDF `hl7:"4,display=Table Row Definition"`
DSC *DSC `hl7:"5,display=Continuation Pointer"`
}
Stored Procedure Request
This section is retained for backward compatibility as of V2.4.
The Stored Procedure Query provides a mechanism for the querying system to invoke a stored procedure on the responding system. The request includes a stored procedure name and a list of parameters passed to it.
The SPQ enables an application on one system to execute a stored procedure on another system, which is coded to extract specific data.
type SPR ¶
type SPR struct {
HL7 HL7Name `hl7:",name=SPR,type=s"`
QueryTag ST `hl7:"1,len=32,display=Query Tag"`
QueryResponseFormatCode ID `hl7:"2,required,len=1,table=0106,display=Query/Response Format Code"`
StoredProcedureName CE `hl7:"3,required,len=250,display=Stored Procedure Name"`
InputParameterList []QIP `hl7:"4,len=256,display=Input Parameter List"`
}
Stored Procedure Request Definition
The SPR segment is used to issue queries using stored procedure calls. Refer to the functional chapters for the lists of HL7-defined stored procedure names, input parameters and output tables.
type SPS ¶
type SPS struct {
HL7 HL7Name `hl7:",name=SPS,len=4436,type=d"`
SpecimenSourceNameOrCode *CWE `` /* 222-byte string literal not displayed */
Additives *CWE `` /* 289-byte string literal not displayed */
SpecimenCollectionMethod TX `` /* 233-byte string literal not displayed */
BodySite *CWE `` /* 224-byte string literal not displayed */
SiteModifier *CWE `` /* 198-byte string literal not displayed */
CollectionMethodModifierCode *CWE `` /* 227-byte string literal not displayed */
SpecimenRole *CWE `` /* 293-byte string literal not displayed */
}
Specimen Source
This data type identifies the site where the specimen should be obtained or where the service should be performed.
type SQM_S25 ¶
type SQM_S25 struct {
HL7 HL7Name `hl7:",name=SQM_S25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
QRD *QRD `hl7:"2,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"3,display=Original style query filter"`
Request *SQM_S25_Request `hl7:",display=Request"`
DSC *DSC `hl7:"16,display=Continuation Pointer"`
}
Schedule Query
Retained for backwards compatibility only in version 2.4 and later.
Original Mode record-oriented query transactions are initiated from the querying application using the Schedule Query (SQM) to request information about a filler application's schedule(s). The filler application responds to these requests, using the Schedule Query Response (SQR) message to either return the requested information, or to signal that an interfacing error of some kind has occurred.
type SQM_S25_GeneralResource ¶
type SQM_S25_GeneralResource struct {
HL7 HL7Name `hl7:",name=SQM_S25_GeneralResource,type=tg"`
AIG *AIG `hl7:"10,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"11,display=Appointment Preferences"`
}
GeneralResource
type SQM_S25_LocationResource ¶
type SQM_S25_LocationResource struct {
HL7 HL7Name `hl7:",name=SQM_S25_LocationResource,type=tg"`
AIL *AIL `hl7:"14,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
}
LocationResource
type SQM_S25_PersonnelResource ¶
type SQM_S25_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SQM_S25_PersonnelResource,type=tg"`
AIP *AIP `hl7:"12,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"13,display=Appointment Preferences"`
}
PersonnelResource
type SQM_S25_Request ¶
type SQM_S25_Request struct {
HL7 HL7Name `hl7:",name=SQM_S25_Request,type=tg"`
ARQ *ARQ `hl7:"4,required,display=Appointment Request"`
APR *APR `hl7:"5,display=Appointment Preferences"`
PID *PID `hl7:"6,display=Patient Identification"`
Resources []SQM_S25_Resources `hl7:",required,display=Resources"`
}
Request
type SQM_S25_Resources ¶
type SQM_S25_Resources struct {
HL7 HL7Name `hl7:",name=SQM_S25_Resources,type=tg"`
RGS *RGS `hl7:"7,required,display=Resource Group"`
Service []SQM_S25_Service `hl7:",display=Service"`
GeneralResource []SQM_S25_GeneralResource `hl7:",display=General Resource"`
PersonnelResource []SQM_S25_PersonnelResource `hl7:",display=Personnel Resource"`
LocationResource []SQM_S25_LocationResource `hl7:",display=Location Resource"`
}
Resources
type SQM_S25_Service ¶
type SQM_S25_Service struct {
HL7 HL7Name `hl7:",name=SQM_S25_Service,type=tg"`
AIS *AIS `hl7:"8,required,display=Appointment Information"`
APR *APR `hl7:"9,display=Appointment Preferences"`
}
Service
type SQR_S25 ¶
type SQR_S25 struct {
HL7 HL7Name `hl7:",name=SQR_S25,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
QAK *QAK `hl7:"4,required,display=Query Acknowledgment"`
Schedule []SQR_S25_Schedule `hl7:",display=Schedule"`
DSC *DSC `hl7:"21,display=Continuation Pointer"`
}
Schedule Response
Retained for backwards compatibility only in version 2.4 and later.
Original Mode record-oriented query transactions are initiated from the querying application using the Schedule Query (SQM) to request information about a filler application's schedule(s). The filler application responds to these requests, using the Schedule Query Response (SQR) message to either return the requested information, or to signal that an interfacing error of some kind has occurred.
type SQR_S25_GeneralResource ¶
type SQR_S25_GeneralResource struct {
HL7 HL7Name `hl7:",name=SQR_S25_GeneralResource,type=tg"`
AIG *AIG `hl7:"15,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SQR_S25_LocationResource ¶
type SQR_S25_LocationResource struct {
HL7 HL7Name `hl7:",name=SQR_S25_LocationResource,type=tg"`
AIL *AIL `hl7:"19,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"20,display=Notes and Comments"`
}
LocationResource
type SQR_S25_Patient ¶
type SQR_S25_Patient struct {
HL7 HL7Name `hl7:",name=SQR_S25_Patient,type=tg"`
PID *PID `hl7:"8,required,display=Patient Identification"`
PV1 *PV1 `hl7:"9,display=Patient Visit"`
PV2 *PV2 `hl7:"10,display=Patient Visit - Additional Information"`
DG1 *DG1 `hl7:"11,display=Diagnosis"`
}
Patient
type SQR_S25_PersonnelResource ¶
type SQR_S25_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SQR_S25_PersonnelResource,type=tg"`
AIP *AIP `hl7:"17,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"18,display=Notes and Comments"`
}
PersonnelResource
type SQR_S25_Resources ¶
type SQR_S25_Resources struct {
HL7 HL7Name `hl7:",name=SQR_S25_Resources,type=tg"`
RGS *RGS `hl7:"12,required,display=Resource Group"`
Service []SQR_S25_Service `hl7:",display=Service"`
GeneralResource []SQR_S25_GeneralResource `hl7:",display=General Resource"`
PersonnelResource []SQR_S25_PersonnelResource `hl7:",display=Personnel Resource"`
LocationResource []SQR_S25_LocationResource `hl7:",display=Location Resource"`
}
Resources
type SQR_S25_Schedule ¶
type SQR_S25_Schedule struct {
HL7 HL7Name `hl7:",name=SQR_S25_Schedule,type=tg"`
SCH *SCH `hl7:"5,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"6,display=Timing/Quantity"`
NTE []NTE `hl7:"7,display=Notes and Comments"`
Patient *SQR_S25_Patient `hl7:",display=Patient"`
Resources []SQR_S25_Resources `hl7:",required,display=Resources"`
}
Schedule
type SQR_S25_Service ¶
type SQR_S25_Service struct {
HL7 HL7Name `hl7:",name=SQR_S25_Service,type=tg"`
AIS *AIS `hl7:"13,required,display=Appointment Information"`
NTE []NTE `hl7:"14,display=Notes and Comments"`
}
Service
type SRM_S01 ¶
type SRM_S01 struct {
HL7 HL7Name `hl7:",name=SRM_S01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S01_Patient `hl7:",display=Patient"`
Resources []SRM_S01_Resources `hl7:",required,display=Resources"`
}
Request new appointment booking
A placer application sends a transaction with this trigger event to a filler application to request that a new appointment be booked. If it is successful, the filler application returns an application acknowledgment (if requested under the enhanced acknowledgment mode, or if the original acknowledgment mode is in use). The acknowledgment may optionally contain an SCH segment and related detail segments describing the actual appointment that was booked.
type SRM_S01_GeneralResource ¶
type SRM_S01_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S01_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S01_LocationResource ¶
type SRM_S01_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S01_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S01_Patient ¶
type SRM_S01_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S01_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S01_PersonnelResource ¶
type SRM_S01_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S01_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S01_Resources ¶
type SRM_S01_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S01_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S01_Service `hl7:",display=Service"`
GeneralResource []SRM_S01_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S01_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S01_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S01_Service ¶
type SRM_S01_Service struct {
HL7 HL7Name `hl7:",name=SRM_S01_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S02 ¶
type SRM_S02 struct {
HL7 HL7Name `hl7:",name=SRM_S02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S02_Patient `hl7:",display=Patient"`
Resources []SRM_S02_Resources `hl7:",required,display=Resources"`
}
Request Appointment Rescheduling
A placer application uses this trigger event to request that an existing appointment be rescheduled. The new Requested Start Date and Time, Appointment Duration, Repeating Interval, Repeating Interval Duration, and/or Priority are provided in the ARQ segment, along with the existing placer and filler identification numbers. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the new information for the rescheduled appointment.
This transaction should not be used to reschedule an appointment that has begun but has not been completed. In such cases, and only if it is logical to do so, the appointment should be discontinued and a new schedule request should be submitted. Likewise, this transaction should not be used to reschedule a parent appointment, in which one or more children have begun or have already occurred. Again, the parent appointment should be discontinued, and a new schedule request should be made. This procedure removes any ambiguity between applications that may arise with an attempt to modify an appointment that is in progress
type SRM_S02_GeneralResource ¶
type SRM_S02_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S02_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S02_LocationResource ¶
type SRM_S02_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S02_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S02_Patient ¶
type SRM_S02_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S02_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S02_PersonnelResource ¶
type SRM_S02_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S02_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S02_Resources ¶
type SRM_S02_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S02_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S02_Service `hl7:",display=Service"`
GeneralResource []SRM_S02_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S02_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S02_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S02_Service ¶
type SRM_S02_Service struct {
HL7 HL7Name `hl7:",name=SRM_S02_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S03 ¶
type SRM_S03 struct {
HL7 HL7Name `hl7:",name=SRM_S03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S03_Patient `hl7:",display=Patient"`
Resources []SRM_S03_Resources `hl7:",required,display=Resources"`
}
Request Appointment Modification
This message transmits a request for modification of an existing appointment to a filler application. This trigger event is used to request the modification of information on an existing appointment, outside of the need to reschedule, cancel, discontinue or delete the appointment, or to add, modify, cancel, discontinue, or delete services and/or resources on the appointment. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the new information for the modified appointment.
type SRM_S03_GeneralResource ¶
type SRM_S03_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S03_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S03_LocationResource ¶
type SRM_S03_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S03_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S03_Patient ¶
type SRM_S03_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S03_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S03_PersonnelResource ¶
type SRM_S03_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S03_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S03_Resources ¶
type SRM_S03_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S03_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S03_Service `hl7:",display=Service"`
GeneralResource []SRM_S03_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S03_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S03_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S03_Service ¶
type SRM_S03_Service struct {
HL7 HL7Name `hl7:",name=SRM_S03_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S04 ¶
type SRM_S04 struct {
HL7 HL7Name `hl7:",name=SRM_S04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S04_Patient `hl7:",display=Patient"`
Resources []SRM_S04_Resources `hl7:",required,display=Resources"`
}
Request Appointment Cancellation
The request appointment cancellation trigger event is sent by the placer application to the filler application to request that an existing appointment be canceled. A cancel event is used to stop a valid appointment from occurring. For example, if a patient scheduled for an exam cancels his/her appointment, then a request to cancel the appointment is sent. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the canceled appointment.
This trigger event can be used to cancel a parent appointment, in which none of the children of the appointment have either begun or have been completed. Any child appointments that exist on the filler and placer applications should be considered canceled. If one or more child appointments have begun or have been completed, then this trigger event should not be used. Instead, the S05 (request appointment discontinuation) event should be used.
type SRM_S04_GeneralResource ¶
type SRM_S04_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S04_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S04_LocationResource ¶
type SRM_S04_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S04_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S04_Patient ¶
type SRM_S04_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S04_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S04_PersonnelResource ¶
type SRM_S04_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S04_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S04_Resources ¶
type SRM_S04_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S04_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S04_Service `hl7:",display=Service"`
GeneralResource []SRM_S04_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S04_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S04_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S04_Service ¶
type SRM_S04_Service struct {
HL7 HL7Name `hl7:",name=SRM_S04_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S05 ¶
type SRM_S05 struct {
HL7 HL7Name `hl7:",name=SRM_S05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S05_Patient `hl7:",display=Patient"`
Resources []SRM_S05_Resources `hl7:",required,display=Resources"`
}
Request Appointment Discontinuation
The request appointment discontinuation is sent by the placer application to the filler application to request that an appointment in progress be stopped, or that the remaining occurrences of a parent appointment not occur as scheduled. If none of the child appointments of a parent appointment have occurred, then a cancel trigger event should be sent instead. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the discontinued appointment.
type SRM_S05_GeneralResource ¶
type SRM_S05_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S05_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S05_LocationResource ¶
type SRM_S05_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S05_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S05_Patient ¶
type SRM_S05_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S05_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S05_PersonnelResource ¶
type SRM_S05_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S05_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S05_Resources ¶
type SRM_S05_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S05_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S05_Service `hl7:",display=Service"`
GeneralResource []SRM_S05_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S05_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S05_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S05_Service ¶
type SRM_S05_Service struct {
HL7 HL7Name `hl7:",name=SRM_S05_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S06 ¶
type SRM_S06 struct {
HL7 HL7Name `hl7:",name=SRM_S06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S06_Patient `hl7:",display=Patient"`
Resources []SRM_S06_Resources `hl7:",required,display=Resources"`
}
Request Appointment Deletion
A request appointment deletion is sent by the placer application to the filler application to request that an appointment that had been entered in error be removed from the system. A delete trigger event should only be used when an appointment has been erroneously requested, and must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. This trigger event should not be used for any appointment that has already begun, or has already been completed. Likewise, it should not be used on any parent appointment if any child appointments have either begun or been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the deleted appointment.
The delete trigger event should be implemented with careful forethought, as it typically has different effects and repercussions in various applications. In some applications, a delete event cannot be undone. This means that if a delete transaction was sent erroneously, recovery will be difficult or impossible. In other applications, a delete transaction will not result in the physical deletion of the record(s), but will set a status or a flag. In these cases, the filler and/or placer appointment identifiers (the numbers or codes that uniquely identify the scheduled appointment or request to the placer and filler applications) probably cannot be reused. Since these applications maintain a record of deleted appointments, the reuse of an identifier will likely cause a conflict in the applications' processing of transactions.
type SRM_S06_GeneralResource ¶
type SRM_S06_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S06_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S06_LocationResource ¶
type SRM_S06_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S06_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S06_Patient ¶
type SRM_S06_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S06_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S06_PersonnelResource ¶
type SRM_S06_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S06_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S06_Resources ¶
type SRM_S06_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S06_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S06_Service `hl7:",display=Service"`
GeneralResource []SRM_S06_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S06_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S06_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S06_Service ¶
type SRM_S06_Service struct {
HL7 HL7Name `hl7:",name=SRM_S06_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S07 ¶
type SRM_S07 struct {
HL7 HL7Name `hl7:",name=SRM_S07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S07_Patient `hl7:",display=Patient"`
Resources []SRM_S07_Resources `hl7:",required,display=Resources"`
}
Request Addition of Service/Resource on Appointment
The request addition of service/resource is triggered by the placer application to request that a new service or resource be added to an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment.
type SRM_S07_GeneralResource ¶
type SRM_S07_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S07_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S07_LocationResource ¶
type SRM_S07_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S07_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S07_Patient ¶
type SRM_S07_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S07_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S07_PersonnelResource ¶
type SRM_S07_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S07_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S07_Resources ¶
type SRM_S07_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S07_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S07_Service `hl7:",display=Service"`
GeneralResource []SRM_S07_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S07_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S07_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S07_Service ¶
type SRM_S07_Service struct {
HL7 HL7Name `hl7:",name=SRM_S07_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S08 ¶
type SRM_S08 struct {
HL7 HL7Name `hl7:",name=SRM_S08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S08_Patient `hl7:",display=Patient"`
Resources []SRM_S08_Resources `hl7:",required,display=Resources"`
}
Request Modification of Service/Resource on Appointment
The request modification of service/resource is triggered on the placer application to request that information pertaining to an existing service or resource be changed for an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment.
This trigger event should not be used when an existing resource or service must be replaced or rescheduled for an existing appointment. The following fields on the indicated segments should not be changed by this trigger event: the first three fields of the AIS, the first four fields of the AIG, the first four fields of the AIL, and the first four fields of the AIP. Instead, use two trigger events to accomplish the replacement or rescheduling of a service or resource: S09 (request cancellation of service/resource on appointment), as well as S07 (request addition of service/resource on appointment).
type SRM_S08_GeneralResource ¶
type SRM_S08_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S08_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S08_LocationResource ¶
type SRM_S08_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S08_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S08_Patient ¶
type SRM_S08_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S08_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S08_PersonnelResource ¶
type SRM_S08_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S08_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S08_Resources ¶
type SRM_S08_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S08_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S08_Service `hl7:",display=Service"`
GeneralResource []SRM_S08_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S08_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S08_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S08_Service ¶
type SRM_S08_Service struct {
HL7 HL7Name `hl7:",name=SRM_S08_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S09 ¶
type SRM_S09 struct {
HL7 HL7Name `hl7:",name=SRM_S09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S09_Patient `hl7:",display=Patient"`
Resources []SRM_S09_Resources `hl7:",required,display=Resources"`
}
Request Cancellation of Service/Resource on Appointment
This trigger event requests that a service or resource be removed from an existing scheduled appointment that has not yet begun. A cancel event is used to stop a valid service or resource from participating in the appointment. For example, if a portable X-ray machine scheduled for an exam is no longer needed, then the placer application requests that the resource be canceled on the filler application. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment.
type SRM_S09_GeneralResource ¶
type SRM_S09_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S09_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S09_LocationResource ¶
type SRM_S09_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S09_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S09_Patient ¶
type SRM_S09_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S09_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S09_PersonnelResource ¶
type SRM_S09_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S09_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S09_Resources ¶
type SRM_S09_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S09_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S09_Service `hl7:",display=Service"`
GeneralResource []SRM_S09_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S09_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S09_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S09_Service ¶
type SRM_S09_Service struct {
HL7 HL7Name `hl7:",name=SRM_S09_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S10 ¶
type SRM_S10 struct {
HL7 HL7Name `hl7:",name=SRM_S10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S10_Patient `hl7:",display=Patient"`
Resources []SRM_S10_Resources `hl7:",required,display=Resources"`
}
Request Discontinuation of Service/Resource on Appointment
A request discontinuation of service/resource is sent by the placer application to the filler application when the remaining occurrences of a recurring appointment no longer require a particular service or resource. In other words, this trigger event is sent to request that the performance of a service or resource in a recurring appointment that has already begun be stopped. If the first appointment in a set of recurring appointments has not yet occurred, then a cancel trigger event should be sent instead. This trigger event should only be used on appointments that have not been completed, or on parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment.
type SRM_S10_GeneralResource ¶
type SRM_S10_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S10_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S10_LocationResource ¶
type SRM_S10_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S10_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S10_Patient ¶
type SRM_S10_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S10_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S10_PersonnelResource ¶
type SRM_S10_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S10_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S10_Resources ¶
type SRM_S10_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S10_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S10_Service `hl7:",display=Service"`
GeneralResource []SRM_S10_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S10_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S10_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S10_Service ¶
type SRM_S10_Service struct {
HL7 HL7Name `hl7:",name=SRM_S10_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRM_S11 ¶
type SRM_S11 struct {
HL7 HL7Name `hl7:",name=SRM_S11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
ARQ *ARQ `hl7:"2,required,display=Appointment Request"`
APR *APR `hl7:"3,display=Appointment Preferences"`
NTE []NTE `hl7:"4,display=Notes and Comments"`
Patient []SRM_S11_Patient `hl7:",display=Patient"`
Resources []SRM_S11_Resources `hl7:",required,display=Resources"`
}
Request Deletion of Service/Resource on Appointment
A request deletion of service/resource is sent by the placer application to the filler application to request that a scheduled appointment requiring a service or resource entered in error be removed from the system. A delete trigger event should only be used when a service or resource has been erroneously attached to an appointment, and must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. This trigger event should only be used on appointments that have not been completed, or on parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment.
type SRM_S11_GeneralResource ¶
type SRM_S11_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRM_S11_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
APR *APR `hl7:"15,display=Appointment Preferences"`
NTE []NTE `hl7:"16,display=Notes and Comments"`
}
GeneralResource
type SRM_S11_LocationResource ¶
type SRM_S11_LocationResource struct {
HL7 HL7Name `hl7:",name=SRM_S11_LocationResource,type=tg"`
AIL *AIL `hl7:"17,required,display=Appointment Information - Location Resource"`
APR *APR `hl7:"18,display=Appointment Preferences"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
LocationResource
type SRM_S11_Patient ¶
type SRM_S11_Patient struct {
HL7 HL7Name `hl7:",name=SRM_S11_Patient,type=tg"`
PID *PID `hl7:"5,required,display=Patient Identification"`
PV1 *PV1 `hl7:"6,display=Patient Visit"`
PV2 *PV2 `hl7:"7,display=Patient Visit - Additional Information"`
OBX []OBX `hl7:"8,display=Observation/Result"`
DG1 []DG1 `hl7:"9,display=Diagnosis"`
}
Patient
type SRM_S11_PersonnelResource ¶
type SRM_S11_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRM_S11_PersonnelResource,type=tg"`
AIP *AIP `hl7:"20,required,display=Appointment Information - Personnel Resource"`
APR *APR `hl7:"21,display=Appointment Preferences"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
PersonnelResource
type SRM_S11_Resources ¶
type SRM_S11_Resources struct {
HL7 HL7Name `hl7:",name=SRM_S11_Resources,type=tg"`
RGS *RGS `hl7:"10,required,display=Resource Group"`
Service []SRM_S11_Service `hl7:",display=Service"`
GeneralResource []SRM_S11_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRM_S11_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRM_S11_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRM_S11_Service ¶
type SRM_S11_Service struct {
HL7 HL7Name `hl7:",name=SRM_S11_Service,type=tg"`
AIS *AIS `hl7:"11,required,display=Appointment Information"`
APR *APR `hl7:"12,display=Appointment Preferences"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S01 ¶
type SRR_S01 struct {
HL7 HL7Name `hl7:",name=SRR_S01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S01_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request New Appointment Booking
A placer application sends a transaction with this trigger event to a filler application to request that a new appointment be booked. If it is successful, the filler application returns an application acknowledgment (if requested under the enhanced acknowledgment mode, or if the original acknowledgment mode is in use). The acknowledgment may optionally contain an SCH segment and related detail segments describing the actual appointment that was booked
type SRR_S01_GeneralResource ¶
type SRR_S01_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S01_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S01_LocationResource ¶
type SRR_S01_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S01_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S01_Patient ¶
type SRR_S01_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S01_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S01_PersonnelResource ¶
type SRR_S01_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S01_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S01_Resources ¶
type SRR_S01_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S01_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S01_Service `hl7:",display=Service"`
GeneralResource []SRR_S01_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S01_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S01_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S01_Schedule ¶
type SRR_S01_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S01_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S01_Patient `hl7:",display=Patient"`
Resources []SRR_S01_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S01_Service ¶
type SRR_S01_Service struct {
HL7 HL7Name `hl7:",name=SRR_S01_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S02 ¶
type SRR_S02 struct {
HL7 HL7Name `hl7:",name=SRR_S02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S02_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Appointment Rescheduling
A placer application uses this trigger event to request that an existing appointment be rescheduled. The new Requested Start Date and Time, Appointment Duration, Repeating Interval, Repeating Interval Duration, and/or Priority are provided in the ARQ segment, along with the existing placer and filler identification numbers. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the new information for the rescheduled appointment
type SRR_S02_GeneralResource ¶
type SRR_S02_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S02_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S02_LocationResource ¶
type SRR_S02_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S02_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S02_Patient ¶
type SRR_S02_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S02_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S02_PersonnelResource ¶
type SRR_S02_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S02_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S02_Resources ¶
type SRR_S02_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S02_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S02_Service `hl7:",display=Service"`
GeneralResource []SRR_S02_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S02_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S02_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S02_Schedule ¶
type SRR_S02_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S02_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S02_Patient `hl7:",display=Patient"`
Resources []SRR_S02_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S02_Service ¶
type SRR_S02_Service struct {
HL7 HL7Name `hl7:",name=SRR_S02_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S03 ¶
type SRR_S03 struct {
HL7 HL7Name `hl7:",name=SRR_S03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S03_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Appointment Modification
This message transmits a request for modification of an existing appointment to a filler application. This trigger event is used to request the modification of information on an existing appointment, outside of the need to reschedule, cancel, discontinue or delete the appointment, or to add, modify, cancel, discontinue, or delete services and/or resources on the appointment. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the new information for the modified appointment
type SRR_S03_GeneralResource ¶
type SRR_S03_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S03_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S03_LocationResource ¶
type SRR_S03_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S03_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S03_Patient ¶
type SRR_S03_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S03_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S03_PersonnelResource ¶
type SRR_S03_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S03_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S03_Resources ¶
type SRR_S03_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S03_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S03_Service `hl7:",display=Service"`
GeneralResource []SRR_S03_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S03_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S03_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S03_Schedule ¶
type SRR_S03_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S03_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S03_Patient `hl7:",display=Patient"`
Resources []SRR_S03_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S03_Service ¶
type SRR_S03_Service struct {
HL7 HL7Name `hl7:",name=SRR_S03_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S04 ¶
type SRR_S04 struct {
HL7 HL7Name `hl7:",name=SRR_S04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S04_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Appointment Cancellation
The request appointment cancellation trigger event is sent by the placer application to the filler application to request that an existing appointment be canceled. A cancel event is used to stop a valid appointment from occurring. For example, if a patient scheduled for an exam cancels his/her appointment, then a request to cancel the appointment is sent. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the canceled appointment
type SRR_S04_GeneralResource ¶
type SRR_S04_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S04_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S04_LocationResource ¶
type SRR_S04_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S04_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S04_Patient ¶
type SRR_S04_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S04_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S04_PersonnelResource ¶
type SRR_S04_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S04_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S04_Resources ¶
type SRR_S04_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S04_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S04_Service `hl7:",display=Service"`
GeneralResource []SRR_S04_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S04_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S04_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S04_Schedule ¶
type SRR_S04_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S04_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S04_Patient `hl7:",display=Patient"`
Resources []SRR_S04_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S04_Service ¶
type SRR_S04_Service struct {
HL7 HL7Name `hl7:",name=SRR_S04_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S05 ¶
type SRR_S05 struct {
HL7 HL7Name `hl7:",name=SRR_S05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S05_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Appointment Discontinuation
The request appointment discontinuation is sent by the placer application to the filler application to request that an appointment in progress be stopped, or that the remaining occurrences of a parent appointment not occur as scheduled. If none of the child appointments of a parent appointment have occurred, then a cancel trigger event should be sent instead. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the discontinued appointment
type SRR_S05_GeneralResource ¶
type SRR_S05_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S05_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S05_LocationResource ¶
type SRR_S05_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S05_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S05_Patient ¶
type SRR_S05_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S05_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S05_PersonnelResource ¶
type SRR_S05_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S05_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S05_Resources ¶
type SRR_S05_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S05_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S05_Service `hl7:",display=Service"`
GeneralResource []SRR_S05_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S05_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S05_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S05_Schedule ¶
type SRR_S05_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S05_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S05_Patient `hl7:",display=Patient"`
Resources []SRR_S05_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S05_Service ¶
type SRR_S05_Service struct {
HL7 HL7Name `hl7:",name=SRR_S05_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S06 ¶
type SRR_S06 struct {
HL7 HL7Name `hl7:",name=SRR_S06,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S06_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Appointment Deletion
A request appointment deletion is sent by the placer application to the filler application to request that an appointment that had been entered in error be removed from the system. A delete trigger event should only be used when an appointment has been erroneously requested, and must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. This trigger event should not be used for any appointment that has already begun, or has already been completed. Likewise, it should not be used on any parent appointment if any child appointments have either begun or been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the deleted appointment
type SRR_S06_GeneralResource ¶
type SRR_S06_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S06_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S06_LocationResource ¶
type SRR_S06_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S06_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S06_Patient ¶
type SRR_S06_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S06_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S06_PersonnelResource ¶
type SRR_S06_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S06_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S06_Resources ¶
type SRR_S06_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S06_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S06_Service `hl7:",display=Service"`
GeneralResource []SRR_S06_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S06_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S06_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S06_Schedule ¶
type SRR_S06_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S06_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S06_Patient `hl7:",display=Patient"`
Resources []SRR_S06_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S06_Service ¶
type SRR_S06_Service struct {
HL7 HL7Name `hl7:",name=SRR_S06_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S07 ¶
type SRR_S07 struct {
HL7 HL7Name `hl7:",name=SRR_S07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S07_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Addition of Service/Resource on Appointment
The request addition of service/resource is triggered by the placer application to request that a new service or resource be added to an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment
type SRR_S07_GeneralResource ¶
type SRR_S07_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S07_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S07_LocationResource ¶
type SRR_S07_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S07_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S07_Patient ¶
type SRR_S07_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S07_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S07_PersonnelResource ¶
type SRR_S07_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S07_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S07_Resources ¶
type SRR_S07_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S07_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S07_Service `hl7:",display=Service"`
GeneralResource []SRR_S07_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S07_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S07_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S07_Schedule ¶
type SRR_S07_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S07_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S07_Patient `hl7:",display=Patient"`
Resources []SRR_S07_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S07_Service ¶
type SRR_S07_Service struct {
HL7 HL7Name `hl7:",name=SRR_S07_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S08 ¶
type SRR_S08 struct {
HL7 HL7Name `hl7:",name=SRR_S08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S08_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Modification of Service/Resource on Appointment
The request modification of service/resource is triggered on the placer application to request that information pertaining to an existing service or resource be changed for an existing appointment. Services and resources are represented by the AIS, AIG, AIL, and AIP segments on an HL7 scheduling interface transaction. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment
type SRR_S08_GeneralResource ¶
type SRR_S08_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S08_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S08_LocationResource ¶
type SRR_S08_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S08_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S08_Patient ¶
type SRR_S08_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S08_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S08_PersonnelResource ¶
type SRR_S08_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S08_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S08_Resources ¶
type SRR_S08_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S08_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S08_Service `hl7:",display=Service"`
GeneralResource []SRR_S08_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S08_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S08_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S08_Schedule ¶
type SRR_S08_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S08_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S08_Patient `hl7:",display=Patient"`
Resources []SRR_S08_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S08_Service ¶
type SRR_S08_Service struct {
HL7 HL7Name `hl7:",name=SRR_S08_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S09 ¶
type SRR_S09 struct {
HL7 HL7Name `hl7:",name=SRR_S09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S09_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Cancellation of Service/Resource on Appointment
This trigger event requests that a service or resource be removed from an existing scheduled appointment that has not yet begun. A cancel event is used to stop a valid service or resource from participating in the appointment. For example, if a portable X-ray machine scheduled for an exam is no longer needed, then the placer application requests that the resource be canceled on the filler application. This trigger event should only be used for appointments that have not been completed, or for parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment
type SRR_S09_GeneralResource ¶
type SRR_S09_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S09_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S09_LocationResource ¶
type SRR_S09_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S09_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S09_Patient ¶
type SRR_S09_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S09_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S09_PersonnelResource ¶
type SRR_S09_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S09_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S09_Resources ¶
type SRR_S09_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S09_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S09_Service `hl7:",display=Service"`
GeneralResource []SRR_S09_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S09_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S09_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S09_Schedule ¶
type SRR_S09_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S09_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S09_Patient `hl7:",display=Patient"`
Resources []SRR_S09_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S09_Service ¶
type SRR_S09_Service struct {
HL7 HL7Name `hl7:",name=SRR_S09_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S10 ¶
type SRR_S10 struct {
HL7 HL7Name `hl7:",name=SRR_S10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S10_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Discontinuation of Service/Resource on Appointment
A request discontinuation of service/resource is sent by the placer application to the filler application when the remaining occurrences of a recurring appointment no longer require a particular service or resource. In other words, this trigger event is sent to request that the performance of a service or resource in a recurring appointment that has already begun be stopped. If the first appointment in a set of recurring appointments has not yet occurred, then a cancel trigger event should be sent instead. This trigger event should only be used on appointments that have not been completed, or on parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment
type SRR_S10_GeneralResource ¶
type SRR_S10_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S10_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S10_LocationResource ¶
type SRR_S10_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S10_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S10_Patient ¶
type SRR_S10_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S10_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S10_PersonnelResource ¶
type SRR_S10_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S10_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S10_Resources ¶
type SRR_S10_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S10_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S10_Service `hl7:",display=Service"`
GeneralResource []SRR_S10_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S10_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S10_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S10_Schedule ¶
type SRR_S10_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S10_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S10_Patient `hl7:",display=Patient"`
Resources []SRR_S10_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S10_Service ¶
type SRR_S10_Service struct {
HL7 HL7Name `hl7:",name=SRR_S10_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRR_S11 ¶
type SRR_S11 struct {
HL7 HL7Name `hl7:",name=SRR_S11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
ERR []ERR `hl7:"3,display=Error"`
Schedule *SRR_S11_Schedule `hl7:",display=Schedule"`
}
Scheduled Request Response - Request Deletion of Service/Resource on Appointment
A request deletion of service/resource is sent by the placer application to the filler application to request that a scheduled appointment requiring a service or resource entered in error be removed from the system. A delete trigger event should only be used when a service or resource has been erroneously attached to an appointment, and must be removed from the schedule so that it does not affect any statistical processing. A delete trigger event differs from a cancel trigger event in that a delete acts to remove an error, whereas a cancel acts to prevent a valid request from occurring. This trigger event should only be used on appointments that have not been completed, or on parent appointments whose children have not been completed. If it is successful, an application acknowledgment is returned, optionally containing an SCH segment and related detail segments describing the modified appointment
type SRR_S11_GeneralResource ¶
type SRR_S11_GeneralResource struct {
HL7 HL7Name `hl7:",name=SRR_S11_GeneralResource,type=tg"`
AIG *AIG `hl7:"14,required,display=Appointment Information - General Resource"`
NTE []NTE `hl7:"15,display=Notes and Comments"`
}
GeneralResource
type SRR_S11_LocationResource ¶
type SRR_S11_LocationResource struct {
HL7 HL7Name `hl7:",name=SRR_S11_LocationResource,type=tg"`
AIL *AIL `hl7:"16,required,display=Appointment Information - Location Resource"`
NTE []NTE `hl7:"17,display=Notes and Comments"`
}
LocationResource
type SRR_S11_Patient ¶
type SRR_S11_Patient struct {
HL7 HL7Name `hl7:",name=SRR_S11_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PV1 *PV1 `hl7:"8,display=Patient Visit"`
PV2 *PV2 `hl7:"9,display=Patient Visit - Additional Information"`
DG1 []DG1 `hl7:"10,display=Diagnosis"`
}
Patient
type SRR_S11_PersonnelResource ¶
type SRR_S11_PersonnelResource struct {
HL7 HL7Name `hl7:",name=SRR_S11_PersonnelResource,type=tg"`
AIP *AIP `hl7:"18,required,display=Appointment Information - Personnel Resource"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
PersonnelResource
type SRR_S11_Resources ¶
type SRR_S11_Resources struct {
HL7 HL7Name `hl7:",name=SRR_S11_Resources,type=tg"`
RGS *RGS `hl7:"11,required,display=Resource Group"`
Service []SRR_S11_Service `hl7:",display=Service"`
GeneralResource []SRR_S11_GeneralResource `hl7:",display=General Resource"`
LocationResource []SRR_S11_LocationResource `hl7:",display=Location Resource"`
PersonnelResource []SRR_S11_PersonnelResource `hl7:",display=Personnel Resource"`
}
Resources
type SRR_S11_Schedule ¶
type SRR_S11_Schedule struct {
HL7 HL7Name `hl7:",name=SRR_S11_Schedule,type=tg"`
SCH *SCH `hl7:"4,required,display=Scheduling Activity Information"`
TQ1 []TQ1 `hl7:"5,display=Timing/Quantity"`
NTE []NTE `hl7:"6,display=Notes and Comments"`
Patient []SRR_S11_Patient `hl7:",display=Patient"`
Resources []SRR_S11_Resources `hl7:",required,display=Resources"`
}
Schedule
type SRR_S11_Service ¶
type SRR_S11_Service struct {
HL7 HL7Name `hl7:",name=SRR_S11_Service,type=tg"`
AIS *AIS `hl7:"12,required,display=Appointment Information"`
NTE []NTE `hl7:"13,display=Notes and Comments"`
}
Service
type SRT ¶
type SRT struct {
HL7 HL7Name `hl7:",name=SRT,len=15,type=d"`
SortByField ST `` /* 341-byte string literal not displayed */
Sequencing ID `` /* 218-byte string literal not displayed */
}
Sort Order
Specifies those parameters by which the response will be sorted and by what method.
type SSR_U04 ¶
type SSR_U04 struct {
HL7 HL7Name `hl7:",name=SSR_U04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
SpecimenContainer []SSR_U04_SpecimenContainer `hl7:",required,display=Specimen Container"`
ROL *ROL `hl7:"7,display=Role"`
}
Specimen Status Update
This message is used to request information concerning the location and status of specimens from one application to another (e.g., Laboratory Automation System to automated equipment). The request can be addressed for a specific container, a specific carrier, a specific tray or a specific location, depending on the arguments set in the SAC segment. The equipment specified in the EQU segment should respond with the "Specimen Status Update."
type SSR_U04_SpecimenContainer ¶
type SSR_U04_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=SSR_U04_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"5,required,display=Specimen Container Detail"`
SPM []SPM `hl7:"6,display=Specimen"`
}
SpecimenContainer
type SSU_U03 ¶
type SSU_U03 struct {
HL7 HL7Name `hl7:",name=SSU_U03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
SpecimenContainer []SSU_U03_SpecimenContainer `hl7:",required,display=Specimen Container"`
ROL *ROL `hl7:"9,display=Role"`
}
Specimen Status Update
This message is used to send information concerning the location and status of specimens from one application to another (e.g., automated equipment to a Laboratory Automation System). The OBX segments attached to the SAC should be used for transfer of information not included in the SAC segment.
type SSU_U03_Specimen ¶
type SSU_U03_Specimen struct {
HL7 HL7Name `hl7:",name=SSU_U03_Specimen,type=tg"`
SPM *SPM `hl7:"7,required,display=Specimen"`
OBX []OBX `hl7:"8,display=Observation/Result"`
}
Specimen
type SSU_U03_SpecimenContainer ¶
type SSU_U03_SpecimenContainer struct {
HL7 HL7Name `hl7:",name=SSU_U03_SpecimenContainer,type=tg"`
SAC *SAC `hl7:"5,required,display=Specimen Container Detail"`
OBX []OBX `hl7:"6,display=Observation/Result"`
Specimen []SSU_U03_Specimen `hl7:",display=Specimen"`
}
SpecimenContainer
type ST ¶
type ST = string
String Data
The String data type is used for text data when the appearance of text does not bear meaning. This is true for formalized text, symbols and formal expressions, and all kinds of names intended for machine processing (e.g., sorting, querying, indexing, etc.)
type STC_S33 ¶
type STC_S33 struct {
HL7 HL7Name `hl7:",name=STC_S33,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SCP []SCP `hl7:"4,required,display=Sterilizer Configuration"`
}
Notification of Sterilization Configuration
This message is sent from a filler application to notify other applications of a new sterilization configuration. The information in the STC segment describes the detail of the new sterilization configuration
type STF ¶
type STF struct {
HL7 HL7Name `hl7:",name=STF,type=s"`
PrimaryKeyValue *CWE `hl7:"1,conditional,len=250,display=Primary Key Value - STF"`
StaffIdentifierList []CX `hl7:"2,len=250,display=Staff Identifier List"`
StaffName []XPN `hl7:"3,len=250,display=Staff Name"`
StaffType []IS `hl7:"4,len=2,table=0182,display=Staff Type"`
AdministrativeSex IS `hl7:"5,len=1,table=0001,display=Administrative Sex"`
DateTimeOfBirth DTM `hl7:"6,len=24,format=YMDHM,display=Date/Time of Birth"`
ActiveInactiveFlag ID `hl7:"7,len=1,table=0183,display=Active/Inactive Flag"`
Department []CWE `hl7:"8,len=250,table=0184,display=Department"`
HospitalService []CWE `hl7:"9,len=250,table=0069,display=Hospital Service - STF"`
Phone []XTN `hl7:"10,len=250,display=Phone"`
OfficeHomeAddressBirthplace []XAD `hl7:"11,len=250,display=Office/Home Address/Birthplace"`
InstitutionActivationDate []DIN `hl7:"12,len=276,display=Institution Activation Date"`
InstitutionInactivationDate []DIN `hl7:"13,len=276,display=Institution Inactivation Date"`
BackupPersonID []CWE `hl7:"14,len=250,display=Backup Person ID"`
EMailAddress []ST `hl7:"15,len=40,display=E-Mail Address"`
PreferredMethodOfContact *CWE `hl7:"16,len=705,table=0185,display=Preferred Method of Contact"`
MaritalStatus *CWE `hl7:"17,len=705,table=0002,display=Marital Status"`
JobTitle ST `hl7:"18,len=20,display=Job Title"`
JobCodeClass *JCC `hl7:"19,len=20,display=Job Code/Class"`
EmploymentStatusCode *CWE `hl7:"20,len=250,table=0066,display=Employment Status Code"`
AdditionalInsuredOnAuto ID `hl7:"21,len=1,table=0136,display=Additional Insured on Auto"`
DriversLicenseNumberStaff *DLN `hl7:"22,len=25,display=Driver's License Number - Staff"`
CopyAutoIns ID `hl7:"23,len=1,table=0136,display=Copy Auto Ins"`
AutoInsExpires DT `hl7:"24,len=8,format=YMD,display=Auto Ins. Expires"`
DateLastDMVReview DT `hl7:"25,len=8,format=YMD,display=Date Last DMV Review"`
DateNextDMVReview DT `hl7:"26,len=8,format=YMD,display=Date Next DMV Review"`
Race *CWE `hl7:"27,len=705,table=0005,display=Race"`
EthnicGroup *CWE `hl7:"28,len=705,table=0189,display=Ethnic Group"`
ReActivationApprovalIndicator ID `hl7:"29,len=1,table=0136,display=Re-activation Approval Indicator"`
Citizenship []CWE `hl7:"30,len=705,table=0171,display=Citizenship"`
DateTimeOfDeath DTM `hl7:"31,len=8,format=YMDHM,display=Date/Time of Death"`
DeathIndicator ID `hl7:"32,len=1,table=0136,display=Death Indicator"`
InstitutionRelationshipTypeCode *CWE `hl7:"33,len=250,table=0538,display=Institution Relationship Type Code"`
InstitutionRelationshipPeriod *DR `hl7:"34,len=52,display=Institution Relationship Period"`
ExpectedReturnDate DT `hl7:"35,len=8,format=YMD,display=Expected Return Date"`
CostCenterCode []CWE `hl7:"36,len=250,table=0539,display=Cost Center Code"`
GenericClassificationIndicator ID `hl7:"37,len=1,table=0136,display=Generic Classification Indicator"`
InactiveReasonCode *CWE `hl7:"38,len=250,table=0540,display=Inactive Reason Code"`
GenericResourceTypeOrCategory []CWE `hl7:"39,len=1,table=0771,display=Generic resource type or category"`
}
Staff Identification
The Technical Steward for the STF segment is PA and Personnel Management.
The STF segment can identify any personnel referenced by information systems. These can be providers, staff, system users, and referring agents. In a network environment, this segment can be used to define personnel to other applications, for example, order entry clerks, insurance verification clerks, admission clerks, as well as provider demographics. When using the STF and PRA segments in the Staff/Practitioner Master File message, MFE-4-primary key value is used to link all the segments pertaining to the same master file entry. Therefore, in the MFE segment, MFE-4-primary key value must be filled in. Other segments may follow the STF segment to provide data for a particular type of staff member. The PRA segment (practitioner) is one such. It may optionally follow the STF segment in order to add practitioner-specific data. Other segments may be defined as needed. When using the segments included in this chapter for other then Staff/Practitioner Master File messages, disregard references to MFE-4 - primary key value.
type STI_S30 ¶
type STI_S30 struct {
HL7 HL7Name `hl7:",name=STI_S30,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
SLT []SLT `hl7:"4,required,display=Sterilization Lot Segment"`
}
Request Item
A request item is sent by the placer application to the filler application to request the ID and description of an item to be sterilized or decontaminated. If it is successful, the filler application returns an application acknowledgment (if requested under the enhanced acknowledgment mode, or if the original acknowledgment mode is in use).
type STZ ¶
type STZ struct {
HL7 HL7Name `hl7:",name=STZ,type=s"`
SterilizationType *CWE `hl7:"1,len=250,table=0806,display=Sterilization Type"`
SterilizationCycle *CWE `hl7:"2,len=250,display=Sterilization Cycle"`
MaintenanceCycle *CWE `hl7:"3,len=250,table=0809,display=Maintenance Cycle"`
MaintenanceType *CWE `hl7:"4,len=250,table=0811,display=Maintenance Type"`
}
Sterilization Parameter
The STZ segment contains sterilization-specific attributes of a supply item.
type SUR_P09 ¶
type SUR_P09 struct {
HL7 HL7Name `hl7:",name=SUR_P09,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
Facility []SUR_P09_Facility `hl7:",required,display=Facility"`
}
Summary Product Experience Report
This message and event is deprecated for v2.5.
Sending summary reports related to products constitutes a P09 event.
Note from the Caristix team: We have not included the invalid ED segment in this message.
type SUR_P09_Facility ¶
type SUR_P09_Facility struct {
HL7 HL7Name `hl7:",name=SUR_P09_Facility,type=tg"`
FAC *FAC `hl7:"2,required,display=Facility"`
Product []SUR_P09_Product `hl7:",required,display=Product"`
PSH *PSH `hl7:"5,required,display=Product Summary Header"`
FacilityDetail []SUR_P09_FacilityDetail `hl7:",required,display=Facility Detail"`
}
Facility
type SUR_P09_FacilityDetail ¶
type SUR_P09_FacilityDetail struct {
HL7 HL7Name `hl7:",name=SUR_P09_FacilityDetail,type=tg"`
FAC *FAC `hl7:"6,required,display=Facility"`
PDC *PDC `hl7:"7,required,display=Product Detail Country"`
NTE *NTE `hl7:"8,required,display=Notes and Comments"`
}
FacilityDetail
type SUR_P09_Product ¶
type SUR_P09_Product struct {
HL7 HL7Name `hl7:",name=SUR_P09_Product,type=tg"`
PSH *PSH `hl7:"3,required,display=Product Summary Header"`
PDC *PDC `hl7:"4,required,display=Product Detail Country"`
}
Product
type TBR_R08 ¶
type TBR_R08 struct {
HL7 HL7Name `hl7:",name=TBR_R08,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
MSA *MSA `hl7:"3,required,display=Message Acknowledgment"`
ERR *ERR `hl7:"4,display=Error"`
QAK *QAK `hl7:"5,required,display=Query Acknowledgment"`
RDF *RDF `hl7:"6,required,display=Table Row Definition"`
RDT []RDT `hl7:"7,required,display=Table Row Data"`
DSC *DSC `hl7:"8,display=Continuation Pointer"`
}
Tabular Data Response
This section is retained for backward compatibility as of V2.4.
type TCC ¶
type TCC struct {
HL7 HL7Name `hl7:",name=TCC,type=s"`
UniversalServiceIdentifier CWE `hl7:"1,required,len=705,display=Universal Service Identifier"`
EquipmentTestApplicationIdentifier EI `hl7:"2,required,len=427,display=Equipment Test Application Identifier"`
SpecimenSource SPS `hl7:"3,len=300,display=Specimen Source"`
AutoDilutionFactorDefault *SN `hl7:"4,len=36,display=Auto-Dilution Factor Default"`
RerunDilutionFactorDefault *SN `hl7:"5,len=36,display=Rerun Dilution Factor Default"`
PreDilutionFactorDefault *SN `hl7:"6,len=36,display=Pre-Dilution Factor Default"`
EndogenousContentOfPreDilutionDiluent *SN `hl7:"7,len=36,display=Endogenous Content of Pre-Dilution Diluent"`
InventoryLimitsWarningLevel NM `hl7:"8,len=10,display=Inventory Limits Warning Level"`
AutomaticRerunAllowed ID `hl7:"9,len=1,table=0136,display=Automatic Rerun Allowed"`
AutomaticRepeatAllowed ID `hl7:"10,len=1,table=0136,display=Automatic Repeat Allowed"`
AutomaticReflexAllowed ID `hl7:"11,len=1,table=0136,display=Automatic Reflex Allowed"`
EquipmentDynamicRange *SN `hl7:"12,len=36,display=Equipment Dynamic Range"`
Units *CWE `hl7:"13,len=705,display=Units"`
ProcessingType *CWE `hl7:"14,len=705,table=0388,display=Processing Type"`
}
Test Code Configuration
The test (e.g., analyte) code configuration segment is the data necessary to maintain and transmit information concerning the test entity codes that are being used throughout the "automated system."
type TCD ¶
type TCD struct {
HL7 HL7Name `hl7:",name=TCD,type=s"`
UniversalServiceIdentifier CWE `hl7:"1,required,len=705,display=Universal Service Identifier"`
AutoDilutionFactor *SN `hl7:"2,len=36,display=Auto-Dilution Factor"`
RerunDilutionFactor *SN `hl7:"3,len=36,display=Rerun Dilution Factor"`
PreDilutionFactor *SN `hl7:"4,len=36,display=Pre-Dilution Factor"`
EndogenousContentOfPreDilutionDiluent *SN `hl7:"5,len=36,display=Endogenous Content of Pre-Dilution Diluent"`
AutomaticRepeatAllowed ID `hl7:"6,len=1,table=0136,display=Automatic Repeat Allowed"`
ReflexAllowed ID `hl7:"7,len=1,table=0136,display=Reflex Allowed"`
AnalyteRepeatStatus *CWE `hl7:"8,len=705,table=0389,display=Analyte Repeat Status"`
}
Test Code Detail
The test code detail segment contains the data necessary to perform operations or calculations, or execute decisions by the laboratory automation system, and which are not supported by the original HL7 segments related to orders (ORC, OBR). For detail of use see messages of laboratory orders and observations in chapters 4 and 7.
type TCR_U11 ¶
type TCR_U11 struct {
HL7 HL7Name `hl7:",name=TCR_U11,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
TestConfiguration []TCR_U11_TestConfiguration `hl7:",required,display=Test Configuration"`
ROL *ROL `hl7:"7,display=Role"`
}
Automated Equipment Test Code Settings Request
This message is used to request information concerning test codes from one application to another (e.g., Laboratory Automation System to automated equipment).
type TCR_U11_TestConfiguration ¶
type TCR_U11_TestConfiguration struct {
HL7 HL7Name `hl7:",name=TCR_U11_TestConfiguration,type=tg"`
SPM *SPM `hl7:"5,display=Specimen"`
TCC []TCC `hl7:"6,required,display=Test Code Configuration"`
}
TestConfiguration
type TCU_U10 ¶
type TCU_U10 struct {
HL7 HL7Name `hl7:",name=TCU_U10,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
EQU *EQU `hl7:"4,required,display=Equipment Detail"`
TestConfiguration []TCU_U10_TestConfiguration `hl7:",required,display=Test Configuration"`
ROL *ROL `hl7:"7,display=Role"`
}
Automated Equipment Test Code Settings Update
This message is used to send information concerning test codes and parameters from one application to another (e.g., automated equipment to a Laboratory Automation System). This message transfers the current snapshot of the test parameters of the sending system. The sent parameter sets are supposed to replace the parameter sets existing at the receiver of this message before the trigger (there is no selective "Add" or "Delete").
type TCU_U10_TestConfiguration ¶
type TCU_U10_TestConfiguration struct {
HL7 HL7Name `hl7:",name=TCU_U10_TestConfiguration,type=tg"`
SPM *SPM `hl7:"5,display=Specimen"`
TCC []TCC `hl7:"6,required,display=Test Code Configuration"`
}
TestConfiguration
type TM ¶
Time
Specifies the hour of the day with optional minutes, seconds, fraction of second using a 24-hour clock notation and time zone.
type TQ ¶
type TQ struct {
HL7 HL7Name `hl7:",name=TQ,len=1763,type=d"`
Quantity *CQ `` /* 411-byte string literal not displayed */
Interval *RI `hl7:"2,len=206,display=Determines the interval between repeated services."`
Duration ST `` /* 180-byte string literal not displayed */
StartDateTime DTM `` /* 355-byte string literal not displayed */
EndDateTime DTM `` /* 418-byte string literal not displayed */
Priority ST `hl7:"6,len=6,display=This component describes the urgency of the request."`
Condition ST `` /* 328-byte string literal not displayed */
Text TX `hl7:"8,len=200,display=This component is a full text version of the instruction (optional)."`
Conjunction ID `` /* 203-byte string literal not displayed */
OrderSequencing *OSD `` /* 847-byte string literal not displayed */
OccurrenceDuration *CWE `` /* 213-byte string literal not displayed */
TotalOccurrences NM `` /* 390-byte string literal not displayed */
}
Timing Quantity
Describes when a service should be performed and how frequently.
type TQ1 ¶
type TQ1 struct {
HL7 HL7Name `hl7:",name=TQ1,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - TQ1"`
Quantity *CQ `hl7:"2,len=20,display=Quantity"`
RepeatPattern []RPT `hl7:"3,len=540,display=Repeat Pattern"`
ExplicitTime []TM `hl7:"4,len=20,format=HM,display=Explicit Time"`
RelativeTimeAndUnits []CQ `hl7:"5,len=20,display=Relative Time and Units"`
ServiceDuration *CQ `hl7:"6,len=20,display=Service Duration"`
StartDateTime DTM `hl7:"7,len=24,format=YMDHM,display=Start date/time"`
EndDateTime DTM `hl7:"8,len=24,format=YMDHM,display=End date/time"`
Priority []CWE `hl7:"9,len=250,table=0485,display=Priority"`
ConditionText TX `hl7:"10,len=250,display=Condition text"`
TextInstruction TX `hl7:"11,len=250,display=Text instruction"`
Conjunction ID `hl7:"12,conditional,len=10,table=0472,display=Conjunction"`
OccurrenceDuration *CQ `hl7:"13,len=20,display=Occurrence duration"`
TotalOccurrences NM `hl7:"14,len=10,display=Total occurrences"`
}
Timing/Quantity
The TQ1 segment is used to specify the complex timing of events and actions such as those that occur in order management and scheduling systems. This segment determines the quantity, frequency, priority and timing of a service. By allowing the segment to repeat, it is possible to have service requests that vary the quantity, frequency and priority of a service request over time.
type TQ2 ¶
type TQ2 struct {
HL7 HL7Name `hl7:",name=TQ2,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - TQ2"`
SequenceResultsFlag ID `hl7:"2,len=1,table=0503,display=Sequence/Results Flag"`
RelatedPlacerNumber []EI `hl7:"3,conditional,len=22,display=Related Placer Number"`
RelatedFillerNumber []EI `hl7:"4,conditional,len=22,display=Related Filler Number"`
RelatedPlacerGroupNumber []EI `hl7:"5,conditional,len=22,display=Related Placer Group Number"`
SequenceConditionCode ID `hl7:"6,conditional,len=2,table=0504,display=Sequence Condition Code"`
CyclicEntryExitIndicator ID `hl7:"7,conditional,len=1,table=0505,display=Cyclic Entry/Exit Indicator"`
SequenceConditionTimeInterval *CQ `hl7:"8,len=20,display=Sequence Condition Time Interval"`
CyclicGroupMaximumNumberOfRepeats NM `hl7:"9,len=10,display=Cyclic Group Maximum Number of Repeats"`
SpecialServiceRequestRelationship ID `hl7:"10,conditional,len=1,table=0506,display=Special Service Request Relationship"`
}
Timing/Quantity Relationship
The TQ2 segment is used to form a relationship between the service request the TQ1/TQ2 segments are associated with, and other service requests. The TQ2 segment will link the current service request with one or more other service requests.
type TX ¶
type TX = string
Text Data
String data meant for user display (on a terminal or printer). Such data would not necessarily be left justified since leading spaces may contribute greatly to the clarity of the presentation to the user. Because this type of data is intended for display, it may contain certain escape character sequences designed to control the display. Escape sequence formatting is defined in Section 2.7, "Use of escape sequences in text fields ". Leading spaces should be included. Trailing spaces should be removed.
type TXA ¶
type TXA struct {
HL7 HL7Name `hl7:",name=TXA,type=s"`
SetID SI `hl7:"1,seq,required,len=4,display=Set ID- TXA"`
DocumentType IS `hl7:"2,required,len=30,table=0270,display=Document Type"`
DocumentContentPresentation ID `hl7:"3,conditional,len=2,table=0191,display=Document Content Presentation"`
ActivityDateTime DTM `hl7:"4,len=24,format=YMDHM,display=Activity Date/Time"`
PrimaryActivityProviderCodeName []XCN `hl7:"5,conditional,len=250,display=Primary Activity Provider Code/Name"`
OriginationDateTime DTM `hl7:"6,len=24,format=YMDHM,display=Origination Date/Time"`
TranscriptionDateTime DTM `hl7:"7,conditional,len=24,format=YMDHM,display=Transcription Date/Time"`
EditDateTime []DTM `hl7:"8,len=24,format=YMDHM,display=Edit Date/Time"`
OriginatorCodeName []XCN `hl7:"9,len=250,display=Originator Code/Name"`
AssignedDocumentAuthenticator []XCN `hl7:"10,len=250,display=Assigned Document Authenticator"`
TranscriptionistCodeName []XCN `hl7:"11,conditional,len=250,display=Transcriptionist Code/Name"`
UniqueDocumentNumber EI `hl7:"12,required,len=427,display=Unique Document Number"`
ParentDocumentNumber *EI `hl7:"13,conditional,len=427,display=Parent Document Number"`
PlacerOrderNumber []EI `hl7:"14,len=427,display=Placer Order Number"`
FillerOrderNumber *EI `hl7:"15,len=427,display=Filler Order Number"`
UniqueDocumentFileName ST `hl7:"16,len=30,display=Unique Document File Name"`
DocumentCompletionStatus ID `hl7:"17,required,len=2,table=0271,display=Document Completion Status"`
DocumentConfidentialityStatus ID `hl7:"18,len=2,table=0272,display=Document Confidentiality Status"`
DocumentAvailabilityStatus ID `hl7:"19,len=2,table=0273,display=Document Availability Status"`
DocumentStorageStatus ID `hl7:"20,len=2,table=0275,display=Document Storage Status"`
DocumentChangeReason ST `hl7:"21,conditional,len=30,display=Document Change Reason"`
AuthenticationPersonTimeStampSet []PPN `hl7:"22,conditional,len=250,display=Authentication Person- Time Stamp (set)"`
DistributedCopiesCodeAndNameOfRecipientsS []XCN `hl7:"23,len=250,display=Distributed Copies (Code and Name of Recipients(s) )"`
}
Transcription Document Header
The TXA segment contains information specific to a transcribed document but does not include the text of the document. The message is created as a result of a document status change. This information updates other healthcare systems and allows them to identify reports that are available in the transcription system. By maintaining the TXA message information in these systems, the information is available when constructing queries to the transcription system requesting the full document text.
type UAC ¶
type UAC struct {
HL7 HL7Name `hl7:",name=UAC,type=s"`
UserAuthenticationCredentialTypeCode CWE `hl7:"1,required,len=705,table=0615,display=User Authentication Credential Type Code"`
UserAuthenticationCredential ED `hl7:"2,required,len=65536,display=User Authentication Credential"`
}
User Authentication Credential
This optional segment provides user authentication credentials, a Kerberos Service Ticket or SAML assertion, to be used by the receiving system to obtain user identification data. Refer to HL7 Table 0615 - User Authentication Credential Type Code . It is to be used in when the receiving application system requires the sending system to provide end-user identification for accountability or access control in interactive applications. Since user authentication implementations often limit the time period for validity of the session authentication credentials, this segment is not intended for use in non-interactive applications.
Note: The UAC segment is defined for use within simple protocols, such as MLLP, that do not have user authentication semantics. Implementations that use WSDL/SOAP, or similar protocols, to envelope HL7 should employ the user authentication semantics and data structures available within the scope of those protocols rather than the UAC segment.
type UB1 ¶
type UB1 struct {
HL7 HL7Name `hl7:",name=UB1,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - UB1"`
BloodDeductible ST `hl7:"2,display=Blood Deductible"`
BloodFurnishedPints NM `hl7:"3,len=2,display=Blood Furnished-Pints"`
BloodReplacedPints NM `hl7:"4,len=2,display=Blood Replaced-Pints"`
BloodNotReplacedPints NM `hl7:"5,len=2,display=Blood Not Replaced-Pints"`
CoInsuranceDays NM `hl7:"6,len=2,display=Co-Insurance Days"`
ConditionCode []IS `hl7:"7,max=5,len=14,table=0043,display=Condition Code"`
CoveredDays NM `hl7:"8,len=3,display=Covered Days"`
NonCoveredDays NM `hl7:"9,len=3,display=Non Covered Days"`
ValueAmountCode []UVC `hl7:"10,max=8,len=41,display=Value Amount & Code"`
NumberOfGraceDays NM `hl7:"11,len=2,display=Number Of Grace Days"`
SpecialProgramIndicator *CWE `hl7:"12,len=250,table=0348,display=Special Program Indicator"`
PSROURApprovalIndicator *CWE `hl7:"13,len=250,table=0349,display=PSRO/UR Approval Indicator"`
PSROURApprovedStayFm DT `hl7:"14,len=8,format=YMD,display=PSRO/UR Approved Stay-Fm"`
PSROURApprovedStayTo DT `hl7:"15,len=8,format=YMD,display=PSRO/UR Approved Stay-To"`
Occurrence []OCD `hl7:"16,max=5,len=259,display=Occurrence"`
OccurrenceSpan CWE `hl7:"17,len=250,table=0351,display=Occurrence Span"`
OccurSpanStartDate DT `hl7:"18,len=8,format=YMD,display=Occur Span Start Date"`
OccurSpanEndDate DT `hl7:"19,len=8,format=YMD,display=Occur Span End Date"`
UB82Locator2 ST `hl7:"20,len=30,display=UB-82 Locator 2"`
UB82Locator9 ST `hl7:"21,len=7,display=UB-82 Locator 9"`
UB82Locator27 ST `hl7:"22,len=8,display=UB-82 Locator 27"`
UB82Locator45 ST `hl7:"23,len=17,display=UB-82 Locator 45"`
}
Uniform Billing 1
The UB1 segment contains data specific to the United States; other realms may choose to implement using regional code sets. Only billing/claims fields that do not exist in other HL7 defined segments appear in this segment. The codes listed as examples are not an exhaustive or current list.
Prior to V2.6, this segment was published as a UB-82 specific segment, but has been widely implemented for usage with UB-82 and/or UB-92 data. With the publication of the UB-92 (in 1992) and the HIPAA requirements in the US (2004), this segment is technically no longer applicable for the UB-82 which is no longer in use. However, the segment is often used internally to message data from a patient registration to a patient accounting system. It has been 'generalized' in V2.6 for wider applicability.
type UB2 ¶
type UB2 struct {
HL7 HL7Name `hl7:",name=UB2,type=s"`
SetID SI `hl7:"1,seq,len=4,display=Set ID - UB2"`
CoInsuranceDays ST `hl7:"2,len=3,display=Co-Insurance Days"`
ConditionCode []IS `hl7:"3,max=7,len=2,table=0043,display=Condition Code"`
CoveredDays ST `hl7:"4,len=3,display=Covered Days"`
NonCoveredDays ST `hl7:"5,len=4,display=Non-Covered Days"`
ValueAmountAndCode []UVC `hl7:"6,max=12,len=41,display=Value Amount and Code"`
OccurrenceCodeAndDate []OCD `hl7:"7,max=8,len=259,display=Occurrence Code and Date"`
OccurrenceSpanCodeDates []OSP `hl7:"8,max=2,len=268,display=Occurrence Span Code/Dates"`
UB92Locator2State []ST `hl7:"9,max=2,len=29,display=UB92 Locator 2 (State)"`
UB92Locator11State []ST `hl7:"10,max=2,len=12,display=UB92 Locator 11 (State)"`
UB92Locator31National ST `hl7:"11,len=5,display=UB92 Locator 31 (National)"`
DocumentControlNumber []ST `hl7:"12,max=3,len=23,display=Document Control Number"`
UB92Locator49National []ST `hl7:"13,max=23,len=4,display=UB92 Locator 49 (National)"`
UB92Locator56State []ST `hl7:"14,max=5,len=14,display=UB92 Locator 56 (State)"`
UB92Locator57National ST `hl7:"15,len=27,display=UB92 Locator 57 (National)"`
UB92Locator78State []ST `hl7:"16,max=2,len=2,display=UB92 Locator 78 (State)"`
SpecialVisitCount NM `hl7:"17,len=3,display=Special Visit Count"`
}
UB92 Data
The UB2 segment contains data necessary to complete UB92 bills specific to the United States; other realms may choose to implement using regional code sets. Only UB92 fields that do not exist in other HL7 defined segments appear in this segment. For example, Patient Name and Date of Birth are required; they are included in the PID segment and therefore do not appear here. UB92 field locators are provided in parentheses ( ). The UB codes listed as examples are not an exhaustive or current list; refer to a UB specification for additional information.
type UDM_Q05 ¶
type UDM_Q05 struct {
HL7 HL7Name `hl7:",name=UDM_Q05,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
URD *URD `hl7:"4,required,display=Results/update Definition"`
URS *URS `hl7:"5,display=Unsolicited Selection"`
DSP []DSP `hl7:"6,required,display=Display Data"`
DSC *DSC `hl7:"7,display=Continuation Pointer"`
}
Unsolicited Display Update
This section is retained for backward compatibility and the framework for the existing functional queries.
The UDM message does not have a direct replacement in the new methodology. It is not clear how extensively this message is used.
There is a simple HL7 message that allows for unsolicited display update messages to be sent in HL7 format from one system to another.
type URD ¶
type URD struct {
HL7 HL7Name `hl7:",name=URD,type=s"`
RUDateTime DTM `hl7:"1,len=24,format=YMDHM,display=R/U Date/Time"`
ReportPriority ID `hl7:"2,len=1,table=0109,display=Report Priority"`
RUWhoSubjectDefinition []XCN `hl7:"3,required,len=250,display=R/U Who Subject Definition"`
RUWhatSubjectDefinition []CWE `hl7:"4,len=250,table=0048,display=R/U What Subject Definition"`
RUWhatDepartmentCode []CWE `hl7:"5,len=250,display=R/U What Department Code"`
RUDisplayPrintLocations []ST `hl7:"6,len=20,display=R/U Display/Print Locations"`
RUResultsLevel ID `hl7:"7,len=1,table=0108,display=R/U Results Level"`
}
Results/update Definition
The URD segment is used in sending unsolicited updates about orders and results. Its purpose is similar to that of the QRD segment, but from the results/unsolicited update point of view. Some of the fields have parallels in the QRD segment.
This segment is retained for backward compatibility only as of V2.4.
type URS ¶
type URS struct {
HL7 HL7Name `hl7:",name=URS,type=s"`
RUWhereSubjectDefinition []ST `hl7:"1,required,len=20,display=R/U Where Subject Definition"`
RUWhenDataStartDateTime DTM `hl7:"2,len=24,format=YMDHM,display=R/U When Data Start Date/Time"`
RUWhenDataEndDateTime DTM `hl7:"3,len=24,format=YMDHM,display=R/U When Data End Date/Time"`
RUWhatUserQualifier []ST `hl7:"4,len=20,display=R/U What User Qualifier"`
RUOtherResultsSubjectDefinition []ST `hl7:"5,len=20,display=R/U Other Results Subject Definition"`
RUWhichDateTimeQualifier []ID `hl7:"6,len=12,table=0156,display=R/U Which Date/Time Qualifier"`
RUWhichDateTimeStatusQualifier []ID `hl7:"7,len=12,table=0157,display=R/U Which Date/Time Status Qualifier"`
RUDateTimeSelectionQualifier []ID `hl7:"8,len=12,table=0158,display=R/U Date/Time Selection Qualifier"`
RUQuantityTimingQualifier TQ `hl7:"9,len=60,display=R/U Quantity/Timing Qualifier"`
}
Unsolicited Selection
This section is retained for backward compatibility only as of V2.4.
The URS segment is identical with the QRF segment, except that if the name of any field contains Query (of QRY), this word has been changed to Results (see URS-5-R/U other results subject definition).
type UVC ¶
type UVC struct {
HL7 HL7Name `hl7:",name=UVC,len=41,type=d"`
ValueCode CNE `hl7:"1,required,len=20,table=0153,display=Specifies the National Uniform Billing Committee (NUBC) code itself."`
ValueAmount *MO `hl7:"2,len=20,display=Specifies the numeric amount when needed to pair with the value."`
}
UB Value Code and Amount
A code structure to relate amounts or values to identified data elements necessary to process this claim as qualified by the payer organization.
type VAR ¶
type VAR struct {
HL7 HL7Name `hl7:",name=VAR,type=s"`
VarianceInstanceID EI `hl7:"1,required,len=60,display=Variance Instance ID"`
DocumentedDateTime DTM `hl7:"2,required,len=24,format=YMDHM,display=Documented Date/Time"`
StatedVarianceDateTime DTM `hl7:"3,len=24,format=YMDHM,display=Stated Variance Date/Time"`
VarianceOriginator []XCN `hl7:"4,len=250,display=Variance Originator"`
VarianceClassification *CWE `hl7:"5,len=705,display=Variance Classification"`
VarianceDescription []ST `hl7:"6,len=512,display=Variance Description"`
}
Variance
The variance segment contains the data necessary to describe differences that may have occurred at the time when a healthcare event was documented.
type VH ¶
type VH struct {
HL7 HL7Name `hl7:",name=VH,len=41,type=d"`
StartDayRange ID `` /* 126-byte string literal not displayed */
EndDayRange ID `` /* 161-byte string literal not displayed */
StartHourRange TM `` /* 142-byte string literal not displayed */
EndHourRange TM `` /* 136-byte string literal not displayed */
}
Visiting Hours
This data type contains the hours when a patient location is open for visiting. Refer to HL7 Table 0267 - Days of the week for valid values for the first two components.
type VID ¶
type VID struct {
HL7 HL7Name `hl7:",name=VID,len=973,type=d"`
VersionID ID `` /* 142-byte string literal not displayed */
InternationalizationCode *CWE `` /* 294-byte string literal not displayed */
InternationalVersionID *CWE `` /* 223-byte string literal not displayed */
}
Version Identifier
type VND ¶
type VND struct {
HL7 HL7Name `hl7:",name=VND,type=s"`
SetID SI `hl7:"1,seq,required,len=2,display=Set Id – VND"`
VendorIdentifier EI `hl7:"2,required,len=250,display=Vendor Identifier"`
VendorName ST `hl7:"3,len=999,display=Vendor Name"`
VendorCatalogNumber *EI `hl7:"4,len=20,display=Vendor Catalog Number"`
PrimaryVendorIndicator *CNE `hl7:"5,len=1,table=0532,display=Primary Vendor Indicator"`
}
Purchasing Vendor
This segment contains purchasing vendors that supply the inventory supply item specified in the ITM segment.
type VQQ_Q07 ¶
type VQQ_Q07 struct {
HL7 HL7Name `hl7:",name=VQQ_Q07,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
VTQ *VTQ `hl7:"3,required,display=Virtual Table Query Request"`
RDF *RDF `hl7:"4,display=Table Row Definition"`
DSC *DSC `hl7:"5,display=Continuation Pointer"`
}
Virtual Table Query
The VTQ provides a way to query for data to be expressed as tables without having to specify SQL or a stored procedure.
The VQQ supports queries against server database table (virtual or actual) based on specific selection criteria delineated in the VTQ segment.
type VR ¶
type VR struct {
HL7 HL7Name `hl7:",name=VR,len=13,type=d"`
FirstDataCodeValue ST `hl7:"1,len=6,display=Specifies the lower bound value."`
LastDataCodeValue ST `hl7:"2,len=6,display=Specifies the upper bound value."`
}
Value Range
This data type contains the lower bound value and upper bound values that constitute a range. Either or both components may be populated.
type VTQ ¶
type VTQ struct {
HL7 HL7Name `hl7:",name=VTQ,type=s"`
QueryTag ST `hl7:"1,len=32,display=Query Tag"`
QueryResponseFormatCode ID `hl7:"2,required,len=1,table=0106,display=Query/Response Format Code"`
VTQueryName CE `hl7:"3,required,len=250,display=VT Query Name"`
VirtualTableName CE `hl7:"4,required,len=250,display=Virtual Table Name"`
SelectionCriteria []QSC `hl7:"5,len=256,display=Selection Criteria"`
}
Virtual Table Query Request
The VTQ segment is used to define queries that are responded to with the Tabular Data Message (TBR). The VTQ query message is an alternate method to the EQQ query message that some systems may find easier to implement, due to its use of HL7 delimiters that separate components of the selection definition, and its limited selection criteria. Queries involving complex selection criteria (nested operators, etc.) may need to be formatted as an EQL segment.
As with the other query methods, the functional chapters define specific queries supported as VTQ messages. Refer to these functional chapters for the lists of HL7-defined Virtual Tables, selection lists and criteria
type VXQ_V01 ¶
type VXQ_V01 struct {
HL7 HL7Name `hl7:",name=VXQ_V01,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
QRD *QRD `hl7:"4,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"5,display=Original style query filter"`
}
Vaccination Record Query
This section is retained for backward compatibility as of V2.4.
When an immunization registry does not already have the complete patient vaccination record, it will send a query (with a V01 event) for the definitive (last updated) record.
type VXR_V03 ¶
type VXR_V03 struct {
HL7 HL7Name `hl7:",name=VXR_V03,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
SFT []SFT `hl7:"3,display=Software Segment"`
UAC *UAC `hl7:"4,display=User Authentication Credential"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
PID *PID `hl7:"7,required,display=Patient Identification"`
PD1 *PD1 `hl7:"8,display=Patient Additional Demographic"`
NK1 []NK1 `hl7:"9,display=Next of Kin / Associated Parties"`
PatientVisit *VXR_V03_PatientVisit `hl7:",display=Patient Visit"`
GT1 []GT1 `hl7:"12,display=Guarantor"`
Insurance []VXR_V03_Insurance `hl7:",display=Insurance"`
Order []VXR_V03_Order `hl7:",display=Order"`
}
Vaccination Record Response
When the patient has been uniquely identified (there is only one "match" to the query), the response to the query (with a V03 event) will follow this format.
Note: The original mode query, including QRD and QRF segments were retained for backward compatibility only as of v 2.4.
type VXR_V03_Insurance ¶
type VXR_V03_Insurance struct {
HL7 HL7Name `hl7:",name=VXR_V03_Insurance,type=tg"`
IN1 *IN1 `hl7:"13,required,display=Insurance"`
IN2 *IN2 `hl7:"14,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"15,display=Insurance Additional Information- Certification"`
}
Insurance
type VXR_V03_Observation ¶
type VXR_V03_Observation struct {
HL7 HL7Name `hl7:",name=VXR_V03_Observation,type=tg"`
OBX *OBX `hl7:"21,required,display=Observation/Result"`
NTE []NTE `hl7:"22,display=Notes and Comments"`
}
Observation
type VXR_V03_Order ¶
type VXR_V03_Order struct {
HL7 HL7Name `hl7:",name=VXR_V03_Order,type=tg"`
ORC *ORC `hl7:"16,required,display=Common Order"`
Timing []VXR_V03_Timing `hl7:",display=Timing"`
RXA *RXA `hl7:"19,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"20,display=Pharmacy/Treatment Route"`
Observation []VXR_V03_Observation `hl7:",display=Observation"`
}
Order
type VXR_V03_PatientVisit ¶
type VXR_V03_PatientVisit struct {
HL7 HL7Name `hl7:",name=VXR_V03_PatientVisit,type=tg"`
PV1 *PV1 `hl7:"10,required,display=Patient Visit"`
PV2 *PV2 `hl7:"11,display=Patient Visit - Additional Information"`
}
PatientVisit
type VXR_V03_Timing ¶
type VXR_V03_Timing struct {
HL7 HL7Name `hl7:",name=VXR_V03_Timing,type=tg"`
TQ1 *TQ1 `hl7:"17,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"18,display=Timing/Quantity Relationship"`
}
Timing
type VXU_V04 ¶
type VXU_V04 struct {
HL7 HL7Name `hl7:",name=VXU_V04,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
SFT []SFT `hl7:"2,display=Software Segment"`
UAC *UAC `hl7:"3,display=User Authentication Credential"`
PID *PID `hl7:"4,required,display=Patient Identification"`
PD1 *PD1 `hl7:"5,display=Patient Additional Demographic"`
NK1 []NK1 `hl7:"6,display=Next of Kin / Associated Parties"`
Patient *VXU_V04_Patient `hl7:",display=Patient"`
GT1 []GT1 `hl7:"9,display=Guarantor"`
Insurance []VXU_V04_Insurance `hl7:",display=Insurance"`
Order []VXU_V04_Order `hl7:",display=Order"`
}
Unsolicited Vaccination Record Update
When a provider wishes to update the patient's vaccination record being held in a registry, he will transmit an unsolicited update of the record (a V04 trigger event).
type VXU_V04_Insurance ¶
type VXU_V04_Insurance struct {
HL7 HL7Name `hl7:",name=VXU_V04_Insurance,type=tg"`
IN1 *IN1 `hl7:"10,required,display=Insurance"`
IN2 *IN2 `hl7:"11,display=Insurance Additional Information"`
IN3 *IN3 `hl7:"12,display=Insurance Additional Information- Certification"`
}
Insurance
type VXU_V04_Observation ¶
type VXU_V04_Observation struct {
HL7 HL7Name `hl7:",name=VXU_V04_Observation,type=tg"`
OBX *OBX `hl7:"18,required,display=Observation/Result"`
NTE []NTE `hl7:"19,display=Notes and Comments"`
}
Observation
type VXU_V04_Order ¶
type VXU_V04_Order struct {
HL7 HL7Name `hl7:",name=VXU_V04_Order,type=tg"`
ORC *ORC `hl7:"13,required,display=Common Order"`
Timing []VXU_V04_Timing `hl7:",display=Timing"`
RXA *RXA `hl7:"16,required,display=Pharmacy/Treatment Administration"`
RXR *RXR `hl7:"17,display=Pharmacy/Treatment Route"`
Observation []VXU_V04_Observation `hl7:",display=Observation"`
}
Order
type VXU_V04_Patient ¶
type VXU_V04_Patient struct {
HL7 HL7Name `hl7:",name=VXU_V04_Patient,type=tg"`
PV1 *PV1 `hl7:"7,required,display=Patient Visit"`
PV2 *PV2 `hl7:"8,display=Patient Visit - Additional Information"`
}
Patient
type VXU_V04_Timing ¶
type VXU_V04_Timing struct {
HL7 HL7Name `hl7:",name=VXU_V04_Timing,type=tg"`
TQ1 *TQ1 `hl7:"14,required,display=Timing/Quantity"`
TQ2 []TQ2 `hl7:"15,display=Timing/Quantity Relationship"`
}
Timing
type VXX_V02 ¶
type VXX_V02 struct {
HL7 HL7Name `hl7:",name=VXX_V02,type=t"`
MSH *MSH `hl7:"1,required,display=Message Header"`
MSA *MSA `hl7:"2,required,display=Message Acknowledgment"`
SFT []SFT `hl7:"3,display=Software Segment"`
UAC *UAC `hl7:"4,display=User Authentication Credential"`
QRD *QRD `hl7:"5,required,display=Original-Style Query Definition"`
QRF *QRF `hl7:"6,display=Original style query filter"`
Patient []VXX_V02_Patient `hl7:",required,display=Patient"`
}
Vaccination Record Query Returning Multiple PID Matches
In response to a query for the definitive patient vaccination record, the registry holding the record will return it to the registry originating the query.
Note: The original mode query, including QRD and QRF segments were retained for backward compatibility only as of v 2.4.
type VXX_V02_Patient ¶
type VXX_V02_Patient struct {
HL7 HL7Name `hl7:",name=VXX_V02_Patient,type=tg"`
PID *PID `hl7:"7,required,display=Patient Identification"`
NK1 []NK1 `hl7:"8,display=Next of Kin / Associated Parties"`
}
Patient
type XAD ¶
type XAD struct {
HL7 HL7Name `hl7:",name=XAD,len=2915,type=d"`
StreetAddress *SAD `` /* 177-byte string literal not displayed */
OtherDesignation ST `` /* 225-byte string literal not displayed */
City ST `` /* 202-byte string literal not displayed */
StateOrProvince ST `` /* 208-byte string literal not displayed */
ZipOrPostalCode ST `` /* 354-byte string literal not displayed */
Country ID `` /* 299-byte string literal not displayed */
AddressType ID `` /* 143-byte string literal not displayed */
OtherGeographicDesignation ST `hl7:"8,len=50,display=This component specifies any other geographic designation. It includes county- bioregion- SMSA- etc."`
CountyParishCode IS `` /* 561-byte string literal not displayed */
CensusTract IS `` /* 240-byte string literal not displayed */
AddressRepresentationCode ID `` /* 254-byte string literal not displayed */
AddressValidityRange DR `` /* 226-byte string literal not displayed */
EffectiveDate DTM `` /* 132-byte string literal not displayed */
ExpirationDate DTM `` /* 131-byte string literal not displayed */
ExpirationReason *CWE `hl7:"15,len=705,table=0616,display=This identifies why this address was marked as 'ended'."`
TemporaryIndicator ID `` /* 142-byte string literal not displayed */
BadAddressIndicator ID `` /* 172-byte string literal not displayed */
AddressUsage ID `hl7:"18,len=44,table=0617,display=This indicates how the address is intended to be used."`
Addressee ST `` /* 168-byte string literal not displayed */
Comment ST `hl7:"20,len=199,display=Descriptive information about the use of the address."`
PreferenceOrder NM `` /* 158-byte string literal not displayed */
ProtectionCode *CWE `hl7:"22,len=705,table=0618,display=Identifies that an address needs to be treated with special care or sensitivity."`
AddressIdentifier *EI `hl7:"23,len=427,display=A unique identifier for the address."`
}
Extended Address
This data type specifies the address of a person, place or organization plus associated information.
type XCN ¶
type XCN struct {
HL7 HL7Name `hl7:",name=XCN,len=3220,type=d"`
IDNumber ST `` /* 224-byte string literal not displayed */
FamilyName FN `` /* 417-byte string literal not displayed */
GivenName ST `hl7:"3,len=30,table=FirstName,display=First name."`
SecondAndFurtherGivenNamesOrInitialsThereof ST `hl7:"4,len=30,display=Multiple middle names may be included by separating them with spaces."`
Suffix ST `hl7:"5,len=20,display=Used to specify a name suffix (e.g.- Jr. or III)."`
Prefix ST `hl7:"6,len=20,display=Used to specify a name prefix (e.g.- Dr.)."`
Degree IS `` /* 238-byte string literal not displayed */
SourceTable IS `` /* 211-byte string literal not displayed */
AssigningAuthority *HD `` /* 338-byte string literal not displayed */
NameTypeCode ID `` /* 175-byte string literal not displayed */
IdentifierCheckDigit ST `` /* 264-byte string literal not displayed */
CheckDigitScheme ID `hl7:"12,conditional,len=3,table=0061,display=Contains the code identifying the check digit scheme employed."`
IdentifierTypeCode ID `` /* 237-byte string literal not displayed */
AssigningFacility *HD `` /* 317-byte string literal not displayed */
NameRepresentationCode ID `` /* 256-byte string literal not displayed */
NameContext *CWE `` /* 516-byte string literal not displayed */
NameValidityRange DR `` /* 227-byte string literal not displayed */
NameAssemblyOrder ID `` /* 187-byte string literal not displayed */
EffectiveDate DTM `hl7:"19,len=24,format=YMDHM,display=The first date- if known- on which the person name is valid and active."`
ExpirationDate DTM `hl7:"20,len=24,format=YMDHM,display=The last date- if known- on which the person name is valid and active."`
ProfessionalSuffix ST `` /* 583-byte string literal not displayed */
AssigningJurisdiction *CWE `hl7:"22,len=705,display=The geo-political body that assigned the identifier in component 1."`
AssigningAgencyOrDepartment *CWE `hl7:"23,len=705,display=The agency or department that assigned the identifier in component 1."`
}
Extended Composite ID Number and Name for Persons
This data type is used extensively appearing in the PV1, ORC, RXO, RXE, OBR and SCH segments, as well as others, where there is a need to specify the ID number and name of a person.
type XON ¶
type XON struct {
HL7 HL7Name `hl7:",name=XON,len=570,type=d"`
OrganizationName ST `hl7:"1,len=50,display=The name of the specified organization."`
OrganizationNameTypeCode IS `` /* 187-byte string literal not displayed */
IDNumber NM `` /* 205-byte string literal not displayed */
IdentifierCheckDigit NM `` /* 263-byte string literal not displayed */
CheckDigitScheme ID `hl7:"5,len=3,table=0061,display=Contains the code identifying the check digit scheme employed."`
AssigningAuthority *HD `` /* 305-byte string literal not displayed */
IdentifierTypeCode ID `` /* 236-byte string literal not displayed */
AssigningFacility *HD `` /* 316-byte string literal not displayed */
NameRepresentationCode ID `` /* 255-byte string literal not displayed */
OrganizationIdentifier ST `` /* 217-byte string literal not displayed */
}
Extended Composite Name and Identification Number for Organizations
This data type is used in fields (e.g., PV2-23, NK1-13, PD1-3, OBR-44) to specify the name and ID number of an organization.
type XPN ¶
type XPN struct {
HL7 HL7Name `hl7:",name=XPN,len=1317,type=d"`
FamilyName FN `` /* 417-byte string literal not displayed */
GivenName ST `hl7:"2,len=30,table=FirstName,display=First name."`
SecondAndFurtherGivenNamesOrInitialsThereof ST `hl7:"3,len=30,display=Multiple middle names may be included by separating them with spaces."`
Suffix ST `hl7:"4,len=20,display=Used to specify a name suffix (e.g.- Jr. or III)."`
Prefix ST `hl7:"5,len=20,display=Used to specify a name prefix (e.g.- Dr.)."`
Degree IS `hl7:"6,len=6,table=0360,display=Retained for backward compatibility only as of v 2.5. See Professional Suffix component."`
NameTypeCode ID `` /* 127-byte string literal not displayed */
NameRepresentationCode ID `` /* 255-byte string literal not displayed */
NameContext *CWE `` /* 515-byte string literal not displayed */
NameValidityRange DR `` /* 230-byte string literal not displayed */
NameAssemblyOrder ID `` /* 181-byte string literal not displayed */
EffectiveDate DTM `hl7:"12,len=24,format=YMDHM,display=The first date- if known- on which the person name is valid and active."`
ExpirationDate DTM `hl7:"13,len=24,format=YMDHM,display=The last date- if known- on which the person name is valid and active."`
ProfessionalSuffix ST `` /* 583-byte string literal not displayed */
}
Extended Person Name
type XTN ¶
type XTN struct {
HL7 HL7Name `hl7:",name=XTN,len=2743,type=d"`
TelephoneNumber ST `` /* 151-byte string literal not displayed */
TelecommunicationUseCode ID `` /* 171-byte string literal not displayed */
TelecommunicationEquipmentType ID `` /* 172-byte string literal not displayed */
CommunicationAddress ST `hl7:"4,len=199,display=This component is required if neither XTN.7 or XTN.12 are populated."`
CountryCode NM `` /* 159-byte string literal not displayed */
AreaCityCode NM `` /* 239-byte string literal not displayed */
LocalNumber NM `` /* 164-byte string literal not displayed */
Extension NM `` /* 394-byte string literal not displayed */
AnyText ST `hl7:"9,len=199,display=Contains comments with respect to the telephone number."`
ExtensionPrefix ST `` /* 326-byte string literal not displayed */
SpeedDialCode ST `` /* 303-byte string literal not displayed */
UnformattedTelephoneNumber ST `hl7:"12,conditional,len=199,display=An expression of the telephone number as an unparsible string."`
EffectiveStartDate DTM `hl7:"13,len=24,format=YMDHM,display=The first date- if known- on which the telecommunication number is valid and active."`
ExpirationDate DTM `hl7:"14,len=24,format=YMDHM,display=The last date- if known- on which the telecommunication number is valid and active."`
ExpirationReason *CWE `hl7:"15,len=705,table=0868,display=Indicates why this contact number/e-mail was marked as 'ended'."`
ProtectionCode *CWE `` /* 203-byte string literal not displayed */
PreferenceOrder NM `` /* 176-byte string literal not displayed */
}
Extended Telecommunication Number