Transcription
2018Connect IntegrationsTechnical Interface SpecificationsCareCloudVersion 1.1
CONNECT INTEGRATIONS TECHNICALTable of ContentsIntroduction . 3Communication Components. 3Messages Supported & Types. 3Patient Administration (ADT) . 4HL7 ADT Trigger Events . 4HL7 ADT Segment Overview . 4HL7 ADT Notes & Sample Message. 5HL7 ADT Segment Detail . 6HL7 ADT Segments . 6Master Files (MFN) . 11HL7 MFN Trigger Events. 11HL7 MFN Segment Overview . 11HL7 MFN Notification & Sample Message . 12HL7 MFN Segments . 13Scheduling (SIU) . 15HL7 SIU Trigger Events . 15HL7 SIU Segment Overview . 15HL7 SIU Reasons & Notes . 16HL7 SIU Segments . 17Patient Accounting (DFT). 20HL7 DFT Trigger Event . 20HL7 DFT Segment Overview . 20HL7 DFT Message Set & Sample Message . 21HL7 DFT Segments . 22AppendicesAppendix A: HL7 Message ID Library . 252
CONNECT INTEGRATIONS TECHNICALIntroductionThis document pertains to all CareCloud Connect adhering to HL7 messaging, version 2.3 through2.5.1. It defines the Connectivity, File Format, Inbound and Outbound message types. The interfacesaddressed in this document are specific to CareCloud for the exchange of electronic data betweenhealth care information systems.Connectivity & Communication ComponentsThe following methods of connectivity are supported for both inbound and outbound messaging and allrequire a secure end-to-end communication, and available only and only if the communication isestablished directly between CareCloud and the Vendor.§File Transferü IPSec point-to-point VPN tunnel is commonly used.§Secure-FTP (SFTP): Preferred method of connectivity for a cloud-based PMS.ü Secure FTP server required.ü Server located at the practice:§ Practice to provide connection information and credentials to CareCloud.§ The practice is responsible for the setup and maintenance of said connection.ü Server located at CareCloud:§ CareCloud to provide the corresponding connection information and credentials.§ CareCloud is not prone for the required Secure-FTP Client for this solution to work.Messages Supported & TypesThe interface engines are designed to handle:§Inboundo HL7 ADT Demographics A04, A08o HL7 DFT Charges P03§Outboundo HL7 ADT Demographics A04, A08o HL7 SIU Appointments S12, S14, S153
CONNECT INTEGRATIONS TECHNICALPatient AdministrationPurposeThe Patient Administration transaction set provides for the transmission of new or updateddemographic and visit information about patients. Since virtually any system attached to the networkrequires information about patients, the Patient Administration transaction set is one of the mostcommonly used.Generally, information is entered into a Patient Administration system and passed to the nursing,ancillary and financial systems either in the form of an unsolicited update or a response to a recordoriented query.This chapter defines the transactions that occur at the seventh level, that is, the abstract messages. Theexamples included in this chapter were constructed using the HL7 Encoding Rules.Trigger utboundDescriptionYesNoRegister minimal Patient InformationA04YesYesPatient Registration including insurance detailsA08YesYesUpdate Patient InformationA31NoNoMinimal patient updateHL7 ADT Segment OverviewMSHInstance/Set ID1EVN1Event TypePID1Patient DemographicNK11Next of KinPV11Patient Visit DetailGT11Responsible Party DemographicIN11Primary Insurance InformationIN22Secondary Insurance InformationIN11Additional Insurance InformationIN22Secondary Additional Insurance InformationSegmentDescriptionMessage Header4
CONNECT INTEGRATIONS TECHNICALHL7 ADT Message Notes§The Provider ID that is provided on PV1.7.1 by default is the assigned CareCloud ID that isassigned to the provider in the CareCloud System. This ID is unique to the Provider withinthe CareCloud System. This ID can be replaced for the Providers NPI number.§The Referring Physician ID that is provided on PV1.8.1 by default is the NPI that is assignedto the provider.§PID.2.1 contains the CareCloud Patient Chart Number. This is field is an optional field thatcan be manually entered by the practice, entered by an auto chart numbering process or notentered at all. It is used as consistent reference to the patient.§PID.3.1 contains the Patient ID that is a unique patient identifier for a patient within theCareCloud system. This Identifier should be used to as the shared patient id amongstinterfacing system.HL7 ADT Sample MessageMSH \& CC CareCloud 17 Practice Name VN UroChart 17 PracticeName 20110518040526 ADT A08 53651 P 2.3.1EVN A08 20110518040526PID 1 389312334 0010-2-6360453028 DOE JOHN R 19781026 M 1000-9 White 1234 HIDDENST 107 MIAMI FL 33193 UNITEDSTATES 3055514532 jdoe@carecloud.com 7864537890 2 Married 567340987 B03434343 FL NK1 1 DOE JANE W 01 Spouse 321 NOT REAL DR 10 MIAMI FL 33193 UNITEDSTATES 3052654200 7864563452 F 19560915 PV1 1 78 MAIN OFFICE 27 BECKER EDWARD 1602469 SANJAY RAZDAN GT1 1 DOE JANE 321 NOT REAL DR 10 MIAMI FL 33193 UNITED STATES 3052654200 7864563452 19560915 F 01 Spouse 553034343 IN1 1 1973 MEDICARE PART B OF FLORIDA 532 RIVERSIDE AVE 17 FL PO BOX2360 JACKSONVILLE FL 32202 3055551212 GRP2132131 GRP12321313 20110517 20110630 Medicare LEVI WINSTON G 33 Father 19201110 7635 N REALST 1910 MIAMI FL 33193 M12039219A M IN2 561234 M12039219A 33 Father IN1 2 1884 FLORIDA MEDICAID PO BOX 7072 TALLAHASSEE FL 32314-7799 3055551212 GRP08454 GRPNAME2 20110517 20110531 MEDICAID CHAPMIN JOAN P 32 Mother 19840704 7465 FAKEBLVD 932 MIAMI FL 33177 M984549 F IN2 564233214 M984549 32 Mother 5
CONNECT INTEGRATIONS TECHNICALADT Segment DetailHL7 ADT messages carry patient demographic information for HL7 communications but also provideimportant information about trigger events (such as patient admit, discharge, transfer, registration,etc.). Some of the most important segments in the ADT message are the PID (Patient Identification)segment, the PV1 (Patient Visit) segment, and occasionally the IN1 (Insurance) segment. ADTmessages are extremely common in HL7 processing and are among the most widely used of allmessage types.HL7 ADT MSHdefines the intent, source, destination, and some specifics of the syntax of a message.PosSegment NameRequiredData TypePosFieldsSampleMSH.1Field SeparatorYesSTMSH.1.1 MSH.2Encoding CharactersYesSTMSH.2.1 \&MSH.3Sending ApplicationNoHDMSH.4Sending FacilityNoHDMSH.5Receiving ApplicationNoHDMSH.6Receiving FacilityNoHDMSH.7Date/Time of MessageYesDTMMSH.9Message TypeYesMSGMSH.10Message Control IDYesSTMSH.10.1MSH.11Processing IDYesPTMSH.11.1Processing IDPMSH.12Version IDYesVIDMSH.12.1Version ID2.3.1MSH.3.1Namespace IDCCMSH.3.2Universal IDCareCloudMSH.4.1Namespace ID17MSH.4.2Universal IDPractice NameMSH.5.1Namespace IDVNMSH5.2Universal IDVendor NameMSH.6.1Namespace ID17MSH.6.2Universal IDPractice NameMSH.7.120110511140526MSH.9.1Message CodeADTMSH.9.2Trigger EventA08542133MSH \& CC CareCloud 7 Practice Name VN VendorName 7 PracticeName 20110518040526 ADT A08 551 P 2.3.1HL7 ADT EVNThe EVN segment is used to communicate necessary trigger event information to receiving applications.PosSegment NameRequiredData TypePosFieldsSampleEVN.1Event Type CodeNoIDEVN.1.1A08EVN.2Recorded Date/TimeYesDTMEVN.2.120110518040526EVN A08 201105180405266
CONNECT INTEGRATIONS TECHNICALHL7 ADT PIDThe PID segment is used by all applications as the primary means of communicating patient identificationinformation. This segment contains permanent patient identifying and demographic information that, for themost part, is not likely to change frequently.PosSegment NameRequiredDataTypePosFieldsSamplePID.1Set ID - PIDNoSIPID.1.1PID.2Patient IDNoCXPID.2.1ID Number389312334PID.3Legacy Patient IDNoCXPID.3.1ID Number0010-2-6360453028PID.4Patient Account NumberYesCXPID.4.1ID NumberPID.5.1Family NameDOEPID.5.2Given NameJOHNPID.5.3Second or Further GivenNames or Initials thereofRPID.5Patient NameYesXPN1PID.7Date/Time of BirthNoDTMPID.7.1Date of Birth19781023PID.8Administrative fier1000-9PID.10.2TextWhitePID.11.1Street Address1234 HIDDEN STPID.11.2Other Designation107PID.11.3CityMIAMIPID.11.4State or ProvinceFLPID.11.5Zip or Postal Code33193PID.11.6CountryUNITED STATESPID.13.1Telephone Number305-551-4532PID.13.4Email Addressjdoe@carecloud.comPID.14.1Telephone arriedPID.19.1Social Security Number567340987PID.20.1License NumberB0-3434343PID.2O.2Issuing State, Province,CountryFLPID.11Patient AddressNoXADPID.13Phone Number - HomeNoXTNPID.14Phone Number - BusinessNoXTNPID.16Marital StatusNoCWEPID.19SSN Number - PatientNoSTPID.20Driver's License Number- PatientNoDLNPID 1 389312334 0010-2-6360453028 DOE JOHN R 19781026 M 1000-9 White 1234 HIDDEN ST 107 MIAMI FL 33193 UNITED STATES 3055514532 jdoe@carecloud.com 7864537890 2 Married 567340987 B0-3434343 FL 7
CONNECT INTEGRATIONS TECHNICALHL7 ADT PV1Used by Registration/Patient Administration applications to transfer data on an account or visit-specific basis.PosSegment NameRequiredData TypePosPV1.1.1PV1.1Set ID - PV1NoSIPV1.3Assigned Patient LocationNoPLPV1.7PV1.8Attending DoctorReferring .9Location DescriptionMAIN OFFICEPV1.7.1ID Number28PV1.7.2Family NameBECKERPV1.7.3Given NameEDWARDOPV1.8.1ID Number160322PV1.8.2Family NameSANJAYPV1.8.3Given NameRADZANPV1 1 78 MAIN OFFICE 27 BECKER EDWARD 1602469 SANJAY RAZDAN HL7 ADT GT1Guarantor (e.g., the person or the organization with financial responsibility for payment of a patient account)data for patient and insurance billing applications.PosGT1.1GT1.3GT1.5Segment NameSet ID - GT1Guarantor NameGuarantor AddressRequiredData Family NameDOEGT1.3.2Given NameJANEGT1.3.3Second or Further GivenNames or Initials thereofWGT1.5.1Street Address321 REAL DRGT1.5.2Other DesignationFLGT1.5.3CityMIAMIGT1.5.4State or ProvinceFLGT1.5.5Zip or Postal Code33187GT1.5.6CountryUnited StatesGT1.6Guarantor Home Phone No.NoXTNGT1.6.1Telephone Number305-458-7732GT1.7Guarantor Business Phone No.NoXTNGT1.7.1Telephone Number786-123-4566GT1.8Guarantor Date/Time of BirthNoDTMGT1.8.1Date/Time of Birth19671112GT1.9Guarantor Administrative SexNoISGT1.9.1Guarantor GenderFGT1.11Guarantor ouseGT1.12Guarantor SSNNoSTGT1.12.1Guarantor SSN555873433GT1 1 DO JANE 31 REAL DR MIAMI FL 33193 US 3052654200 7864563452 19560915 F 01 Spouse 553034343 8
CONNECT INTEGRATIONS TECHNICALHL7 ADT IN1Insurance policy coverage information necessary to produce properly pro-rated and patient and insurance bills.PosSegment NameRequired Data TypePosFieldsSampleIN1.1 Set ID - IN1YesSIIN1.1.11IN1.3 Insurance Company IDYesCXIN1.3.1 ID Number1973IN1.4 Insurance Company NameNoXONIN1.4.1 Organization NameMedicare of FloridaIN1.5.1 Street Address532 RIVERSDIE AVE 17IN1.5.2 Other DesignationIN1.5 Insurance Company AddressNoXADIN1.5.3 CityJACKSONVILLEIN1.5.4 State or ProvinceFLIN1.5.5 Zip or Postal Code32292IN1.7.1 Telephone Number351-345-6788IN1.8.1 Group NumberGRP12321313IN1.7 Insurance Phone NumberNoXTNIN1.8 Group NumberNoSTIN1.9 Group NameNoXONIN1.9.1 Organization NameUnited Health GroupIN1.12 Plan Effective DateNoDTIN1.12.1 Plan Effective Date20110517IN1.13 Plan Expiration DateNoDTIN1.13.1 Plan Expiration Date20110630IN1.15 Plan TypeNoISIN1.15.1 Plan TypeMedicareIN1.16.1 Family NameLEVIIN1.16.2 Given NameWINSTONIN1.16 Name of InsuredNoXPNIN1.16.3IN1.17 Insured's Relationship to PatientNoCWEIN1.18 Insured's Date of BirthNoDTMIN1.19 Insured's AddressNoXADSecond or Further GivenNames or Initials ThereofGIN1.17.1 Identifier33IN1.17.2 TextFatherIN1.18.1 Insured's Date of Birth19201110IN1.19.1 Street Address7654 N REAL STIN1.19.2 Other Designation1910IN1.19.3 CityBROWARDIN1.19.4 State or ProvinceFLIN1.19.5 Zip or Postal Code33187IN1.36 Policy NumberNoSTIN1.36.1 Member NumberM12039219AIN1.43 Insured Administrative SexNoISIN1.43.1 Administrative SexMIN1 1 1973 MEDICARE PART B OF FLORIDA 532 RIVERSIDE AVE 17 FL PO BOX2360 JACKSONVILLE FL 32202 3055551212 GRP2132131 GRP12321313 20110517 20110630 Medicare LEVI WINSTON G 33 Father 19201110 7635 N REAL ST 1910 MIAMI FL 33193 M12039219A M 9
CONNECT INTEGRATIONS TECHNICALHL7 ADT IN2Additional 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.PosSegment et ID - IN2YesIN2.3Insurance Company IDYesCXIN2.3.1ID Number1973IN2.4Insurance Company NameNoXONIN2.4.1Organization NameMedicare of FloridaIN2.5.1Street Address532 RIVERSDIE AVE 17IN2.5.2Other DesignationIN2.5.3CityJACKSONVILLEIN2.5.4State or ProvinceFLIN2.5.5Zip or Postal Code32292IN2.5Insurance Company AddressNoXAD1IN2.7Insurance Co. Phone NumberNoXTNIN2.7.1Telephone Number351-345-6788IN2.8Group NumberNoSTIN2.8.1Group NumberGRP12321313IN2.9Group NameNoXONIN2.9.1Organization NameUnited Health GroupIN2.12Plan Effective DateNoDTIN2.12.1Plan Effective Date20110517IN2.13Plan Expiration DateNoDTIN2.13.1Plan Expiration Date20110630IN2.15Plan TypeNoISIN2.15.1Plan TypeMedicareIN2.16.1Family NameLEVIIN2.16.2WINSTONIN2.17.1Given NameSecond or further givenNames or 1Insured's Date of Birth19201110IN2.19.1Street Address7654 N REAL STIN2.19.2Other Designation1910IN2.19.3CityBROWARDIN2.19.4State or ProvinceFLIN2.19.5Zip or Postal Code33187IN2.16Name of InsuredNoXPNIN2.16.3IN2.17Insured's Relationship toPatientNoCWEIN2.18Insured's Date of BirthNoDTMIN2.19Insured's AddressNoXADG33IN2.36Policy NumberNoSTIN2.36.1Member NumberM12039219AIN2.43Insured Administrative SexNoISIN2.43.1Administrative SexMIN2 564233214 M984549 32 Mother 10
CONNECT INTEGRATIONS TECHNICALMaster FilesPurposeIn an open-architecture healthcare environment there often exists a set of common reference files usedby one or more application systems. Such files are called master files. Some common examples ofmaster files in the healthcare environment include:a.b.c.d.e.f.g.h.i.j.staff and health practitioner master filesystem user (and password) master filelocation (census and clinic) master filedevice type and location (e.g., workstations, terminals, printers, etc.)lab test definition fileexam code (radiology) definition filecharge master filepatient status masterpatient type masterservice item master fileTrigger tboundDescriptionYesYesMaster File - Physician InformationHL7 MFN Segment OverviewMSHInstance/Set ID1EVN1Event TypeMFI1Master File IdentifierMFE1Master File EntrySTF1Personnel referenced by information systemsPRA1Detailed Medical Practitioner informationSegmentDescriptionMessage Header11
CONNECT INTEGRATIONS TECHNICALMaster Files Notification MessageA given master files message concerns only a single master file. However, the provision of a recordlevel event code (and requested activation date) on the MFE and the MFA segments allows a singlemessage to contain several types of changes (events) to that file.HL7 DFT Sample MessageMSH \& CC CareCloud 1104 Practice VN VENDOR 1104 PRACTICE 20171207162752 MFN M02 20171207- f993162739-d291-416e-a5c6-69d5G11ab9f0 P 2.3.1EVN M02 20091019145547 MFI 20171207-162752MFE 1767821233STF 1487855110 1487855110 SAM CARLOS 954-498-2100 305-298-3176 1601 ARTSBLVD TIM IN 11320PRA 1767821233 VENDOR 110412
CONNECT INTEGRATIONS TECHNICALHL7 MFN MSHThe MSH segment defines the intent, source, destination, and some specifics of the syntax of a message.PosSegment NameRequiredData TypePosFieldsSampleMSH.1Field SeparatorYesSTMSH.1.1 MSH.2Encoding CharactersYesSTMSH.2.1 \&MSH.3Sending ApplicationNoHDMSH.4MSH.5MSH.6Sending FacilityNoReceiving ApplicationHDNoReceiving FacilityHDNoHDMSH.7Date/Time of MessageYesDTMMSH.9Message TypeYesMSGMSH.3.1Namespace IDCCMSH.3.2Universal IDCareCloudMSH.4.1Namespace ID17MSH.4.2Universal IDPractice NameMSH.5.1Namespace IDVNMSH5.2Universal IDVendor NameMSH.6.1Namespace ID17MSH.6.2Universal IDPractice Name20110511140526MSH.7.1MSH.9.1Message CodeMFNMSH.9.2Trigger EventM02MSH.10Message Control IDYesSTMSH.10.15421651MSH.11Processing IDYesPTMSH.11.1Processing IDPMSH.12Version IDYesVIDMSH.12.1Version ID2.3.1MSH \& CC CareCloud 1104 Practice VN VENDOR 1104 PRACTICE 20171207162752 MFN M02 20171207- f993162739-d291-416e-a5c6-69d5G11ab9f0 P 2.3.1HL7 MFN EVN is used to communicate necessary trigger event information to receiving applications.PosSegment NameRequiredData TypePosFieldsSampleEVN.1Event Type CodeNoIDEVN.1.1M02EVN.2Recorded Date/TimeYesDTMEVN.2.120110314110140EVN M02 20091019145547 HL7 MFN MFI identifies the master file object found in an MFN message.PosMFI.5Segment NameRecorded Date/TimeRequiredData TypePosYESDTMMFI.5.1FieldsSample20110314110140MFI 20171207-16275213
CONNECT INTEGRATIONS TECHNICALHL7 MFN MFE identifies the master file entry segment.PosSegment NameRequiredData TypePosMFE.4Referring DoctorYESXCNMFE.4.1FieldsSampleID Number45377MFE 1767821233HL7 MFN STFIdentify any personnel referenced by information systems: providers, staff, system users, and referring agents. Ina network environment, this segment can be used to define personnel to other applications such as order entryclerks, insurance verification clerks, admission clerks, as well as provider demographics.PosSegment NameRequiredData Referring PhysicianSTF.3STF.2.1Identifier150355STF.3.1Family NameAMANDAYesSTF.3.2Given NameCLOUDINESTF.3.3Second or Further Given Namesor Initials ThereofS.STF.3.4SuffixJR.NoXCNNoSTF.11Staff Phone NumbersStafff XTNSTF.10.1Telephone Number545-478-2290CWESTF.10.2TextPHXTNSTF.10.5Fax Number545-478-2200CWESTF.10.6TextFXSTF.11.1Street Address321 NOT REAL DRSTF.11.2Other DesignationMAIN OFFICESTF.11.3CityMIAMISTF.11.4State or ProvinceFLSTF.11.5Zip or Postal Code33187XADSTF 1475110 1475110 SAM CARLS 954-498-2100 305-298-3176 101 ARTS BLVD TIM IN 11320HL7 MFN PRA adds detailed medical practitioner information to the personnel identified by the STF segment.A PRA segment may be optional but must always have been preceded by a corresponding STF segment.PosPRA.1PRA.5PRA.6Segment NameReferring PhysicianReceiving ApplicationRequiredData TypePosNoCXNoNoHDFieldsSamplePRA.1.1ID Number1713226855PRA.5.1Namespace IDVENDOR NAMEPRA.6.1Universal ID4105PRA 1767821233 VENDOR 110414
CONNECT INTEGRATIONS TECHNICALSchedulingPurposeA schedule controls the dates and times available for the performance of a service and/or the use of aresource. One schedule applies to one service or resource, since each service or resource can bereserved independently of the others.A schedule consists of slots of time during which the controlled service or resource is potentiallyavailable for performance or use. Slots are categorized as open, booked, or blocked.Appointments are instances of the performance of a service or the use of a resource. Appointments candescribe scheduled activities related to patients in a healthcare setting, or they can describe scheduledactivities wholly unrelated to patients.Trigger EventsTrafficMessage TypeTrigger EventInboundOutboundS12YesYesNew AppointmentS14YesYesUpdate Appointment ScheduleS15YesYesAppointment CancellationSIUDescriptionHL7 SIU Segment OverviewSegmentMSHSCHPIDPV1RGSAILAIPInstance / Set ID1111111DescriptionMessage HeaderScheduling Header InformationPatient DemographicPatient Visit DetailResource GroupAppointment Information - Location ResourceAppointment Information - Personnel Resource15
CONNECT INTEGRATIONS TECHNICALReasonsThis chapter defines two kinds of reasons used with transactions. The first is an appointment reasonthat indicates why the appointment is being booked - and ultimately why the activity is going tooccur. The second is an event reason that describes why a particular trigger event has beengenerated. Reasons tend to be static, whereas statuses tend to change. In contrast, trigger eventsdescribe an action to be performed.Appointment reasons tend to be relatively static for the life of the scheduled activity. Typicalexamples of appointment reasons include the following: routine, walk-in, check-up, follow-up,emergency, etc.HL7 SIU Message Notes§The Provider ID that is provided on PV1.7.1 by default is the assigned CareCloud ID that isassigned to the provider in the CareCloud System. This ID is unique to the Provider withinthe CareCloud System. This ID can be replaced for the Providers NPI number.§The Referring Physician ID that is provided on PV1.8.1 by default is the NPI that is assignedto the provider.§The Schedule ID in the SCH.1.1 and the Placer Appointment ID in the SCH.5.1 segmentboth reflect the CareCloud Appointment ID. Although this identifier is unique to eachappointment in CareCloud system, it does not follow the appointment when updated.HL7 SIU Sample MessageMSH \& CC CareCloud 17 Practice Name VN Vendor Name 17 PracticeName 20110518120555 P SIU S12 104081 P 2.3SCH 332944 332944 211 NEW PATIENT 211 NEW PATIENT 211 NEW PATIENT 30 201105181600 201105181630 20 Claudia Amorin 20 Claudia Amorin 1 PendingPID 1 389312334 0010-2-6360453028 DOE JOHN R 19781026 M 1234 HIDDENST 107 MIAMI FL 33193 3055514532 567340987 PV1 1 78 MAIN OFFICE 27 BECKER EDWARD 1699473 TALARICO SONIA RGS 1 AIL AIP 1 64 NURSE 16
CONNECT INTEGRATIONS TECHNICALHL7 SIU MSH defines the intent, source, destination, and some specifics of the syntax of a message.RequiredData TypePosMSH.1PosField SeparatorYesSTMSH.1.1MSH.2Encoding CharactersYesSTMSH.2.1MSH.3MSH.4Segment NameSending ApplicationSending FacilityNoHDNoHDMSH.5Receiving ApplicationNoHDMSH.6Receiving FacilityNoHDMSH.7Date/Time of MessageYesDTMMSGFieldsSample \&MSH.3.1Namespace IDCCMSH.3.2Universal IDCareCloudMSH.4.1Namespace ID17MSH.4.2Universal IDPractice NameMSH.5.1Namespace IDVNMSH5.2Universal IDVendor NameMSH.6.1Namespace ID17MSH.6.2Universal IDPractice NameMSH.7.120110511140526MSH.9.1Message CodeSIUMSH.9.2Trigger EventS12MSH.9Message TypeYesMSH.10Message Control IDYesSTMSH.10.1MSH.11Processing IDYesPTMSH.11.1Processing IDPMSH.12Version IDYesVIDMSH.12.1Version ID2.3.1104081MSH \& CC CareCloud 17 Practice Name VN Vendor Name 17 Practice Name 20110518120555 P SIU S12 104081 P 2.3HL7 SIU SCH contains general information about the scheduled appointment.PosSegment NameRequiredData TypePosFieldsSampleSCH.1Placer Appointment IDNoEISCH.1.1Entity Identifier332944SCH.5Schedule SCH.6.2TextNEW PATIENTSCH.7.1Identifier211SCH.7.2TextNEW PATIENTSCH.8.1Identifier211SCH.8.2TextNEW Start Date/Time201105181600SCH.11.5End Date/Time201105181630SCH.16.1ID Number20SCH.16.2Family NameClaudia AmorinaSCH.20.1ID Number20SCH.20.2Family NameClaudia AmorinaSCH.25.1Identifier1SCH.6Event ReasonYesCWESCH.7Appointment ReasonNoCWESCH.8Appointment TypeNoCWESCH.9Appointment DurationNoCWESCH.11Appointment Timing QuantityYesCWESCH.16Filler Contact PersonNoXCNSCH.20Entered by PersonNoXCNSCH.25Filler Status CodeNoCWE17
CONNECT INTEGRATIONS TECHNICALSCH.25.2TextPendingSCH 332944 3329 211 NEW PATIENT 11 NEW PATIENT 11 NEW PATIENT 30 201105181600 201105181630 20 Claudia Amin 20 Claudia Amin 1 PendingHL7 SIU PIDUsed by all applications as the primary means of communicating patient identification information. Thissegment contains permanent patient identifying and demographic information that, for the most part, is notlikely to change frequently.RequiredData TypePosPID.1PosSet ID - PIDNoSIPID.1.1PID.2Patient IDNoCXPID.2.1ID Number389312334PID.3Legacy Patient IDNoCXPID.3.1ID Number0010-2-6360453028PID.4Patient Account NumberYesCXPID.4.1ID NumberPID.5.1Family NameDOEPID.5.2Given NameJOHNPID.5.3Second or Further GivenNames or Initials thereofRPID.7.1Date of Birth19781023PID.5Segment NamePatient NameYesXPNPID.7Date/Time of BirthNoDTMPID.8Administrative SexNoISPID.10PID.11RacePatient AddressNoNoCWEXADPID.13Phone Number - HomeNoXTNPID.14Phone Number - BusinessNoXTNPID.16Marital StatusNoCWEPID.19SSN Number - PatientNoSTPID.20Driver's License Number- ntifier1000-9PID.10.2TextWhitePID.11.1Street Address1234 HIDDEN STPID.11.2Other Designation107PID.11.3CityMIAMIPID.11.4State or ProvinceFLPID.11.5Zip or Postal Code33193PID.11.6CountryUNITED STATESPID.13.1Telephone Number305-551-4532PID.13.4Email Addressjdoe@carecloud.comPID.14.1Telephone arriedPID.19.1Social Security Number567340987PID.20.1License NumberB0-3434343PID.2O.2State, Province, CountryFLPID 1 389312334 0010-2-6360453028 DOE JOHN R 19781026 M 1234 HIDDENST 107 MIAMI FL 33193 305-551-4532 567340987 18
CONNECT INTEGRATIONS TECHNICALHL7 SIU PV1Used by Registration/Patient Administration applications to transfer data on an account or visit-specific basis.RequiredData TypePosPV1.1PosSet ID - PV1NoSIPV1.1.1PV1.3Assigned Patient LocationNoPLPV1.7PV1.8Segment NameAttending DoctorNoReferring Location DescriptionMAIN OFFICEPV1.7.1ID Number28PV1.7.2Family NameBECKERPV1.7.3Given NameEDWARDOPV1.8.1ID Number160473PV1.8.2Family NameTALARICOPV1.8.3Given NameSONIAPV1 1 78 MAIN OFFICE 27 BECKER EDWARD 1699473 TALARICO SONIA HL7 SIU RGSUsed to identify relationships between resources identified for a scheduled event.PosSegment NameRequiredData TypePosRGS.1Set ID - RGSYesSIRGS.1.1RGS.2Segment Action CodeNoIDRGS.2.1FieldsSample1RGS 1 HL7 SIU AILLocation resources (meeting, operating or examination rooms, or other locations) that can be scheduled.PosSegment NameRequiredData TypePosFieldsSampleAIL.1Set ID - AILYesSIAIL.1.1AIL.2Segment Action CodeNoIDAIL.2.1Identifier1AIL.3Service cation DescriptionEastside HospitalAIL.6Start Date/TimeNoDTMAIL.6.1Start Date of Appointment201705181245AIL 1 NSH Northside Hospital 201705181245 HL7 SIU AIPPersonnel types that can be scheduled: Any healthcare provider in the institution controlled by a schedule (forexample: technicians, physicians, nurses, surgeons, anesthesiologists, or CRNAs).PosAIP.1AIP.3Segment NameSet ID - AIPPersonnel ResourceRequiredData TypePosYesSIAIP.1.1YesXCNFieldsSample1AIP.3.1ID Number6411AIP.3.2Family NameCARLOS19
CONNECT INTEGRATIONS TECHNICALAIP.3.3Given NameDOEAIP 1 64 NURSE Patient AccountingPurposeThe Finance describes patient accounting transactions. Financial transactions can be sent betweenappli
MSH.12 Version ID Yes VID MSH.12.1 Version ID 2.3.1 MSH \& CC CareCloud 7 Practice Name VN VendorName 7 Practice Name 20110518040526 ADT A08 551 P 2.3.1 HL7 ADTEVN The EVN segment is used to communicate necessary trigger event information to receiving applications. Pos Segment Name Required Data Type Pos Fields Sample
