Home

Message Segment Specifications

1. ful Fulah ibo Igbo gaa Ga ilo Iloko smn Inari Sami kos Kosraean ind Indonesian kpe Kpelle inh Ingush kum Kumyk iku Inuktitut kur Kurdish ipk Inupiaq kru Kurukh gle Irish kut Kutenai jav Javanese kua Kwanyama kac Jingpho kir Kyrgyz jrb Judeo Arabic lad Ladino jpr Judeo Persian lah Lahnda kbd Kabardian lam Lamba kab Kabyle lao Lao xal Kalmyk lav Latvian kam Kamba lez Lezghian kan Kannada lim Limburgish kau Kanuri lin Lingala pam Kapampangan lit Lithuanian kaa Kara Kalpak nds Low German krc Karachay Balkar dsb Lower Sorbian krl Karelian loz Lozi kas Kashmiri lub Luba Katanga csb Kashubian lua Luba Lulua kaz Kazakh lui Luiseno kha Khasi smj Lule Sami kik Kikuyu lun Lunda kmb Kimbundu luo Luo Kenya and Tanzania kin Kinyarwanda lus Lushai Patient Demographic HL7 Specification 171 ISO 639 2 Code English Name ISO 639 2 Code English Name kom Komi Itz Luxembourgish kon Kongo mac Macedonian kok Konkani mad Madurese mag Magahi nav Navajo mai Maithili ndo Ndonga mak Makasar nap Neapolitan mlg Malagasy new Nepal Bhasa may Malay nep Nepali mal Malayalam nia Nias mit Maltese niu Niuean mnc Manchu nog Nogai m
2. Patient Demographic HL7 Specification 142 Field Name Type Length Comments Req d PID 10 Race CE 250 Repeating field with a maximum of three instances O allowed This field supports both HL7 2 3 and HL7 3 0 values For HL7 2 3 values supported by Care360 Labs amp Meds are listed below W White B Black A Asian American Indian or Alaskan O Other For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC race code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 8401 113883 6 238 amp code 1000 9 with a Concept Status Date of 09 26 2008 Example Because this is a repeating field a patient whose race is Apache 1010 8 White 2106 3 and Asian 2028 9 would be submitted as follows 1010 8 2106 3 2028 9 PID 11 Patient Address XAD 106 No more than 106 characters however limits may apply O to some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only A lt street address ST gt lt other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt PID 12 County Code X Patient Demographic HL7 Specification 143 Field Name Type Length Com
3. Copyright and Trademark Text Specifications The Quest Diagnostics copyright and trademark text that appears along the bottom of each Care360 Labs amp Meds page can be changed to reflect the applicable copyright trademark or disclaimer text up to 5OO characters of the partner organization The text can also contain HTML tags which enables additional formatting or linking options to be included Link Name and Destination Specifications The following hypertext links which appear along the bottom of each page can be customized to display a different link name up to 30 characters each and or to link to a different destination or they can be removed altogether Care360 Labs amp Meds Link Location Customization Options About Care360 Login page Can be renamed and or linked to a different destination page or removed Forgot Password Login page Can be renamed or removed Contact Us Login page Can be renamed and or linked to a different destination page or Each portal page removed Linking to Care360 Labs amp Meds 12 Care360 Labs amp Meds Link Location Customization Options Feedback Each portal page Can change email recipient Quest Diagnostics Resource Each portal page Can be renamed and or linked to a different destination page or removed Logo in Left Hand Navigation Each portal page Can be replaced and or linked to a different destination page Pane Quick View Each portal page Cannot be c
4. Mother s Maiden Name PID 07 Date Time of Birth TS 26 Patient DOB Format yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats PID 08 Sex IS Possible values are listed below M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated blank Note If Care360 Labs amp Meds does not support a value that is submitted on inbound feeds that value appears as a blank in the user interface Patient Demographic HL7 Specification 124 Field Name Type Length Comments Req d PID O9 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suffix Prefix and Degree are passed to Care360 Labs amp Meds PID 10 Race CE 250 Repeating field with a maximum of three instances O allowed This field supports both HL7 2 3 and HL7 3 0 values For HL7 2 3 values supported by Care360 Labs amp Meds are listed below W White B Black A Asian American Indian or Alaskan O Other For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC race code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 840 1 113883 6 238 amp code 10
5. The Data Exchange verifies that this field is populated and that the value complies with the format above MSH 08 Security X MSH 09 Message Type CM 7 The type of message being transmitted and the event R leading to the creation of the message Valid values A28 Add Person Information A315 Update Person Information Patient Demographic HL7 Specification 67 Field Name Type Length Comments Req d MSH 10 Message Control ID ST 20 A number or other data that uniquely identifies the message R in its transmission to the receiving system The Data Exchange verifies that this field is populated MSH 11 Processing ID PT 3 The placer system s intent for the message Valid values R include P Production T Testing The Data Exchange verifies that the value in this field is P or T MSH 12 Version ID ID 8 The value for this field is 2 3 R MSH 13 Sequence Number X MSH 14 Continuation Pointer X MSH 15 Accept X Acknowledgment Type MSH 16 Application X Acknowledgment Type MSH 17 Country Code X MSH 18 Character Set X MSH 19 Principal Language X of Message EVN Event Type Segment The Event Type EVN segment is used to communicate necessary trigger event information to receiving applications Field Name Type Length Comments Req d EVN OO Segment Type ID ST 4 Must be EVN R EVN O1 Event Type Code ID 3 The second component trigger event of MSH 09 R Message Type sh
6. identifier ST text ST name of coding system ST alternate identifier ST alternate text ST gt name of alternate coding system ST Inbound valid values for PD1 11 01 Y Yes which overrides the existing setting in Care360 Labs amp Meds N No which overrides the existing setting in Care360 Labs amp Meds blank which retains the existing setting in Care360 Labs amp Meds Note Data Exchange will not edit to ensure valid values Outbound valid values e Y Yes N No P Pending blank PD1 12 Protection Indicator ID 1 Care360 Labs amp Meds ignores the value for this field O Instead PD1 11 Publicity Indicator sets the value for Consent given to share clinical documentation Inbound valid values Y Yes N No blank Note Data Exchange will not edit to ensure valid values Outbound valid values Y Yes N No P Pending blank Patient Demographic HL7 Specification 110 MRG Merge Patient Information Segment The Merge Patient Information MRG segment provides receiving applications with information necessary to initiate the merging of patient data as well as groups of records Field Name Type Length Comments Req d MRG OO Segment Type ID ST 4 Must be MRG R MRG O1 Prior Patient ID CX 20 The internal prior patient identifier This field containsa O Internal list of potential old numbers to match Only one old number can be merged with
7. lt issuing state province country IS expiration date DT gt Only the first subfield License Number is passed to from Care360 Labs amp Meds PID 21 Mother s Identifier CX 20 Used for example as a link field for newborns Typicallya O patient ID or account number may be used This field can contain multiple identifiers for the same mother Only the first subfield ID Number is passed to from Care360 Labs amp Meds PID 22 Ethnic Group CE 250 This field supports both HL7 2 3 and HL7 3 0 values O For HL7 2 3 values supported by Care360 Labs amp Meds are listed below H Hispanic N Non Hispanic U Unknown For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC ethnicity code set http phinvads cdc gov vads ViewCodeSystemConcept a ction oid 2 16 840 1 113883 6 238 amp code 2133 7 with a Concept Status Date of 09 26 2008 For example for Mexican American you would send 2149 3 This value appears on the Demography tab gt Ethnicity Race Language section PID 23 Birth Place ST 60 Indicates the location of the patient s birth O PID 24 Multiple Birth ID 2 Indicates whether or not the patient was part of a multiple O Indicator birth Yes No indicator Valid values Y Yes N No blank The Data Exchange validates this field PID 25 Birth Order NM 2 When a patient was part of a multiple birth a number O indicating the patient s bi
8. prefix degree for example MD ST name type code ID gt for example DR ST gt Note If the patient is under 18 years old the first name and last name is supplied for at least one contact R Patient Demographic HL7 Specification 77 Field NK1 03 Name Relationship Type CE Length Comments 60 Values supported by Care360 Labs amp Meds are the same as the HL7 values for Family Relation Type Value Set Chttp www hl7 org memonly downloads v3edition cfm V32008 Note For patients under 18 years old the relationship value will be for father mother guardian or parent Req d NK1 04 Address XAD 106 No more than 106 characters Alphanumeric data only street address ST other designation ST city ST ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt lt state or province A Note If the patient is under 18 years old the street address city state and zip or postal code is supplied for at least one contact NK1 05 Phone Number XTN 40 Repeating field that holds all of the phone numbers for the next of kin All unique instances within NK1 05 are separated by a tilde If Home phone number is sent then telecommunication equipment type ID gt must equal PH Ifthe Cell Mobile phone numb
9. Care360 Linking and Single Sign On Programmer Reference Release 14 2 uest G Diagnostics Legal Notices COPYRIGHT NOTICE Quest Diagnostics Corporate Headquarters 3 Giralda Farms Madison New Jersey 07940 U S A 2004 2014 Quest Diagnostics Incorporated All rights reserved Release 14 2 This document is protected by copyright and distributed under licenses restricting its use copying and distribution Parties to a user agreement with Quest Diagnostics for the software described in this document are granted permission to use and reproduce portions of this document solely for their internal training requirements provided that this copyright notice and other proprietary notices appears in all copies Except as provided in this paragraph no part of this document may be reproduced or transmitted in any form or by any means without the express written permission of Quest Diagnostics TRADEMARKS Quest Quest Diagnostics the associated logo and all associated Quest Diagnostics marks are the registered trademarks of Quest Diagnostics All third party marks and are the property of their respective owners DISCLAIMER OF WARRANTIES THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EITHER EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON INFRINGEMENT QUEST DIAGNOSTICS DOES NOT WARRANT THE ACCURACY OR COMPLETENESS OF
10. For more information refer to the following ComponentSpace website http www componentspace com Products SAMLv11 aspx Linking to Care360 Labs amp Meds 16 About Lab Order Echo When the user of a partner application links to Care360 Labs amp Meds to place a lab order that order can be echoed back to the partner application Order echo involves Care360 Labs amp Meds sending a copy of the order back to the partner application so that it can store a record of the order for the associated patient Benefits of order echo include the following Enables the partner application to store a copy of each order placed through the Lab Orders function of Care360 Labs amp Meds to the patient s chart Improves patient records management and office workflow Eliminates the need for redundant data entry Stores order data in standard HL7 format so that it can be easily reused as needed Order messages that are echoed back to the partner application are formatted according to the specifications detailed in the Order 2 3 HL7 Specification spec hl7 orders 23 pdf document Process Walkthrough Lab Order Echo The diagram below illustrates at a high level the flow of order data between Care360 Labs amp Meds and a linked partner application Following the diagram is a step by step walkthrough of the order echo process illustrated in the diagram Receiving Echoed Lab Order Third Party Labs MedPlus Network Billing
11. If a notification of new results is received for example the user can link directly to the Care360 Labs amp Meds New Results page New results can be viewed for all associated service providers including Quest Diagnostics regional hospital laboratories or independent laboratories Process Walkthrough Retrieving User Summary Data The diagram below illustrates at a high level the flow of user summary data between Care360 Labs amp Meds and a linked partner application Following the diagram is a step by step walkthrough of the user summary data retrieval illustrated in the diagram Retrieving User Summary Data from Care360 Labs amp Meds Physician Office Partner Application Requests User Summary Data Partner Application User Logs In Care360 Labs amp Meds Returns User Summary Data Quick View The following steps outline the procedure and associated systems involved in communicating user data for example result and user message counts from Care360 Labs amp Meds to a partner application 1 Auser with an established SSO connection logs in to a partner application 2 The partner application sends a request to Care360 Labs amp Meds for associated user data 3 Care360 Labs amp Meds returns the requested user data to the partner application 4 During the user s current session the partner application can either allow the user to manually refresh the data displayed or it can send automatic ref
12. Note This is a non repeating field in HL7 2 3 but this Care360 specification uses the HL7 2 5 1 definition which allows the field to repeat DG1 Diagnosis Segment The Diagnosis DG1 segment contains patient diagnosis information Note Diagnosis codes sent in the DG1 segment are diagnoses that were not associated with a specific procedure code Field Name DG1 00 Segment Type ID DG1 01 Set ID Patient ID Type Length Comments Req d Must be DG1 R Used to number DG1 message segments sequentially R beginning with 1 Patient Demographic HL7 Specification 156 Field Name Type Length Comments Req d DG1 02 Diagnosis Coding ID 2 X Method DG1 03 Diagnosis Code CE 60 Format identifier ST text ST O name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST DG1 03 01 ICD 9 code DG1 03 03 I9 This value appears on the External Diagnoses tab DG1 04 Diagnosis Description X DG1 05 Diagnosis Date Time TS 26 Date Time that the diagnosis was determined O Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC DG1 06 Diagnosis Type IS 2 Valid values R A Admitting W Working F Final DG1 07 ajor Diagnostic CE 60 X Category DG1 08 Diagnostic Related CE 60 X Group DG1 09 DRG Approval ID 2 X Indicator DG1 10 DRG Grouper Review I
13. Order Copy to Billing System Care360 Care360 as needed Labs amp Meds Data Exchange Receives Data Exchange Third Party Lab Order Hospital Lab Data Exchange Leto Ils Submits Order to Third Party Lab Dale change one Lab per order Data Exchange Echoes Database Third Party Lab Order Copy of Order Physician Lab Partner Application Independent Lab The following steps outline the process and associated systems involved in placing an order and having the order echoed back to the partner application 1 Auserlogs in to the partner application 2 The partner application user initiates a link to the Lab Orders function of Care360 Labs amp Meds When linking to Lab Orders the current patient context may be maintained if an appropriate match can be determined based on the supplied PID 3 Theusercreates and submits a lab order for a Quest Diagnostics lab or any lab that is in the Care360 system or the user creates and prints delivers a lab order for a generic lab a lab that is not in the Care360 system 4 The Data Exchange records the order transaction and stores a copy of the discrete content of the order The Data Exchange echoes returns a copy of the order back to the partner application Linking to Care360 Labs amp Meds 17 About Rx Order Echo When the user of a partner application links to Care360 Labs amp Meds to place a prescription order that order can be echoed back to the partner applicati
14. for example Spain Basque Catalan etc Only the first subfield Identifier is passed to Care360 Labs amp Meds Patient Demographic HL7 Specification 128 Field Name Type Length Comments Req d PID 29 Patient Death Date amp TS 26 Contains the date and time at which the patient death O Time occurred Format yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds PID 30 Patient Death Indicator ID 1 Indicates whether or not the patient is deceased Yes No O indicator Valid values Y Yes N No blank The Data Exchange validates this field PV1 Patient Visit Data Segment The Patient Visit Data PV1 segment is used by registration patient administration applications to communicate information on a visit specific basis This segment can be used to send multiple visit statistic records to the same patient account or single visit records to more than one account Field Name Type Length Comments Req d PV1 00 Segment Type ID ST 4 Must be PV1 R PV1 01 Set ID PV1 SI 4 This field is used to number PV1 message segments O sequentially starting with 1 PV1 02 Patient Class IS 1 For inbound messages Data Exchange verifies that this R field is populated Example values include E Emergency Inpatient O Outpatient PV1 03 Assigned Patient X Location PV1 04 Admission Type X PV1 05 Preadmit
15. For details see Logo and Image Specifications on page 12 Color palette The overall color scheme of the Care360 Labs amp Meds user interface including the navigational buttons can be modified to reflect the partner organization or application For details see Color Palette Specifications on page 12 Copyright and trademark text The Quest Diagnostics copyright and trademark text along the bottom of each page can be changed to reflect the applicable copyright or trademark text of the partner organization For details see Copyright and Trademark Text Specifications on page 12 Link names and destinations Several of the hypertext links along the bottom of each page can be changed to display custom text as well as to link to web based resources associated with the partner organization For example the Contact Us link could be changed to Contact University Hospital with the link providing direct access to the hospital s customer support website For details see Link Name and Destination Specifications on page 12 Custom uniform resource locator URL The web address or URL that is used to access Care360 Labs amp Meds and appears in the user s web browser while using the Care360 Labs amp Meds can be changed to include a domain name that reflects the partner organization or application For details see Custom URL Specifications on page 13 User manual and help The Care360 Labs amp Meds User Manual and
16. MSH 13 Sequence Number X Patient Demographic HL7 Specification 118 SCH Schedule Activity Information Segment The Schedule Activity Information SCH segment is used to communicate necessary schedule activity information to receiving applications Field Name Type Length Comments Req d SCH 00 Segment Type ID ST 4 Must be SCH R SCH 01 Placer Appointment ID El 75 Contains the placer application s permanent identifier for R the appointment request and the scheduled appointment itself when it has been confirmed as a booked slot by the filler application The first component is a string that identifies an individual appointment request or a booked appointment Format lt entity identifier ST gt lt namespace ID IS gt lt universal ID ST gt universal ID type ID gt Notes This is your unique identifier for an appointment It is created for a new appointment S12 and the same value should be sent for any subsequent updates cancels or deletes S14 S15 S17 The first subcomponent is the unique id and the second subcomponent is the system responsible for creating the ID namespace The first and second subcomponents must be populated They are both used to populate PV1 19 Visit Number when a superbill is generated and sent to you as a DFT message The value in SCH 01 01 is used to populate PV1 19 01 The value in SCH 01 02 is used to populate PV1 19 04 SCH 02 Filler
17. Patient Summary collapsed with Write a Prescription displayed Patient Summary opens with a summarized view of the patient s chart with only the Write a Prescription task link visible Patient Summary collapsed with Write a Lab Order displayed Patient Summary opens with a summarized view of the patient s chart with only the Write a Lab Order task link visible Action Items Inbox The EMR can directly access the Action Items Inbox screen related to their organization Pending Items Displays a collapsed view of the pending items for the logged in user Click for an expanded view Renewal Items Displays a collapsed view of the pending items for the logged in user Click for an expanded view Failed Faxes Displays a collapsed view of failed faxes sent by the logged in user Click for an expanded view Once the user has linked to a particular Care360 Labs amp Meds function the user can then access the entire application limited only by their assigned access permissions For information about using specific Care360 Labs amp Meds functions refer to the Care360 Labs amp Meds User Manual or online help Formatting Requirements for Linking to Care360 Labs amp Meds When a partner enables users to link directly to Care360 Labs amp Meds functions the link that appears within the partner application must be formatted according to the following guidelines The full Care360 Labs amp Meds product name must be displayed
18. ST suffix e g JR or III ST prefix e g DR ST degree e g MD ST source table IS assigning authority HD name type ID identifier check digit ST code identifying the check digit scheme employed ID identifier type code IS assigning facility ID HD Subcomponents of assigning authority namespace ID IS amp universal ID ST gt amp universal ID type ID gt Subcomponents of assigning facility ID namespace ID IS amp universal ID ST amp universal ID type ID Notes This field is required if the AIP segment is present Valid values for source table NPI UPIN Patient Demographic HL7 Specification 136 Field Name Type Length Comments Req d AIP 04 Resource Role CE 200 Identifies the role of the personnel requested scheduled R for an appointment For requests if a specific person is not identified in the AIP O3 personnel resource ID field then this field identifies the type of person that should be scheduled by the filler application At a minimum the AIP O4 Resource Role role identifier component should be valued Format identifier ST text ST name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST AIP 05 Resource Group X AIP 06 Start Date Time Note The value for SCH 11 Appointment
19. Values supported by Care360 Labs amp Meds are listed O below P Polygamous W Widowed D Divorced M Married A Annulled Sc Never Married L Legally Separated Interlocutory T Domestic Partner Req d PID7 Religion Patient religion O PID 18 Patient Account Number CX 20 Contains the patient account number assigned by O accounting and to which all charges payments etc are recorded It is used to identify the patient s account Only the first subfield ID Number is passed from Care360 Labs amp Meds PID 19 SSN Number Patient Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 PID 20 Driver s Lic Num Patient DLN 25 DLN format O license number ST issuing state province country IS expiration date DT gt Only the first subfield License Number is passed from Care360 Labs amp Meds PID 21 Mother s Identifier CX 20 Used for example as a link field for newborns Typically a O patient ID or account number may be used This field can contain multiple identifiers for the same mother Only the first subfield ID Number is passed from Care360 Labs amp Meds Patient Demographic HL7 Specification 145 Field PID 22 Name Ethnic Group Type CE Length Comments Req d 250 This field supports both HL7 2 3
20. lt Text gt Female lt Text gt lt Gender gt lt Organization gt Not currently used NS lt InformationSystem gt Not currently used NS lt IDs gt All patient IDs sent from Care360 Labs amp Meds will O be in the CCR This information is sent over in the patientReferenceNumber field Note The social security number is sent as Social Security Number instead of SSN in lt Type gt All other reference number qualifiers are the same as those sent from Care360 Labs amp Meds The lt Text gt tag contains the value Social Security Number or MRN The ID tag will contain the actual value of the ID The Type ID ActorID and ActorRole are defined as xs string type The ID tag will contain the patientReferenceNumber that has a patientReferenceNbrQualifier or SY or ZZ Each patientReferenceNumber sent from Care360 Labs amp Meds is sent in a different Ids element Example Ids Type lt Text gt Social Security Number lt Text gt lt Type gt lt ID gt 123456789 lt ID gt lt Source gt lt Actor gt lt ActorID gt 0C32996a7 00010104507926d8e440 fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt Ids gt Relation Specialty Not currently used NS Not currently used NS CCR Message Specification 185 Attributes Data Objects
21. only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the DOB is in one of these formats Outbound yyyymmdd This value appears on the Billing tab gt Guarantor Information section GT1 09 Guarantor Sex Valid values for this field include O M Male F Female blank The Data Exchange verifies that one of these values is present in this field This value appears on the Billing tab gt Guarantor Information section GT110 Guarantor Type Patient Demographic HL7 Specification 85 Field Name Type Length Comments Req d GT1 11 Guarantor IS 2 Describes relations to patient Valid values O Relationship s 1 Self 2 Spouse 8 Dependent blank This value appears on the Billing tab gt Guarantor Information section GT1 12 Guarantor SSN ST 11 Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab Guarantor Information section GT1 13 Guarantor Date X Begin GT1 14 Guarantor Date End X GT115 Guarantor Priority X GT116 Guarantor Employer XPN 130 Employer name No more than 130 characters O Name Alphanumeric data only This value appears on the Billing tab gt Employer Information section GT117 Guarantor Employer XAD 106 No more than 106
22. patient ID is optional PID O4 Lab Ref ID Encounter ID O O O O PID O5 PN 1 Last name of patient R R R R PN 2 First name of patient R R R R PN 3 Middle initial of patient O O O O PID O7 TS Birth Date mm dd yyyyhhmmss or R R R R mmddyyyyhhmmss Note Pad the date with zeroes for the hhmmss timestamp for example 19901124000000 PID 08 Gender M m or F f R R R R Note Unknown gender will display blank PID 11 ADA Address 1 R R R R AD 2 Address 2 O O O O AD 3 City O O O O AD 4 State 2 digit alpha O R R R AD 5 Zip 5 or 9 digits no hyphens or R R R R dashes allowed AD 6 Country O O O O Linking to Care360 Labs amp Meds Bill Types These are the required fields based on what is sent XML XML Sub Header Main Tag Tag Description Client Patient Insurance ePre PID Patient PID 13 Home Phone 1234567890 no O O O O Information hyphens or dashes allowed continued PID 14 Work Phone 1234567890 no O O O O hyphens or dashes allowed PID 19 SSN 9 digits no hyphens or R R R R dashes allowed Note The patient SSN or ID is always required If patient ID PID 2 is supplied patient SSN is optional GT1 Guarantor GT1 03 PN 1 Last Name O R R O Information PN 2 First Name O R R O PN 3 Middle Initial O O O O GT1 05 ADI Address 1 O R R O AD 2 Address 2 O O O O AD 3 City O R R O AD 4 State 2 digit alpha O R R O AD 5 Zip 5 or 9 digits no hyphens or O R R O dashes allowed AD 6 Co
23. see About the Sample Code on page 16 Linking to Care360 Labs amp Meds 15 About the Sample Code The Care360 Labs amp Meds SSO and Web Services site provides sample source code to illustrate recommended coding practices for interacting with the various SSO and web services provided by Care360 Labs amp Meds Though the samples are specific to a particular SSO function or web service they help illustrate general programming practices that can be used with any of the SSO functions or web services provided by Care360 Labs amp Meds A Readme file is included with the sample application describing the application and how it is to be used In addition detailed comments are provided throughout the sample code to illustrate the implementation of key functions Quest Diagnostics Disclaimer All sample code referenced in this Programmer Reference and the Care360 Labs amp Meds SSO and Web Services site is provided for example purposes only and it may need to be modified to work in your environment It is provided as is without warranty of any kind or support from Quest Diagnostics Third Party Disclaimer Quest Diagnostics has a software license to use a library written by ComponentSpace It is used by the sample application to create assertions and other SAML features in C In order to use the sample application a third party application developer must download and install the ComponentSpace library for SAML version 1 1
24. that occur Responses include messageControlUid The message control ID included in the patient demographic update message that was submitted to the Data Exchange hubTransactionUid The transaction ID for the response errors The array of validation and authorization errors returned ifthe patient demographic update message is returned based on validation Status The status of the transaction response Valid values SUCCESS or FAILURE String String String String a R Required O Optional C Conditional Submit Patient Demographic Web Service API Reference 47 About the WSDL Interface Document In order to utilize a web service you must develop a web service client application A client application created for accessing the Submit Patient Demographics web service is referred to as a static web service client because the client knows where the web service is located without looking up the service in a Universal Description Discovery and Integration UDDI registry The client calls the web services via a known service URL to obtain the WSDL file that describes the web services A WSDL interface document describes all of the information that is needed by a web service client to interact with the associated web service The WSDL document includes the URL to locate the associated web services Once you have obtained the WSDL you can build a web service client application that uses the web serv
25. the target organization and the incoming patient demographics the matching patient is updated fCare360 Labs amp Meds finds more than one existing patient that has a high confidence or ambiguous match with the incoming patient demographics Care360 Labs amp Meds adds the patient and marks the patient as a potential duplicate f Care360 Labs amp Meds finds an ambiguous match between the incoming patient demographics and a single patient in the target organization Care360 Labs amp Meds adds the patient and marks the patient as a potential duplicate Submit Patient Demographic Web Service API Reference 41 Fuzzy Matching Request Potential Results Update Patient If Care360 Labs amp Meds finds no high confidence match between existing patients in the target organization and the incoming patient demographics the patient is added If Care360 Labs amp Meds finds a high confidence match between a single patient in the target organization and the incoming patient demographics the matching patient is updated If Care360 Labs amp Meds finds more than one existing patient that has a high confidence or ambiguous match with the incoming patient demographics Care360 Labs amp Meds adds the patient and marks the patient as a potential duplicate If Care360 Labs amp Meds finds an ambiguous match between the incoming patient demographics and a single patient in the target organization Care360 Labs amp Meds
26. umber PID 19 SSN Number Patient ST 16 Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above PID 20 Driver s Lic Num X Patient PID 21 other s Identifier X PID 22 Ethnic Group X PID 23 Birth Place X PID 24 ultiple Birth Indicator X PID 25 Birth Order X PID 26 Citizenship X PID 27 Veterans Military X Status PID 28 Nationality X PID 29 Patient Death Date amp X Time Patient Demographic HL7 Specification 108 Field Name Type Length Comments Req d PID 30 Patient Death Indicator X PD1 Patient Additional Demographic Segment The Patient Additional Demographic PD1 segment contains demographic information that is likely to change about the patient Field Name Type Length Comments Req d PD1 01 Living Dependency IS 2 O PD1 02 Living Arrangement IS 2 O PD1 03 Patient Primary Facility XON 90 O PD1 04 Patient Primary Care XON 90 O Provider Name amp ID No PD1 05 Student Indicator IS 2 O PD1 06 Handicap IS 2 O PD1 07 Living Will IS 2 O PD1 08 Organ Donor IS 2 O PD1 09 Separate Bill ID 2 O PD1 10 Duplicate Patient CX 2 O Patient Demographic HL7 Specification 109 Field Name Type Length Comments Req d PD1 11 Publicity Indicator CE 1 Represents the value for Consent given to share clinical O documentation in Care360 Labs amp Meds Format
27. 09 26 2008 Because this is a repeating field for a patient whose race is Apache 1010 8 White 2106 3 and Asian 2028 9 for example you would send all three of the codes 1010 8 2106 3 2028 9 This value appears on the Demography tab gt Ethnicity Race Language section PID 11 Patient Address XAD 106 No more than 106 characters however limits may apply to O some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only street address ST other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt The Data Exchange verifies that the field length complies with the rules above The patient address appears on the Demography tab gt Contact Information section PID 12 County Code X Patient Demographic HL7 Specification 71 Field Name Type Length Comments Req d PID 13 Phone Number XTN 40 Repeating field that can accept Home phone number O Home Cell Mobile phone number and email address Ifthe Home phone number is sent it must be the first occurrence Ifthe Cell Mobile phone number is sent then telecommunication equipment type ID gt must equal CP If there is a Cell Mobile phone number but no primary Home phone number the first se
28. 999 GT1 08 Guarantor Date Time TS 26 Guarantor DOB O of Birth Format yyyymmdd GT1 09 Guarantor Sex IS 1 Valid values for this field include O M Male F Female blank GT110 Guarantor Type X GT1 11 Guarantor Relationship IS 2 Describes relations to patient Valid values O 1 Self 2 Spouse 8 Dependent blank GT1 12 Guarantor SSN ST 11 Will contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 GT113 Guarantor Date Begin X GT1 14 Guarantor Date End X GT115 Guarantor Priority X GT116 Guarantor Employer XPN 130 Employer name No more than 130 characters O Name Alphanumeric data only GT117 Guarantor Employer XAD 106 No more than 106 characters Alphanumeric only O Address lt street address ST gt lt other designation ST gt lt city ST gt lt state or province ST gt lt zip or postal code ST gt lt country ID gt lt address type ID gt lt other geographic designation ST gt county parish code IS census tract IS gt GT118 Guarantor Employer X Phone Number Patient Demographic HL7 Specification 160 Field Name Type Length Comments Req d GT1 19 Guarantor Employee ID X Number GT1 20 Guarantor Employment X Status GT1 21 Guarantor X Organization Name GT1 22 Guarantor Billing Hold X Flag GT1 23 Guarantor Credit X Rating Code GT1 24 Guaran
29. ADT A28 69 75 ield requirements patient demographic ADT A29 95 100 ield requirements patient demographic ADT A31 69 75 ield requirements patient demographic ADT A39 106 109 112 115 field requirements patient demographic SIU 123 129 PID only matching details 40 patient demographic integration 40 PRI field requirements DFT 155 156 Practice Management System PMS Technology Provider definition 196 Prescriber definition 196 Prescription Drug definition 196 Prescription Order CCR specification overview 176 Procedure code 154 Procedure modifier code 155 Process walkthrough Linking and SSO 9 Order Echo 17 18 receive patient demographic updates 44 retrieve patient demographic updates 52 submit patient demographic updates 43 User Summary Services 32 Production environment Retrieve Patient Demographics Services 60 Submit Patient Demographics Services 48 User Summary Services 36 Provider definition 196 Provider account definition 196 PV1 field requirements DFT 148 152 field requirements patient demographic ADT A28 79 81 field requirements patient demographic ADT A29 100 102 field requirements patient demographic ADT A31 79 81 field requirements patient demographic SIU 129 131 gt gt Dh h R Race patient demographic element ADT A28 71 ADT A31 71 DFT 143 SIU 125 Real time mode patient demographic integration 40 Receive patient demographic updates process walkthrough 44 Related documentation xii Req
30. Body gt CCR Message Specification 189 lt Actors gt lt Actor gt ActorObjectID 0c329aef7 0001010450792624f1f5cd ActorObjectID Person Name lt CurrentName gt lt Given gt FirstName lt Given gt lt Family gt LastName lt Family gt lt CurrentName gt lt Name gt lt Person gt lt IDs gt lt Type gt lt Text gt DEA lt Text gt lt Type gt lt ID gt 888888 lt ID gt lt Source gt lt Actor gt lt ActorID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt IDs gt lt IDs gt lt Type gt Text State License lt Text gt lt Type gt lt ID gt ST 888888 lt ID gt lt Source gt lt Actor gt lt Actor1ID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt IDs gt lt Status gt lt Text gt Active lt Text gt lt Status gt lt Source gt lt Actor gt lt ActorID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt Actor gt lt Actor gt ActorObjectID 0c32996a7 00010104507926d8e440fc ActorObjectID Source Actor lt ActorID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt l
31. Death Indicator X Patient Demographic HL7 Specification 115 SIU Schedule Information Unsolicited Message Segment Specifications The purpose of the SIU Schedule Information Unsolicited HL7 message type is to enable a partner application to submit patient scheduling data to Care360 Labs amp Meds This can be used for example to gather pre visit data medication history or to check patient eligibility SIU messages are inbound only partner application to Care360 Labs amp Meds The following SIU messages are supported SIU S12 New Appt SIU S14 Modify Appt SIU S15 Cancel Appt SIU ST7 Delete Appt Notes Only one appointment per message is processed If multiple appointments are sent in the same message Care360 Labs amp Meds will only process the first appointment Forscheduling information the AIP Appointment Information Personnel Resource segment is the only one used by Care360 Labs amp Meds AIS Appointment Information Services AIG Appointment Information General Resources and AIL CAppointment Information Location are not used For a sample message see Sample 5 Schedule Patient on page 167 Message Segment Hierarchy The SIU message segment hierarchy is specified below MSH Message Header Required one per file SCH Schedule Activity Information Required one per file NTE Notes Optional multiple per SCH PID Patient Identification Required one per file PV1
32. Dog Partner Application User Logs In A s B Add New Patient User Initiates SSO Link to Care360 Labs amp Meds Specific function or default page New Results Initializing a User s SSO Connection The following steps outline the procedure and associated systems involved in initializing an SSO connection from a partner application to Care360 Labs amp Meds 1 Quest Diagnostics issues a Care360 Labs amp Meds user ID and temporary password to the partner application user 2 Theuserlogs in to the partner application as before using their existing partner application username and password 3 The first time the user attempts to link to Care360 Labs amp Meds from the partner application a login page appears prompting the user to enter their assigned Care360 Labs amp Meds user ID and password Note The user is allowed five attempts to log in using their assigned Care360 Labs amp Meds credentials If the user cannot successfully log in or if the user ID that was entered is already in use a message appears indicating that the user must contact Care360 Labs amp Meds Customer Support in order to proceed 4 Whenthe user successfully logs in to Care360 Labs amp Meds the first time their user information and password are saved to a SAML user mapping table 5 When the user subsequently links to Care360 Labs amp Meds the Care360 Labs amp Meds login process is completed automatically based on their s
33. FT1 26 Name Type Procedure Code CE Modifier Length Comments Req d 80 When applicable contains the procedure code modifier to O the procedure code reported in FT1 25 Procedure Code Procedure code modifiers are defined by regulatory agencies such as Centers for Medicare and Medicaid Services CMS and the American Medical Association AMA Multiple modifiers may be reported The modifiers are sequenced in priority according to user entry This is a requirement of the Universal Bill UB and the 1500 claim forms Multiple modifiers are allowed and the order placed on the form affects reimbursement This is a repeating field with each instance delimited by tilde Format lt identifier ST text ST name of coding system ST alternate identifier ST alternate text ST name of alternate coding System ST gt Subfields sent by Care360 Labs amp Meds FT1 26 01 PMC Procedure Modifier Code FT1 26 02 PMC description FT1 26 03 PMC coding system MOD Note This is an HL7 2 4 field PR1 Procedure Segment The PR1 segment contains information relative to various types of procedures that can be performed on a patient The PRI segment is used to send multiple procedures for example for medical records encoding or for billing systems Field Name Type Length Comments Req d PR1 00 Segment Type ID ST 4 Must be PRI R PR1 01 Set ID PR1 Sl 4 Contains the number th
34. ID CX 40 The primary identifier or other identifiers used by the facility O to identify a patient uniquely for example medical record number billing number birth registry etc This is the patient identifier associated with the non Care360 system and it is not always available within Care360 PID O4 Alternate Patient ID X PID Patient Demographic HL7 Specification 69 Field PID O5 Name Type Patient Name XPN Length Comments 48 Req d No more than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name A family name ST gt given name ST gt lt middle initial or name ST gt for example JR or III ST for example DR ST degree for example MD ST name type code ID suffix prefix The Data Exchange verifies that the field length complies with the rules above The patient name appears in the Care360 Labs amp Meds patient chart and several other places throughout Labs amp Meds After submitting an add or update it can be verified on the Demography tab gt Patient Information section PID 06 Mother s Maiden Name PID O7 Date of Birth TS PID 08 Sex IS 26 Patient date of birth DOB in the following format R nbound yyyymmdd or yyyymmddhhmmss The Data Exchang
35. Indicator Type ID Length Comments 1 Care360 Labs amp Meds ignores the value for this field Instead PD1 11 Publicity Indicator sets the value for Consent given to share clinical documentation Inbound valid values Y Yes N No blank Note Data Exchange will not edit to ensure valid values Outbound valid values Y Yes N No P Pending blank Req d NK1 Next of Kin Segment The Next of Kin NK1 segment is ignored on inbound partner application to Care360 Labs amp Meds messages For outbound Care360 Labs amp Meds to partner application or other entity messages NK1 may or may not be present depending on the intended destination of the message For messages destined for partner applications NK1 is not present For messages that contain immunization reports destined for state or federal registries NK1 is present Field NK1 00 Name Segment Type ID Type ST Length Comments 4 Must be NK1 Req d NK1 01 NK1 02 Set ID Name SI XPN 4 Used to number NK1 message segments sequentially beginning with 1 48 No more than 48 characters including the delimiter between the last and first names At least one character must be used for first and last name A numeric value cannot be used as the first character of the last name family name ST given name ST middle initial or name ST suffix for example JR or III ST
36. Indicator X PV1 52 Other Healthcare X Provider Patient Demographic HL7 Specification 102 ADT A39 Patient Merge Message Segment Specifications The ADT A39 Patient Merge message is used as follows Inbound partner application to Care360 Labs amp Meds For the partner application to merge two patient records in Care360 Labs amp Meds the ADT A39 messages must be written to the specifications in this chapter Outbound Care360 Labs amp Meds to partner application For Care360 Labs amp Meds to update the partner application with patient records that were merged in Care360 Labs amp Meds Care360 Labs amp Meds adheres to the ADT A39 message specification in this chapter so that the partner application knows what it will be receiving The ADT A39 message can be used for example to merge two patient records for the same patient who was incorrectly filed under two separate PIDs For a sample message see Sample 4 Merge Patient on page 167 Message Segment Hierarchy The ADT A39 message segment hierarchy is specified below MSH Message Header Required one per file EVN Event Type Required PID Patient Identification Correct Required PD1 Additional Demographics Optional MRG Merge Information Required PID Patient Identification Incorrect Required Inbound Only PV1 Patient Visit Optional not supported In the hierarchy shown above braces indicate where multiple items are allowed and brac
37. Information Services Segment on page 133 AlG Appointment Information General Resources Segment on page 134 AlL Appointment Information Location Segment on page 135 AIP Appointment Information Personnel Resource Segment on page 136 Notes SIU message segments that are not supported are not included in this section for detailed specifications refer to the HL7 2 3 Specification All date timestamps are set to Coordinated Universal Time UTC MSH Message Header Segment The Message Header MSH segment defines the intent source destination and some specifics of the syntax of a message Field Name Type Length Comments Req d MSH O0 Segment Type ID ST 4 Must be MSH R MSH 01 Field Separator ST 1 The separator between the message segment ID MSH R and the first real data field MSH 02 Defines the character to be used as a separator for the rest of the message The value is a vertical bar MSH 02 Encoding Characters ST 4 Four characters that are used in the following order R component separator repetition separator escape character and subcomponent separator Format amp These values are recommended by HL7 and are the only values supported MSH 03 Sending Application HD 180 The name of the sending application O MSH 04 Sending Facility HD 180 The sending facility Identifies the owner of the patient R data and who initiated the patient demographic request This value w
38. Maiden X Name Patient Demographic HL7 Specification 112 Field Name Type PID O7 Date Time of Birth TS Length Comments Req d 26 Patient DOB R Format yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats PID O8 Sex IS 1 Possible values are listed below R M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated blank Note If Care360 Labs amp Meds does not support a value that is submitted on inbound feeds that value appears as a blank in the user interface PID O9 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suffix Prefix and Degree are passed to from Care360 Labs amp Meds PID 10 Race X PID 11 Patient Address XAD 106 No more than 106 characters however limits may apply O to some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only lt street address ST gt lt other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS The Data Exchange verifies that t
39. Number X PV1 06 Prior Patient Location X PV1 07 Attending Doctor X PV1 08 Referring Doctor X PV1 09 Consulting Doctor X PV1 10 Hospital Service X Patient Demographic HL7 Specification 129 Field Name Type Length Comments Req d PV1 11 Temporary Location X PV1 12 Preadmit Test Indicator X PV113 Readmission Indicator X PV114 Admit Source X PV115 Ambulatory Status X PV116 VIP Indicator X PV1 17 Admitting Doctor X PV1 18 Patient Type X PV119 Visit Number X PV1 20 Financial Class X PV1 21 Charge Price Indicator X PV1 22 Courtesy Code X PV1 23 Credit Rating X PV1 24 Contract Code X PV1 25 Contract Effective Date X PV1 26 Contract Amount X PV1 27 Contract Period X PV1 28 Interest Code X PV1 29 Transfer to Bad Debt X Code PV1 30 Transfer to Bad Debt X Date PV1 31 Bad Debt Agency Code X PV1 32 Bad Debt Transfer X Amount PV1 33 Bad Debt Recovery X Amount PV1 34 Delete Account X Indicator PV1 35 Delete Account Date X PV1 36 Discharge Disposition X Patient Demographic HL7 Specification 130 Field Name Type Length Comments Req d PV1 37 Discharged to Location X PV1 38 Diet Type X PV1 39 Servicing Facility X PV1 40 Bed Status X PV1 41 Account Status X PV1 42 Pending Location X PV1 43 Prior Temporary X Location PV1 44 Admit Date Time X PV1 45 Discharge Date Time X PV1 46 Current Patient
40. Patient Visit Data Optional one per PID PV2 Patient Visit Data Additional Information Optional one per PID oBx Observation Result Optional multiple per PID DG1 Diagnosis Optional multiple per PID RGS Resource Group Segment Required multiple per file Only the first segment sent is used AIS Appt info Services Optional multiple per RGS H y Notes Optional multiple per AIS Appt info General resources Optional multiple per RGS y Notes Optional multiple per AIG AIL Appt info Location Optional not supported Notes Optional multiple per AIL y Appt info Personnel Resource Optional multiple per RGS Only the first segment sent is used Notes Optional multiple per AIP In the hierarchy shown above braces indicate where multiple items are allowed and brackets 1 indicate items that are optional Patient Demographic HL7 Specification 116 Message Segment Specifications This section provides detailed specifications for each segment of an SIU Schedule Information Unsolicited message Supported message segments include the following MSH Message Header Segment on page 117 SCH Schedule Activity Information Segment on page 119 PID Patient Identification Segment on page 123 PV1 Patient Visit Data Segment on page 129 DG1 Diagnosis Segment on page 131 RGS Resource Group Segment on page 133 AlS Appointment
41. Req d EVN 06 Event Occurred X PID Patient Identification Segment Correct The Patient Identification PID segment is used by all applications as the primary means of communicating patient identification information This segment is identified as Correct which represents the patient identification information that will remain following a patient merge This segment contains permanent patient identifying and demographic information that for the most part is not likely to change frequently Field Name Type Length Comments Req d PID OO Segment Type ID ST 4 Must be PID R PID O1 Set ID SI 4 Allows identification of multiple PID segments withina R message Usually a sequential number beginning with 1 PID O2 Patient ID CX 40 Care360 patient identifier used to uniquely identify a R patient within Care360 When the patient is from another institution outside office etc the identifier used by that institution can be shown in this field This may be a number that multiple disparate corporations or facilities share Example BB1123 PID O3 Patient ID CX 40 The primary identifier or other identifiers used by the O facility to identify a patient uniquely for example medical record number billing number birth registry etc This is the patient identifier associated with the non Care360 system and it is not always available within Care360 PID 04 Alternate Patient ID X PID PID O5 Patient Name XPN 48 No m
42. ST country ID address type ID other geographic designation ST county parish code IS census tract IS A A If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab gt Contact Information section Patient Demographic HL7 Specification 84 Field GT1 06 Name Guarantor Ph Num Home Type XTN Length 40 Comments Req d Accepted length of this field is 20 numeric characters No O dashes or other separating characters Example with country code and extension omitted 333 4445555 Example with country code 1 333 4445555 If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab Guarantor Information section GT1 07 Guarantor Ph Num Business XTN 40 Accepted length of this field is 20 numeric characters No O dashes or other separating characters Example with country code omitted 333 4445555 999 Example with country code 1 333 4445555 999 If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab Guarantor Information section GT1 08 Guarantor Date Time of Birth TS 26 Guarantor DOB in the following format O Inbound yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards
43. Service API Reference 59 About the WSDL Interface Document In order to utilize a web service you must develop a web service client application A client application created for accessing the Retrieve Patient Demographic web service is referred to as a static web service client because the client knows where the web service is located without looking up the service in a Universal Description Discovery and Integration UDDI registry The client calls the web services via a known service URL to obtain the WSDL file that describes the web services A WSDL interface document describes all of the information that is needed by a web service client to interact with the associated web service The WSDL document includes the URL to locate the associated web services Once you have obtained the WSDL you can build a web service client application that uses the web service to perform the desired functions The following section describes how to obtain the WSDL document for the Retrieve Patient Demographic web service Note You must have a valid user name and password issued by Quest Diagnostics in order to access the WSDL interface documents For the Production environment a user name and password will be issued once your application has been developed tested and certified Accessing the Retrieve Patient Demographic Web Service WSDL Document To access the WSDL service description for the Retrieve Patient Demographic web service use your brows
44. Timing X Quantity is used for the appointment date and time instead of AIP O6 through AIP 10 AIP 07 Start Date Time Offset X AIP 08 Start Date Time Offset X Units AIP 09 Duration X AIP 10 Duration Units X AIP 11 Allow Substitution X Code AIP 12 Filler Status Code X Patient Demographic HL7 Specification 137 DFT PO3 Detail Financial Transaction Message Segment Specifications The Detail Financial Transaction DFT message describes a financial transaction transmitted between systems allowing Care360 Labs amp Meds to send billing information to a vendor practice management system PMS in provider offices This eliminates the need for the billing data to be entered manually into the PMS If no PMS is available the provider office can still electronically capture the billing details and view these details in Care360 Labs amp Meds The DFT message is outbound only Care360 Labs amp Meds to partner application The following message is supported PO3 Post detail final transaction For a sample message see Sample 6 Detail Financial Transaction on page 167 Message Segment Hierarchy The DFT PO3 message submitted from Care360 Labs amp Meds will follow the message segment hierarchy specified below MSH Message Header Required one per file EVN Event Type Required PID Patient Identification Required one per file PD1 Additional Demographics Optional PV1 Patient Visit Optional PV2 Patient V
45. UI In general All submitted values are stored in the database but not all values are displayed If alist of valid values is presented for a given field and a value other than one of those listed is submitted on inbound feeds the corresponding field in the Care360 Labs amp Meds appears with a blank in the user interface The value will be stored in the database but will not be available via the Ul After submitting an add or update message the demographic values can be verified in Care360 Labs amp Meds in the patient chart on the Demography Contacts and Billing pages e Admin Preferences What s New Help Quest Diagnostics Logout Care300 Message Center Patient Lab Orders Reports Last First Find Patient Advanced Search P Summary Prescriptions w Lab Tests w Flowsheets Graphs Quick View gt Find a Patient Patient gt Edit Patient PatientLast Patientfirst M Move 82y Male e Patient Link Hak H 513 229 5500 Patient addressline1 Patient addressline2 Mason OH 45040 Edit View Details No Care Recommendations as of 02 49 PM Ww View Summary Y Q peeve Contacts Billing Patient Information Status Active Administrative Details Last Name PatientLast Primary Provider Last First First Name Patienffirst PID bridge Middle Initial M Health ID Birth Date 12 16 1930 Sex Mae Sw Morel Sa S a Contact Information Mother Maiden Name Address Line 1
46. a complete and valid electronic order for a specific laboratory either a Quest Diagnostics laboratory or a third party laboratory Master files are converted to the Quest Diagnostics CDC format for use within the Lab Orders component Master Patient Index MPI An index or file with a unique identifier for each patient that serves as a key to a patient s health record National Drug Code NDC Each drug product listed under Section 510 of the Federal Food Drug and Cosmetic Act is assigned a unique 10 digit 3 segment number This number known as the National Drug Code NDC identifies the labeler vendor product and trade package size The first segment the labeler code is assigned by the FDA A labeler is any firm that manufactures repacks or distributes a drug product The second segment the product code identifies a specific strength dosage form and formulation for a particular firm The third segment the package code identifies package sizes Both the product and package codes are assigned by the firm The NDC will be in one of the following configurations 4 4 2 5 3 2 or 5 4 1 Negative Acknowledgment NAK A message indicating that an action such as downloading a lab result was not successfully accomplished See also Acknowledgment ACK Glossary 195 Pharmacy Benefit Manager PBM Organizations that provide administrative services such as processing and analyzing prescription claims for pharmacy benefit and co
47. access the WSDL 48 API 45 47 methods 45 objects 47 overview 39 submitBatchADTMessage method description 46 submitRealTimeADTMessage method description 45 Support contact 14 T Test EMR application 15 Trust organizational 22 U UI customization see Care360 Labs amp Meds UI customization Update patient sample patient demographic message 166 User Interface Customization see Care360 Labs amp Meds UI Customization User Summary Services access the WSDL 36 API 33 35 availability with Care360 Labs amp Meds 2 definition vii methods 33 objects 34 35 overview 32 process walkthrough 32 WwW Walkthrough process see Process walkthrough WSDL Web Services Description Language patient demographics connectivity 39 Retrieve Patient Demographics Services WSDL documents 60 Submit Patient Demographics Services WSDL documents 48 User Summary Services WSDL documents 36 WSOrg object description 35 WSOrgData object description 35 WSUserSummaryCounts object description 34 WSUserSummaryData object description 34 X XML Schema Retrieve Patient Demographics Services 57 Index 201 We d Like to Hear From You After you have used the documentation for this product please take a moment to give us your feedback To do so click the following link to open a PDF form and respond to the questions Click here to open the Feedback Form After you have completed the form do one of the following from within the form
48. always available within Care360 PID 04 Alternate Patient ID PID PID 05 Patient Name XPN 48 No more than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name family name ST given name ST middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID The Data Exchange verifies that the value complies with the rules above Patient Demographic HL7 Specification 95 Field Name Type Length Comments Req d PID 06 Mother s Maiden X Name PID O7 Date Time of Birth TS 26 Patient DOB in the following format R Inbound yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats Outbound yyyymmdd PID 08 Sex IS 1 Possible values are listed below R M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated PID 09 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suffix Prefix and Degree are passed to from Care360 Labs amp Meds PID 1
49. and certificate request to be authorized by a third party certificate authority for example VeriSign and then forward the public key to Quest Diagnostics D Providing SAML credentials Your SAML implementation must employ a few key pieces of information that must be shared with Quest Diagnostics your SAML partner including Source ID A Base64 encoded identifier that uniquely identifies your site This is the primary key component of the organizational trust record Quest Diagnostics creates for you in our system Issuer A unique string typically in URL format that identifies your Internet host point This string is stored in the organizational trust record that Quest Diagnostics maintains for you and is also included in all SAML assertions transmitted by your site to Care360 Labs amp Meds SAML Artifact Redemption Servlet Applies only to partners using the SAML Browser Artifact profile If your site uses the SAML Browser Artifact profile method of authentication this is a URL on your system to which Care360 Labs amp Meds SSO can call back to redeem an SAML artifact This must be a secure SSL accessible endpoint on your system and may require special firewall configuration which would be examined as part of the security assessment Note If you are using the recommended SAML Browser POST profile this component is not necessary Care360 Labs amp Meds SSO Specification 22 Implementing SAML Your SAML impleme
50. assertion provided and performs authentication to establish a new session under the following conditions evaluated in the order shown 1 The partner application link has launched a new browser window 2 The partner application link attempts to update the existing browser window for which the Care360 Labs amp Meds session has timed out 3 Adifferent user has authenticated to the running partner application since the Care360 Labs amp Meds browser window was launched This requires authentication to Care360 Labs amp Meds as the new partner application user Care360 Labs amp Meds SSO Specification 26 About SSO User Initialization Before successful SSO authentication to Care360 Labs amp Meds can occur users of trusted partner applications must be mapped to Care360 Labs amp Meds This process includes verifying that the user knows his her Care360 Labs amp Meds credentials User ID and Password the first time the user accesses Care360 Labs amp Meds via a link from the partner application The first time the user initiates SSO based access to Care360 Labs amp Meds the absence of a user mapping on file for the user elicits a login page displaying a message indicating why the credentials are being requested Both new and existing Care360 Labs amp Meds users will see this page on their first SSO based access attempt Both temporary passwords issued by Customer Support and permanent passwords set by the user via the C
51. been associated with this String R retrieval request This is used to acknowledge the retrieved messages AckRequestltem The array of AckRequestltem objects indicating the AckRequest O demographic and or billing messages that are being acknowledged Item AckRequestltem Represents the demographic and or billing messages being acknowledged Attributes that can be set for this object include messagelD The message control ID that identifies the demographic String R and or billing messages being acknowledged provided in the RetrievalResultltem object of the RetrievalResult ackCode Identifies whether or not the message was acknowledged String R Valid values ACK The message was successfully retrieved and removed from the queue NAK The message was rejected by the retrieving system but is still removed from the queue AckResult Represents the response elements for the acknowledgement This includes the status and any error conditions Responses include Status The status of the acknowledgement Valid values SUCCESS or String R FAILURE ErrorDescription A description of the error that occurred ifthe status String O is FAILURE This may include a list of one or more messages IDs if the failure involved the submission of invalid message IDs for example they were not returned from the associated retrieval request a R Required O Optional C Conditional Retrieve Patient Demo
52. below H Hispanic N Non Hispanic U Unknown For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC ethnicity code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 840 1 113883 6 238 amp code 2133 7 with a Concept Status Date of 09 26 2008 For example for Mexican American you would send 2149 3 If a value other than those in the CDC ethnicity code set is sent the patient s ethnicity will not appear in the Care360 Labs amp Meds user interface PID 23 Birth Place ST 60 Indicates the location of the patient s birth O PID 24 Multiple Birth Indicator ID 2 Indicates whether or not the patient was part of a multiple O birth Yes No indicator Valid values Y Yes N No blank The Data Exchange validates this field PID 25 Birth Order NM 2 When a patient was part of a multiple birth a number O indicating the patient s birth order is entered in this field PID 26 Citizenship IS 4 Contains the patient s country of citizenship O PID 27 Veterans Military CE 60 Contains the military status assigned to a veteran O 5tatus Only the first subfield Identifier is passed to Care360 Labs amp Meds PID 28 Nationality CD 80 Contains a code that identifies the nation or national O grouping to which the insured person belongs This information may be different from a person s citizenship in countries in which multiple nationalities are recognized
53. characters Alphanumeric data only O Address lt street address ST gt lt other designation ST gt lt city ST gt lt state or province ST gt lt zip or postal code ST gt country ID address type ID gt other geographic designation ST county parish code IS census tract IS gt The Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab gt Employer Information section GT118 Guarantor Employer X Phone Number GT119 Guarantor Employee X ID Number Patient Demographic HL7 Specification 86 Field Name Type Length Comments Req d GT1 20 Guarantor X Employment Status GT1 21 Guarantor X Organization Name GT1 22 Guarantor Billing X Hold Flag GT1 23 Guarantor Credit X Rating Code GT1 24 Guarantor Death X Date And Time GT1 25 Guarantor Death X Flag GT1 26 Guarantor Charge X Adjustment Code GT1 27 Guarantor X Household Annual Income GT1 28 Guarantor X Household Size GT1 29 Guarantor Employer X ID Number GT1 30 Guarantor Marital X Status Code GT1 31 Guarantor Hire X Effective Date GT1 32 Employment Stop X Date GT1 33 Living Dependency X GT1 34 Ambulatory Status X GT1 35 Citizenship X GT1 36 Primary Language X GT1 37 Living Arrangement X GT1 38 Publicity Indicator X GT1 39 Protection Indicator X GT1 40 Student Indicator X Patient Demog
54. delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name A family name ST given name ST gt middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID gt GT1 04 Guarantor Spouse X Name GT1 05 Guarantor Address XAD 106 No more than 106 characters Alphanumeric data only O lt street address ST gt lt other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt GT1 06 Guarantor Ph Num XTN 40 Accepted length of this field is 20 numeric characters No O Home dashes or other separating characters Example with country code and extension omitted 333 4445555 Example with country code 1 333 4445555 Patient Demographic HL7 Specification 159 Field Name Type Length Comments Req d GT1 07 Guarantor Ph Num XTN 40 Accepted length of this field is 20 numeric characters No O Business dashes or other separating characters Example with country code omitted 333 4445555 999 Example with country code 1 333 4445555
55. field must be populated with a T or a P Insurance Additional Info Optional not supported Insurance Additional Info Optional not supported Accident Information Optional not supported Universal Bill Information Optional not supported Universal Bill 92 Information Optional not supported Braces indicate where multiple items are allowed and brackets 1 indicate items that are optional Message Segment Specifications This section provides detailed specifications for each segment of an ADT A28 Patient Add and ADT A21 message Supported message segments include the following MSH Message Header Segment on page 67 EVN Event Type Segment on page 68 PID Patient Identification Segment on page 69 PD1 Patient Additional Demographic Segment on page 75 NK1 Next of Kin Segment on page 77 PV Patient Visit Data Segment on page 79 DG1 Diagnosis Segment on page 82 GT1 Guarantor Segment on page 84 N1 Insurance Segment on page 88 Notes ADT A28 and ADT A31 message segments that are not supported are not included in this section for detailed specifications refer to the HL7 2 3 Specification All date timestamps are set to Coordinated Universal Time UTC Patient Demographic HL7 Specification 66 MSH Message Header Segment The Message Header MSH segment defines the intent source destination and some specifics of t
56. following order R component separator repetition separator escape character and subcomponent separator Format amp These values are recommended by HL7 and are the only values supported The name of the sending application O MSH 04 Sending Facility HD 180 The sending facility Identifies the owner of the patient R data and who initiated the patient demographic request This value will be provided by Quest Diagnostics The Data Exchange verifies that the field is populated MSH 05 Receiving Application HD 180 The receiving application identifier O MSH 06 MSH 07 Receiving Facility HD Date Time of Message TS 180 26 The receiving facility The account number defined forthe R requester This value will be determined by the Client team and Quest Diagnostics The Data Exchange verifies that the field is populated The date and time that the sending system created the R message Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC The Data Exchange verifies that this field is populated and that the value complies with the format above MSH 08 Security MSH 09 Message Type CM The type of message being transmitted and the event R leading to the creation of the message Valid value A39 Merge Person Information MSH 10 Message Control ID ST 20 A number or other data that uniquely identifies the R message in
57. for all organizations with which the current partner application user is associated up to the maximum number of organizations allowed Usage The WSUserSummaryData object contains the user summary data that is returned The WSUserSummaryCounts object contained by WSUserSummaryData includes data for up to the maximum number of organizations allowed Method Signature WSUserSummaryData getCounts throws SOAPException getCountsByOrg Summary Retrieves user summary data from Care360 Labs amp Meds for one or more specific organization s with which the current partner application user is associated Usage The WSUserSummaryData object contains the user summary data that is returned Throws a SOAPException for the following conditions The method is called with an invalid orgUID either the orgUID does not exist in the system or the partner does not have access to the requested organization The method is called and passes more orgUIDs than the maximum allowed The method is called without passing in an orgUID User Summary Web Service API Reference 33 Method Description getCountsByOrg Method Signature continued WSUserSummaryData getCountsByOrg String orgUID D throws SOAPException getOrgs Summary Retrieves a list of organizations with which the partner application user is associated Usage The WSOrgData object contains the list of organizations array of WSOrg objects that is returned Method Signature WSOrgDa
58. gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt CCR Message Specification 192 lt ActorRole gt lt Actor gt lt Source gt lt Actor gt lt Actors gt lt ContinuityOfCareRecord gt CCR Message Specification 193 Glossary Acknowledgment ACK A message indicating that an action such as downloading a lab result has successfully been accomplished See also Negative Acknowledgment NAK Admission Discharge Transfer ADT A type of HL7 message used to communicate patient details to external applications Patient Administration ADT messages are used to exchange the patient state within a health care facility ADT messages keep patient demographic and visit information synchronized across health care systems See also Health Level Seven HL7 Advanced Beneficiary Notice ABN A form in PDF format that notifies a patient when Medicare will not cover the costs of the ordered tests based on an evaluation of the submitted CPT and ICD codes Detail Financial Transaction DFT A type of HL7 message used to describe a financial transaction transmitted between systems that is to the billing system for ancillary charges ADT to billing system for patient deposits etc Electronic Health Record EHR The Electronic Health Record EHR is a longitudinal electronic record of patient health information generated by one or more encounters in a
59. is not currently supported nor is the ability for a partner application to push financial transactions to Care360 Labs amp Meds The types of patient demographic updates supported by the Submit Patient Demographic web service include the following Patient Add ADT A28 Patient Update ADT A31 Patient Delete ADT A29 Patient Merge ADT A39 Schedule Patient SIU including New Appt SIU S12 Modify Appt SIU S14 Cancel Appt SIU S15 Delete Appt SIU S17 Detail Financial Transaction DFT PO3 The Data Exchange maintains a record of all patient demographic transactions that occur whether they are initiated by Care360 Labs amp Meds or by a partner application Any errors that occur between the Data Exchange and Care360 Labs amp Meds or a partner application are returned to the Data Exchange Notes Fordetailed specifications on the HL7 demographic ADT scheduling SIU and billing DFT messages that are sent either to or from the Data Exchange refer to Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Outbound push services to a partner application for demographic and or billing updates requires additional configuration Contact Quest Diagnostics support for more information A separate web service the Retrieve Patient Demographic web service enables a partner application to retrieve pull and acknowledge patient demographic ADT and billing DFT updates submitted by Care36
60. its transmission to the receiving system The Data Exchange verifies that this field is populated Patient Demographic HL7 Specification 104 Field Name Type Length Comments Req d MSH 11 Processing ID PT 3 The placer system s intent for the message Valid values R include P Production T Testing The Data Exchange verifies that the value in this field is P or T MSH 12 Version ID ID 8 The value for this field is 2 3 R SH 13 Sequence Number X SH 14 Continuation Pointer X SH 15 Accept X Acknowledgment Type SH 16 Application X Acknowledgment Type SH 17 Country Code X SH 18 Character Set X SH 19 Principal Language of X Message EVN Event Type Segment The Event Type EVN segment is used to communicate necessary trigger event information to receiving applications Field Name Type Length Comments Req d EVN OO Segment Type ID ST 4 Must be EVN R EVN O1 Event Type Code ID 3 The second component trigger event of MSH 09 R Message Type should be used to transmit event type code information This field contains the events corresponding to the trigger events described in this section Valid value A39 Note This field has been retained for backward compatibility only EVN O2 Recorded Date Time X EVN 03 Date Time Planned X Event EVN 04 Event Reason Code X EVN O5 Operator ID X Patient Demographic HL7 Specification 105 Field Name Type Length Comments
61. minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name RetrievalResult gt lt xs complexType gt lt xs Sequence gt lt xs element name Retrievalld type xs string gt lt xs element name RequestedBatchSize type xs int gt lt xs element name ActualBatchSize type xs int gt lt xs element name isMore type xs boolean gt lt xs element name Status type tns statusType gt lt xs element name ErrorDescription type xs string minOccurs 0 gt lt xs element name RetrievalResultItem type tns retrievalResultItemType minOccurs 0 maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name ackDemographicMessages type tns ackDemographicMessages gt lt xs element name ackDemographicMessagesResponse type tns ackDemographicMessagesResponse gt lt xs element name retrieveDemographicMessages type tns retrieveDemographicMessages gt lt xs element name retrieveDemographicMessagesResponse type tns retrieveDemographicMessagesResponse gt Retrieve Patient Demographic Web Service API Reference 57 lt xs complexType name retrieveDemographicMessages gt lt xs Sequence gt lt xs element name RetrievalRequest form unqualified minOccurs 0 gt lt xs complexType gt lt xS Sequence gt lt xs element name RequestedBatchSize type xs int minOccurs 0
62. primary identifier or other identifiers used by the O facility to identify a patient uniquely for example medical record number billing number birth registry etc This is the patient identifier associated with the non Care360 system and it is not always available within Care360 Patient Demographic HL7 Specification 141 Field Name Type Length Comments Req d PID O4 Alternate Patient ID X PID PID O5 Patient Name XPN 48 No more than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name family name ST given name ST middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID The Data Exchange verifies that the field length complies with the rules above PID 06 Mother s Maiden X Name PID O7 Date Time of Birth TS 26 Patient DOB O Format yyyymmdd PID 08 Sex IS 1 Possible values are listed below O M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated blank PID 09 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suffix Prefix and Degree are passed from Care360 Labs amp Meds
63. specification 176 Retrieve Patient Demographics Services 51 SSO implementation 21 Submit Patient Demographics Services 39 User Summary Services 32 P Patient context maintaining 4 Patient demographic ADT A28 Patient Add message specifications 65 91 ADT A29 Patient Delete message specifications 92 102 ADT A31 Patient Update message specifications 65 91 ADT A39 Patient Merge message specifications 103 115 DFT Detail Financial Transaction message specifications 138 165 ethnic group ADT A28 74 ethnic group ADT A31 74 ethnic group DFT 146 ethnic group SIU 128 language ADT A28 73 language ADT A31 73 language DFT 144 language SIU 126 language values supported by Care360 Labs amp Meds 168 174 race ADT A28 71 race ADT A31 71 race DFT 143 race SIU 125 Index 199 Patient demographic continued sample messages 166 167 SIU Schedule Information Unsolicited message specifications 116 137 Patient Demographic HL7 specification inbound feeds 63 message segment requirements 64 outbound feeds 63 overview 63 Patient demographic integration availability with Care360 Labs amp Meds 2 batch mode 40 definition vii methods 40 real time mode 40 Patient demographic message segment requirements AIG fields SIU 134 135 AIL fields SIU 135 AIP fields SIU 136 137 AIS fields SIU 133 DGI fields ADT A28 82 83 DG1 fields ADT A31 82 83 DG1 fields DFT 156 158 DG1 fields SIU 131 133 EVN fields AD
64. the landing page from a successful SSO authentication and is irrelevant to the subsequent web service call Care360 Labs amp Meds SSO Specification 30 Chapter 3 User Summary Web Service API Reference In This Chapter About the User Summary Web Service a nn nan Ee En EA Eee ee SA n User Summary Web Service API Reference 2 0 0 6 cic cence nee ene EEEREN ET teen babe PA e 3Aboubthe WSDL interacts Document rerien reati entio teena EE EEE eR PPRPEeUEAR Eden FORET Ner tees eau 31 About the User Summary Web Service When new lab results or user messages are received by Care360 Labs amp Meds for a user or an organization the partner application can automatically receive notification of their availability These user summary notifications enable the partner application to display related counts for affected patients rather than requiring users to access Care360 Labs amp Meds on a regular basis to view the information When the user summary notification indicates that new information is available within Care360 Labs amp Meds the user can access the desired Care360 Labs amp Meds function to view the associated data Specific data counts that can be communicated to the partner application include the following New results including Abnormals Partials Partials Abnormals and Finals Message counts including user messages and failed faxes Action Items including Failed Faxes Pending Renewals and Pending Approvals
65. to submit your feedback Email your responses To send your responses to us electronically click Submit by Email Your default email application is used to email the form content to us Print the form To print the completed form and then mail or fax it to us click Print Form Our address and fax number appear at the bottom of the form Thank you 202 nm Quest 4 GS Diagnostics 3 Giralda Farms Madison NJ 07940 Care360 com
66. whenever possible and should appear as shown below Care360 Labs amp Meds The registered trademark symbol 9 must always follow Care360 Ifthe partner application will display a Care360 logo the following logo must be used Care360 Note You can obtain the Care360 logo from the Care360 Labs amp Meds SSO and Web Services site For more information see About the Care360 SSO and Web Services Site on page 14 Prior to appearing in a production environment any links to Care360 Labs amp Meds must be submitted through the project manager for compliance review and approval Linking to Care360 Labs amp Meds 3 About Single Sign On SSO When a partner application establishes a link to Care360 Labs amp Meds the user of the partner application can transparently log in to Care360 Labs amp Meds via the SSO capability That is the user is not required to log in separately to Care360 Labs amp Meds in order to use its services This allows the user s workflow to continue uninterrupted and reduces the number of steps and pages necessary for the user to complete a task The basic steps to establish an SSO connection to Care360 Labs amp Meds are as follows 1 An authorized user logs in to the partner application 2 Within the partner application the user activates a link to the desired Care360 Labs amp Meds function and is immediately redirected to the appropriate area of Care360 Labs amp Meds If possible the user
67. 0 Labs amp Meds For more information about the Retrieve Patient Demographic web service refer to Chapter 5 Retrieve Patient Demographic Web Service API Reference beginning on page 50 Submit Patient Demographic Web Service Connectivity The transfer of all patient demographic updates between a partner application and the Data Exchange will occur via the Submit Patient Demographic web service HTTPS Note For details of the Patient Demographic web service see Submit Patient Demographic Web Service API Reference on page 45 Submit Patient Demographic Web Service API Reference 39 Real Time vs Batch Processing Patient demographic update messages can either be submitted individually for real time updates that will be processed immediately or they can be submitted individually for batch processing that will occur at a later time Unlike real time updates that are processed immediately HL7 messages that are submitted for batch processing are placed in a queue Use real time updates for submitting individual patient demographic update messages that are time sensitive Use batch updates for submitting a large number of individual patient demographic messages that are not time sensitive For example use batch updates to process the initial patient demographic data load between a partner application and Care360 Labs amp Meds Both update types are processed in the order in which they are received by Care360 Labs amp Meds To d
68. 0 Race CE 250 Repeating field with a maximum of three instances O allowed This field supports both HL7 2 3 and HL7 3 0 values For HL7 2 3 values supported by Care360 Labs amp Meds are listed below W White B Black A Asian American Indian or Alaskan O Other For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC race code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 8401 113883 6 238 amp code 1000 9 with a Concept Status Date of 09 26 2008 Because this is a repeating field for a patient whose race is Apache 1010 8 White 2106 3 and Asian 2028 9 for example you would send all three of the codes 1010 8 2106 3 2028 9 Patient Demographic HL7 Specification 96 Field Name Type PID 11 Patient Address XAD Length Comments Req d 106 No more than 106 characters however limits may apply O to some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only lt street address ST gt lt other designation ST gt lt city ST gt or province ST gt lt zip or postal code ST gt lt country ID gt lt address type ID gt lt other geographic designation ST county parish code IS census tract IS gt state The Data Exchange verifies that the value complies with the rules abo
69. 00 9 with a Concept Status Date of 09 26 2008 Because this is a repeating field for a patient whose race is Apache 1010 8 White 2106 3 and Asian 2028 9 for example you would send all three of the codes 1010 8 2106 3 2028 9 If a value other than one of those in the CDC race code set is sent the patient s race will not appear in the Care360 Labs amp Meds user interface PID 11 Patient Address XAD 106 No more than 106 characters however limits may apply O to some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only street address ST other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt The Data Exchange verifies that the field length complies with the rules above PID 12 County Code X Patient Demographic HL7 Specification 125 Field Name Type Length Comments Req d PID 13 Phone Number Home XTN 40 Repeating field that can accept Home phone number O Cell Mobile phone number and email address Note the following If the Home phone number is sent it must be the first occurrence fthe Cell Mobile phone number is sent then lt telecommunication equipment type ID gt must equal CP If there is a Cell Mobile phone nu
70. 01 Y Yes N No P Pending blank PD1 12 Protection Indicator ID 1 Valid outbound values O Y Yes N No P Pending blank PV1 Patient Visit Data Segment The Patient Visit Data PV1 segment is used by registration patient administration applications to communicate information on a visit specific basis This segment can be used to send multiple visit statistic records to the same patient account or single visit records to more than one account Field Name Type Length Comments Req d PV1 00 Segment Type ID ST 4 Must be PV1 R PV1 01 Set ID SI 4 Will always be 1 O PV1 02 Patient Class IS 1 For outbound messages this value will be N Not R Applicable PV1 03 Assigned Patient X Location PV1 04 Admission Type X PV1 05 Preadmit Number X PV1 06 Prior Patient Location X PV1 07 Attending Doctor X PV1 08 Referring Doctor X PV1 09 Consulting Doctor X PV1 10 Hospital Service X PV1 11 Temporary Location X Patient Demographic HL7 Specification 148 Field Name Type Length Comments Req d PV112 Preadmit Test Indicator X PV1 13 Readmission Indicator X PV114 Admit Source X PV115 Ambulatory Status X PV116 VIP Indicator X PV117 Admitting Doctor X PV118 Patient Type X Patient Demographic HL7 Specification 149 Field PV119 Name Visit Number Type CX Length Comments 20 Format ID ST check digit ST code identifyi
71. 1 O PV1 02 Patient Class IS 1 For inbound messages Data Exchange verifies that this field R is populated Example values include E Emergency Inpatient O Outpatient For outbound messages this value will be N Not Applicable PV1 03 Assigned Patient X Location PV1 04 Admission Type X PV1 05 Preadmit Number X PV1 06 Prior Patient X Location PV1 07 Attending Doctor X PV1 08 Referring Doctor X Patient Demographic HL7 Specification 79 Field Name Type Length Comments Req d PV1 09 Consulting Doctor X PV1 10 Hospital Service X PV1 11 Temporary Location X PV112 Preadmit Test X Indicator PV113 Readmission X Indicator PV114 Admit Source X PV115 Ambulatory Status X PV116 VIP Indicator X PV1 17 Admitting Doctor X PV118 Patient Type X PV119 Visit Number X PV1 20 Financial Class X PV1 21 Charge Price X Indicator PV1 22 Courtesy Code X PV1 23 Credit Rating X PV1 24 Contract Code X PV1 25 Contract Effective X Date PV1 26 Contract Amount X PV1 27 Contract Period X PV1 28 Interest Code X PV1 29 Transfer to Bad Debt X Code PV1 30 Transfer to Bad Debt X Date PV1 31 Bad Debt Agency X Code PV1 32 Bad Debt Transfer X Amount Patient Demographic HL7 Specification 80 Field Name Type Length Comments Req d PV1 33 Bad Debt Recovery X Amount
72. 26 Contains the date and time at which the patient death O Time occurred in the following format Inbound yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats Outbound yyyymmdd PID 30 Patient Death Indicator ID 1 Indicates whether or not the patient is deceased Yes No O PV1 Patient Visit Data Segment indicator Valid values Y Yes N No blank The Data Exchange validates this field The Patient Visit Data PV1 segment is used by registration patient administration applications to communicate information on a visit specific basis This segment can be used to send multiple visit statistic records to the same patient account or single visit records to more than one account Field Name Type Length Comments Req d PV1 00 Segment Type ID ST 4 Must be PV1 R PV1 01 Set ID SI 4 Will always be 1 O PV1 02 Patient Class IS 1 For inbound messages Data Exchange verifies that this R field is populated Example values include E Emergency Inpatient O Outpatient For outbound messages this value will be N Not Applicable PV1 03 Assigned Patient X Location PV1 04 Admission Type X PV1 05 Preadmit Number X PV1 06 Prior Patient Location X PV1 07 Attending Doctor X PV1 08 Referring Doctor X Patient Demographic HL7 Specificat
73. 56 cG 4007 1 10 DC1bC1 PCiDCiText I9 PCi1DC2 PCiDC 2Text I9 738492 PATIENT NAME NPI 738492 PATIENT NAME NPI PC1 PCibESC CPT PCiM1 PCi MIDESC MOD PC1M2 PCIM2DESC MOD PR1 i PCi PCiDbESC CPT 20120207112233 PCc13DC1 PCiDCiText i9 PCiDC2 PCiDC2Text ri9 FT1 2 20120207113344 20120401182956 CG 4007 1 10 Cc1bCi PCibCiText r9 PCiDbC2 PCipC 2Text 19 738492 PATIENT NAME NPI 738492 PATIENT NAME NPT PCL PC1DESC CPT PC1M1 PC1 M1DESC MOD PC1M2 PC1M2DESC MOD PR1 2 PC2 PC1DESC CPT 20120207113344 Ppc2Dc1 pc2DCc1Text i9 PC1DC2 PC2DC2Text 19 Patient Demographic HL7 Specification 167 About Patient Demographic Reference Data This section lists patient demographic data thatis accepted by Care360 Labs amp Meds and that is not available in total from other sources such as the official HL7 web site Centers for Disease Control and Prevention CDC web site etc This patient demographic data is used in ADT A28 Patient Add and ADT A31 Patient Update Message Segment Specifications on page 65 For patient language PID 15 Care360 Labs amp Meds supports a subset of the ISO 639 2 languages For more information see Patient Language PID 15 on page 168 Patient Language PID 15 The patient languages supported by Care360 Labs amp Meds are a subset of the ISO 639 2 languages provided by the Library of Congress http www loc gov s
74. Appointment ID EI 75 On initial request and other messages where a filler has C not yet assigned a filler appointment ID this field should not contain a value In all subsequent messages where a filler application has assigned a filler appointment ID and communicated it to other applications this field is required SCH 03 Occurrence Number NM 5 If the transaction using this segment is meant to apply to C only one occurrence of a repeating appointment and an occurrence number is required to uniquely identify the child appointment that is the child does not have a separate and unique placer appointment ID or filler appointment ID then this field is required SCH 04 Placer Group Number EIl 75 O Patient Demographic HL7 Specification 119 Field Name SCH 05 Schedule ID Type CE Length Comments Req d 200 Contains an identifier code for the schedule in which this O appointment is or will be booked This field is provided for instances in which filler applications maintain multiple schedules and when a particular resource or set of resources is controlled by more than one of those schedules Format lt identifier ST text ST gt name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST gt SCH 06 Event Reason CE 200 Contains an identifier code for the reason that the notification event was triggered This field may conta
75. Catalan etc Only the first subfield Identifier is passed from Care360 Labs amp Meds Patient Demographic HL7 Specification 146 Field PID 29 Name Type Length Comments Patient Death Date amp TS 26 Time occurred Format yyyymmdd Contains the date and time at which the patient death Req d O PID 30 Patient Death Indicator ID 1 Y Yes NS No blank The Data Exchange validates this field Indicates whether or not the patient is deceased Yes No O indicator Valid values PD1 Patient Additional Demographic Segment The Patient Additional Demographic PD1 segment contains demographic information that is likely to change about the patient Field Name Type Length Comments Req d PD1 00 Segment Type ID ST 4 Will always be PD1 R PD1 01 Living Dependency X PD1 02 Living Arrangement X PD1 03 Patient Primary Facility X PD1 04 Patient Primary Care X Provider Name amp ID No PD1 05 Student Indicator X PD1 06 Handicap X PD1 07 Living Will X PD1 08 Organ Donor X PD1 09 Separate Bill X PD1 10 Duplicate Patient X Patient Demographic HL7 Specification 147 Field Name Type Length Comments Req d PD1 11 Publicity Indicator CE 1 Format identifier ST text ST O name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST Valid outbound values for PD1 11
76. GAN 32 User Summary Web Service API Referent asd os dorada DPA cop A eR e ban C AO be bacs bau Fl Iced cop dO did 23 sar Summary Wen Serice Meds xi snoquoqep etas tpe quo pq oae AE vinDI qi QU P9 pim 33 User Summary Web Service Objects 2 0 ccc ccc e e s 34 About ine VSD a DOG dari PRPEPERERUM P CU rET SQ pREERMTISDIR MUR AA TII TRPRA 36 Accessing the User Summary Web Service WSDL Document a pga sa aa akan an ns 36 Chapter 4 Submit Patient Demographic Web Service API Reference ssseeeseeeeese 38 About the Submit Patient Demographic Web Service ssisssssssssss ee n 39 Submit Patient Demographic Web Service Connectivity ekk 39 Real Time vs Bate Proce Sine oo oi dues dt emer sad bed oU dd bad UFU baro dud adl ace diui d ac d bake aude 40 PID Onlus FUZZY MANNE S ed estos ET RERIPRI DIES PO e eR DEP A a a A 40 Process Walkthrough Submitting Patient Demographic Updates en ann an aaa KEM AKA ee 43 Process Walkthrough Receiving Patient Demographic Updates erkk akai 44 Submit Patient Demographic Web Service API Reference ees 45 Submit Patient Demosraphles MBIOBS 122m a ena BA dh aa ped t DESEE Odd eda edi dud bes d dba 45 Submit Patient Demographics ODIBEDS reer eirette PORTIO NY PRU Y NEM PPP I MOT E POPE E REMEDIES 47 About tte VWSDLIGtentacs DOCUMEN 12s 4c dra 9580 AN S det 13 2 90 3 20 bR 64 GO Rd ria dU Rc ERR Ada 48 Accessing the Submit Patient Demographic Web Service WSD
77. HR Interfaces Programmer Reference Provides information on integrating a non Quest Diagnostics service provider laboratory and or third party electronic medical record EMR or electronic health record EHR application into the Care360 Labs amp Meds product suite The integration of a third party laboratory or EMR EHR application involves the following primary services Universal lab orders The ability to submit lab orders to a third party laboratory via Care360 Labs amp Meds or via a third party EMR EHR application Universal lab results The ability to receive test results and radiology results generated by a third party laboratory via Care360 Labs amp Meds or via a third party EMR EHR application Care360 Labs amp Meds User Manual Provides information on accessing and using the Care360 Labs amp Meds application which includes the integrated Lab Orders function Intended for end users of the application including physicians clinicians phlebotomists clinical office staff and administrative office staff Third Party Internet Resources The following is a list of third party resources available via the Internet that you can access for more information on specific programming subjects Subject Internet Resources Health Level 7 HL79 Health Level Seven HL7 Inc http www hl7 org SAML Security Assertion Markup Language http www oasis open org committees tc_home php wg_abbrev security SSL Certificates Veri
78. Id type xs string gt lt xs element name AckRequestItem type tns ackRequestItemType minOccurs 0 maxOccurs unbounded gt x8 Sequence lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs complexType name ackRequestItemType gt lt xs Sequence gt lt xs element name MessageId type xs string gt lt xs element name AckCode type tns ackCodeType gt lt xs sequence gt lt xs complexType gt lt xs complexType name ackDemographicMessagesResponse gt lt xs sequence gt lt xs element name AckResult form unqualified minOccurs 0 gt lt xs complexType gt Retrieve Patient Demographic Web Service API Reference 58 lt XS Sequence gt lt xs element name Status type tns lt xs element name ErrorDescription lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs SsimpleType name statusType gt lt xs restriction base xs string gt lt xs enumeration value SUCCESS gt lt xs enumeration value FAILURE gt lt xs restriction gt lt xs simpleType gt lt xs simpleType name ackCodeType gt lt xs restriction base xs string gt lt xs enumeration value ACK gt lt xs enumeration value NAK gt lt xs restriction gt lt xs simpleType gt lt xs schema gt statusType gt type xs string minOccurs 0 gt Retrieve Patient Demographic Web
79. L Document cece eee eens 48 Chapter 5 Retrieve Patient Demographic Web Service API Reference 50 About the Retrieve Patient Demographic Web Service nad a AE A AA Pe n 51 Process Walkthrough Retrieving Patient Demographic Updates 2 ccc ccc cnet en 52 Retrieve Patient Demographic Web Service API Reference cnet ens 53 Retrieve Patient Demographics Methods 0 0 c ccc ccc s ESE ne need eas 53 Retrieve Patient Dembsraphice ODISCIS Los Leosasad ddp bed bacs eda A eased aadedarcaeeae pees Bai dida 55 Retrieve Patient Demographic Web Service XML Schema ccc ccc eee n 57 About tie VW SDIL ee DOCUMENT oso r044 100 10t pur TTERICPO DEEP OT ORE IERPPTIS RPCPERPPPPISQOT POE TES REA 60 Accessing the Retrieve Patient Demographic Web Service WSDL Document eene 60 Chapter 6 Patient Demographic HL7 Specification s ss nn 62 About the Patient Demographic HE7 Specification 1 5 ec es cmekpneereckreer ee bera nav Chee ead eeu eX Pac ea aes 63 Patient Demographic Message Format Requirements iiis s 64 Newline Charce S ea e AA AA Edo eld dob vo bd dames Ke dab dedu 64 Field DEMIS eor carne PI Hao Aa PILOTO RM E p NT ee PERDER ERIS pK 64 Field SOBEHICSIIONS 2x 96pt ouis tipoen 1952 025 28 65 8 294 p UI CUR Aa at a d 64 ADT A28 Patient Add and ADT A31 Patient Update Message Segment Specifications 65 Message Segment Hiei
80. Labs amp Meds For the partner application to add new patients to Care360 Labs amp Meds the ADT A28 messages must be written to the specifications in this chapter Outbound Care360 Labs amp Meds to partner application or other entity ForCare360 Labs amp Meds to update the partner application with patients that were added to Care360 Labs amp Meds Care360 Labs amp Meds adheres to the ADT A28 message specification in this chapter so that the partner application knows what it will be receiving For a sample ADT A28 message see Sample 1 Add Patient on page 166 For Care360 Labs amp Meds to provide immunization reports to state and federal registries Care360 Labs amp Meds adheres to the ADT A28 message specification in this chapter The ADT A31 Patient Update message is used as follows Inbound partner application to Care360 Labs amp Meds For the partner application to update existing patients in Care360 Labs amp Meds the ADT A31 messages must be written to the specifications in this chapter Outbound Care360 Labs amp Medsto partner application For Care360 Labs amp Meds to update the partner application with changed patient information Care360 Labs amp Meds adheres to the ADT A31 message specification in this chapter For a sample ADT A31 message see Sample 3 Update Patient on page 166 Several of the inbound fields for the ADT 28 and ADT A31 messages populate the Care360 Labs amp Meds
81. Labs amp Meds server perspective the SSO handshake for web service usage is identical to the handshake for browser usage The primary difference from the partner application perspective is that instead of sending an HTML form to a web browser the application opens a direct HTTPS connection to the Care360 Labs amp Meds server It can then invoke a POST request to send the authentication information and receive a landing page response along with the Care360 Labs amp Meds session cookie Example 1 Traffic of HTTP SSL Request to Care360SSOSecurityCheck REQUEST POST care360 Care360SSOSecurityCheck HTTP 1 0 Host Care360 dev medplus com Content Length 6810 Content Type application x www form urlencoded User Agent SOATest X Care360 SessionForWebService true SAMLResponse PFJlc3BvbnNlIHhtbG5zPSJlcm RESPONSE HTTP 1 1 200 OK Date Mon 19 Mar 2010 15 28 42 GMT Pragma no cache Content Length 350 Content Type text html Expires Thu 01 Jan 2011 00 00 00 GMT Last Modified Mon 20 Nov 2009 16 23 24 GMT Set Cookie JSESSIONID F2sq7JLqQs19hkGfQfiv7qhlw2LrLgJT5NBz4HLYlYZybgPJr2y4 98796407 path Set Cookie securityCheckUri Care360SSOSecurityCheck Set Cookie IsSSOClient true Set Cookie sso lastKnownSessionId F2sq7JLqOs19hkGfOflv7ghlw2LrLgJT5NBz4HLYlYZybgPJr2y4 987964007 1174318122760 path Accept Ranges bytes Cache Control no cache Connection Close html head meta http equ
82. Matching Request Potential Results Add Patient If the incoming PID matches no existing patient in the target organization the patient is added Ifthe incoming PID matches a single patient in the target organization that patient is updated Ifthe incoming PID matches more than one existing patient Care360 Labs amp Meds returns an error to the partner application Update Patient fthe incoming PID matches no existing patient in the target organization the patient is added ftheincoming PID matches a single patient in the target organization that patient is updated Ifthe incoming PID matches more than one existing patient Care360 Labs amp Meds returns an error to the partner application Submit Patient Demographic Web Service API Reference 40 PID Only Matching Request Potential Results Delete Patient Iftheincoming PID matches no existing patient in the target organization Care360 Labs amp Meds returns an error to the partner application Ifthe incoming PID matches a single patient in the target organization that patient is deleted Ifthe incoming PID matches more than one existing patient Care360 Labs amp Meds returns an error to the partner application Merge Patients fthetarget organization contains no patient with the same PID for either the correct patient or the incorrect patient Care360 Labs amp Meds returns an error to the partner application Ifthe target organizatio
83. O have failed for the user from the specified organization orgFailedFaxCount The number of faxes that Int O have failed for the specified organization newUserMessageCount The number of user Int O messages for the user from the specified organization prescripPendingApprovalCount The number of Int O prescriptions for the user pending approval from the specified organization prescripPendingRenewalCount The numberof Int O prescriptions for the user pending renewal from the specified organization prescripFailedFaxCount The number of faxed Int O prescriptions that have failed for the user from the specified organization WSOrgData Contains the organization data returned by the getOrgs method Responses include maxOrgs The maximum number of organizations Long O that can be queried in a single call orgList An array of WSOrgs one for each WSOrg 1 O organization timeStamp The date and time at which the query DateTime O was run WSOrg Contains information returned about a particular organization Responses include orgName The common name of the organization String O orgUID The UID with which the organization is String R associated a R Required O Optional C Conditional User Summary Web Service API Reference 35 About the WSDL Interface Document In order to utilize a web service you must develop a web service client application A client application created fo
84. PV1 34 Delete Account X Indicator PV1 35 Delete Account Date X PV1 36 Discharge X Disposition PV1 37 Discharged to X Location PV1 38 Diet Type X PV1 39 Servicing Facility X PV1 40 Bed Status X PV1 41 Account Status X PV1 42 Pending Location X PV1 43 Prior Temporary X Location PV1 44 Admit Date Time X PV1 45 Discharge X Date Time PV1 46 Current Patient X Balance PV1 47 Total Charges X PV1 48 Total Adjustments X PV1 49 Total Payments X PV1 50 Alternate Visit ID X PV1 51 Visit Indicator X PV1 52 Other Healthcare X Provider Patient Demographic HL7 Specification 81 DG1 Diagnosis Segment The Diagnosis DG1 segment contains patient diagnosis information Note The DG1 segment is not generated on outbound Care360 Labs amp Meds to partner application messages Field Name Type Length Comments Req d DG1 00 Segment Type ID ST 4 Must be DG1 R DG1 01 Set ID Patient ID SI 4 Used to number DG1 message segments sequentially R beginning with 1 DG1 02 Diagnosis Coding ID 2 R Method DG1 03 Diagnosis Code CE 60 Format identifier ST text ST O name of coding system ST alternate identifier ST alternate text ST gt name of alternate coding system ST DG1 03 01 ICD 9 code DG1 03 03 19 This value appears on the External Diagnoses tab DG1 04 Diagnosis ST 40 Diagnosis name and description O Description This value appears on the External Diagno
85. Patient Demographic HL7 Specification 163 Field Name Type Length Comments Req d IN1 24 Notice Of Admission X Date IN1 25 Report Of Eligibility X Flag IN1 26 Report Of Eligibility X Date IN1 27 Release Information X Code IN1 28 Pre Admit Cert PAC X IN1 29 Verification Date Time X IN1 30 Verification By X IN1 31 Type Of Agreement X Code IN1 32 Billing Status X IN1 33 Lifetime Reserve Days X IN1 34 Delay Before L R Day X IN1 35 Company Plan Code X IN1 36 Policy Number ST 50 O IN1 37 Policy Deductible X IN1 38 Policy Limit Amount X IN1 39 Policy Limit Days X IN1 40 Room Rate Semi X Private INT 41 Room Rate Private X IN1 42 Insured s Employment X Status IN1 43 Insured s Sex X IN1 44 Insured s Employer X Address IN1 45 Verification Status X IN1 46 Prior Insurance Plan ID X Patient Demographic HL7 Specification 164 Field Name IN1 47 Coverage Type IN1 48 Handicap Type Length Comments Valid values include T Third party bill Req d IN1 49 Insured s ID Number Patient Demographic HL7 Specification 165 Sample Patient Demographic Messages Following are several sample patient demographic messages formatted according to the Patient Demographic Message Format Requirements on page 64 and the corresponding message segment specifications Patient Add Patient Delete Patient Update Patient Merge Sch
86. Patient addressline1 Social Security Number l H Address Line 2 Patient addressline2 Poo ooo f P p u p Patient Demographic HL7 Specification 65 Message Segment Hierarchy The ADT A28 and ADT A31 message segment hierarchy is specified below MSH IN2 IN3 1 ACC UB1 UB2 Message Header Required one per file Event Type Required Patient Identification Required Additional Demographics Optional Next of Kin Associated Parties Optional ignored on inbound messages Not present on outbound messages except for immunization registry reports Patient Visit Data Required Patient Visit Additional Info Optional not supported Disability Information Optional not supported Observation Result Optional not supported Allergy Information Optional not supported Diagnosis Information Optional not present on outbound messages Diagnosis Related Group Optional not supported Procedures Optional not supported Role Optional not supported Guarantor Optional forwarded to Care360 Labs amp Meds if provided The system can only handle one GTI There can be one Guarantor with two insurances but not two Guarantors Insurance Optional forwarded to Care360 Labs amp Meds if provided The first INT Primary Insurance is for Guarantor The second IN1 Secondary Insurance is for Guarantor if provided For the IN1 information to be stored by Care360 Labs amp Meds the IN1 47
87. R Creations Date Time Date Time that the CCR record was created R Date Time Date format is yyyy mm ddThh mm ss 00 00 The ExactDateTime element is defined as a xs string type Patient Patient Identifies the patient can be only one per CCR R Should equal an lt ActorObjectld gt of xs string type Define as Actors for the patient object Example Patient lt ActorID gt 0 c3299677 00010104507926bfbd a468 lt ActorID gt lt Patient gt CCR Message Specification 177 Attributes Data Objects XML Tag Comments Req d From lt From gt Identifies who created the prescription An Actor R and its Role must be specified under From Should equal an lt Actorld gt xs string defined in lt Actors gt and lt ActorRole gt with the lt Text gt Primary Care Provider lt Text gt xs string Example lt From gt lt ActorLink gt ActorID 20c32996a7 00010104507926d8e 440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt ActorLink gt lt From gt To Not currently used NS Purpose Not currently used NS Body lt Body gt Structural grouping element Payers ot currently used S Advanced ot currently used S Directives Support ot currently used S Functional ot currently used S Status Problems ot currently used S Family History ot currently used S Social History ot curre
88. ROI OR 097505 0 5 QUEE IAE CDU E CREE Pod dn 2 603654150 04 168 Chapter 7 CCR Message Specification 1422242242552 44x ERR TERRE X RLEAQEA NARRA RE ARA craven 175 About the CCR Message SPECIEM 2539240 202i de ou qu 9 oT TIDOD DAR qe MER Pb dg edic quat d eb pd Ed 176 QST er ease cT nerr 177 Sample c CRMOSSHBE aa Pd DH IUD ND MIB RUIN E MEE PEDI EE NE pa Oque deus Rt 188 AD PEE ERE TI ETT T T UO OT ae LITT ETT I TIT LI 194 BUB Loser ederpeiend AAA deir E NA DE ESQ neues AAA P D pU EE 198 Wege do Hesr From VOU is uiuo Ry E ERE NPVRER PEINT FREE REIP aNPRUATWG FEN RENE TRCSEEME 202 Table of Contents v About This Manual In This Section ea Tai Aan AN ANA Aa aaa a Aa a genes vii Wis sew This Relea pa tt poer AA A na a a a viii Documentation Conventions 22 1 9 ePO HERR ve Seb dha kee doateeww ih Sb VER EA d ER E M edd ix NA dd cO TIS arbe sum peo qe Pa LU NO EAE M PVP NO qe tar T e TI Sv X Related DOCUMEMIANIGN 1 504204 oe Pe DAE dec PAN AN bd daa aha xii vi Introduction This Care360 Linking and Single Sign On SSO Programmer Reference provides information on integrating a third party electronic medical record EMR application into the Care360 Labs amp Meds product suite The linking and single sign on features allow a third party EMR to directly access specific functions of Care360 Labs amp Meds via single sign on SSO Additional services available to a linked application include the foll
89. S 2 X Code DG1 11 Outlier Type CE 60 X DG1 12 Outlier Days NM 3 X DG113 Outlier Cost CP 12 X DG1 14 Grouper Version and ST 4 X Type DG1 15 Diagnosis Priority NM 2 X DG1 16 Diagnosing Clinician XCN 60 O Patient Demographic HL7 Specification 157 Field Name Type Length Comments Req d DG117 Diagnosis IS 3 Classification Valid values O C Consultation D Diagnosis M Medication antibiotic O Other R Radiological scheduling not using ICDA codes S Sign and symptom T Tissue diagnosis Invasive procedure not classified elsewhere LV catheter etc DG1 18 Confidential Indicator ID 1 Valid values O Yz Yes N No DG1 19 Attestation Date Time TS 26 X Patient Demographic HL7 Specification 158 GT1 Guarantor Segment The Guarantor GT1 segment contains guarantor for example the person or the organization with financial responsibility for payment of a patient account data for patient and insurance billing applications This segment is applicable only for patient and insurance billing Note If the guarantor name is blank in Care360 Labs amp Meds the GT1 segment is not created in outbound messages Field Name Type Length Comments Req d GT1 00 Segment Type ID ST 4 Must be GTI R GT1 01 Set ID SI 4 Used to number GT1 message segments sequentially R beginning with 1 GT1 02 Guarantor Number X GT1 03 Guarantor Name XPN 48 No more than 48 characters including the
90. S17 Delete Appt DFT DFT POS3 Detail Financial Transaction No Yes This chapter includes the following sections Patient demographic message format requirements For information on the message format requirements see Patient Demographic Message Format Requirements on page 64 Patient demographic message segment specifications Each message contains a number of standard sections For requirements on the standard segments of a message see the following ADT A28 Patient Add and ADT A31 Patient Update Message Segment Specifications on page 65 ADT A29 Patient Delete Message Segment Specifications on page 92 ADT A39 Patient Merge Message Segment Specifications on page 103 SIU Schedule Information Unsolicited Message Segment Specifications on page 116 DFT PO3 Detail Financial Transaction Message Segment Specifications on page 138 Samplepatient demographic messages For samples of the various patient demographic messages see Sample Patient Demographic Messages on page 166 Patient Demographic HL7 Specification 63 Patient Demographic Message Format Requirements The following requirements apply to all of the patient demographic message types described in this chapter Newline Characters Patient demographic HL7 messages must use the carriage return CR character ASCII OxOD to indicate a newline Patient demographic messages that contain a line feed LF character ASCII OxOA t
91. SAML library or application installed within the partner application environment a SAML assertion is created This assertion contains the user identity Nameldentifier the partner s Issuer value and a precise and current timestamp based on Greenwich Mean Time GMT 4 TheSAML assertion is signed The partner site s private key is used to digitally sign the SAML assertion An encoded copy of the resulting signature and an encoded copy of the partner site s public key are coupled with the SAML assertion to form a SAML response This is referred to as a SAML response as opposed to a request Refer to the Oasis website for a detailed explanation of each 5 TheSAML response assertion signature is transmitted to Care360 Labs amp Meds via HTTP SSL The SAML response is POSTed to the following URL https portal Care360 com Care360 Care360SSOSecurityCheck The following parameters are passed within the form using the standard application x www form urlencoded format Parameter Description Example Value Req d Default Process Control Parameters care360Transaction A Base64 encoded Care360 Base64 encoded N Transaction Document containing an c360 Care360Transacti A31 XML message on gt lt c360 Care360Tr ansaction payload SAMLResponse A Base64 encoded copy of the SAML Base64 encoded copy ofthe Y response XML message lt saml Response gt lt sa ml Response gt payload Care360 Labs amp Meds SSO Specific
92. SIONID F2sq7JLqQs19hkGfQflv7qhlw2LrLgJT5NBz4HLYlYZybgPJr2y4 987964007 securityCheckUri Care360SSOSecurityCheck IsSSOClient true sso lastKnownSessionId F2sq7JLqQs19hkGfOQflv7qhlw2LrLgJT5NBz4HLYlYZybgPJr2y4 987964007 1174318122760 SOAP ENV Envelopes lt SOAP ENV Body nsl getOrgs SOAP ENV encodingStyle http schemas xmlsoap org soap encoding gt lt ns1 getOrgs gt SOAP ENV Body SOAP ENV Envelope RESPONSE HTTP 1 1 200 OK Date Mon 19 Mar 2010 16 24 18 GMT Content Length 938 Content Type text xml charset UTF 8 Connection Keep Alive lt xml version 1 0 encoding UTF 8 gt lt env Envelope xmlns env http schemas xmlsoap org soap envelope xmlns soapenc http schemas xmlsoap org soap encoding xmlns xsd http www w3 org 2001 XMLSchema mlns xsi http www w3 org 2001 XMLSchema instance gt env Body env encodingStyle http schemas xmlsoap org soap encoding gt m getOrgsResponse xmlns m http www Care360 com services gt result xmlns nl java com medplus Care360 ws org model xsi type n1 WSOrgData gt lt maxOrgs xsi type xsd long gt 6 lt maxOrgs gt orgList soapenc arrayType n1 WSOrg 5 gt WSOrg xsi type n1 WSOrg gt lt orgName xsi type xsd string gt AUTO LNR US04 lt orgName gt orgUID xsi type xsd string gt 2c928dc01195313601119ald0bb700 5 lt orgUID gt lt WSOrg gt WSOrg xsi type n1 WSOrg gt lt orgName xsi type xsd string gt AUTO LNR US05
93. Schedule Patient MSH amp PD ACCT C360PD PA1 20090624094442 SIU S12 MSGID100 P 2 3 SCH APPID APP FILL 1 ID REASON ROUTINE TEXT NORMAL TEXT 20120219094442 20120219094442 PLACER PERSON ADDR1 ADDR2 CONTACT PERSON ENTERED FIRST MIDDLE PENDING PID 1 pid123 LH PATIENT LASTNAME PATIENT FIRSTNAME M 20000101153336 F ALIAS LASTNAME ALI AS FIRSTNAME 4690 Parkway Dr Mason OH 45040 USA 86 999 9999999 99999 e 513 9999998 a5 L FOUND 444669999 PV1 1 0 123 456 789 E preadmit pri loc bed 1234pb Dr M D LastName FirstName M Y Y ER y 1 al i19960706 77 y Y Y 19960708 77 11 9 e19960708 77 7 19960708 06 home 1998 N MA C I pendloc 199709090800 77 77 77 77 DG1 1 CODEID DIAGCODE 19 DESCIGNORED 20090219094442 A ID1l23 CLINICIAN_LASTNAME CLINICIAN FIRSTNAME J JR DR MD C Y DG1 22 CODE222 DIAGCODE2 19 DESCIGNORED2 20090119094442 A ID456 CLINICIAN LASTNAME CLINICIAN FIRSTNAME J DR MD M N RGS 1 U GRPID AIP 1 D ID345 RESOURCE FIRSTNAME LASTNAME DR MD UPIN ROLE 7 Sample 6 Detail Financial Transaction MSH amp SENDING FACILITY RECEIVING APPLICATION RECEIVING FACILITY 20120401142955 DFT P03 127723 P 2 3 EVN P03 PID 1 12365966191815042004 PATIENT LASTNAME PATIENT FIRSTNAME A Pvi li N H pp HELL apprp ape FT1 1 20120207112233 201204011829
94. Sending Application The name of the sending application X MSH 04 Sending Facility HD 180 The sending facility This identifies the owner of the R patient data and who initiated the request MSH 05 Receiving Application The receiving application identifier X Patient Demographic HL7 Specification 139 Field Name Type Length Comments Req d MSH 06 Receiving Facility HD 180 The receiving facility The account number defined forthe R requester MSH 07 Date Time of Message TS 26 The date and time that the sending system created the R message Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC MSH 08 Security X MSH 09 Message Type CM 7 The type of message being transmitted and the event R leading to the creation of the message Acceptable values for this field DFT P03 MSH 10 Message Control ID ST 20 A number or other data that uniquely identifies the R message in its transmission to the receiving system MSH 11 Processing ID PT 3 The placer system s intent for the message Valid values R include P Production T Testing MSH 12 Version ID ID 8 The value for this field is 2 3 R SH 13 Sequence Number X SH 14 Continuation Pointer X SH 15 Accept X Acknowledgment Type SH 16 Application X Acknowledgment Type SH 17 Country Code X SH 18 Character Set X SH 19 Principal Language of X Message Patient Demogra
95. Sign SSL Certificates http www verisign com products services security services ssl About This Manual xii Chapter 1 Linking to Care360 Labs amp Meds In This Chapter a A AN aaa a aaa a P 2 Customizing the Care360 Labs amp Meds User Interface senak kakak 11 About the Care360 SSO and Web Services Site 2 0 a aa ana e ren nne n E ERR ERR RARE ERROR ERO E RR RR RR 14 ABON oC CB EC a peoTe b tI P DEEP PEST I Und qe I RECO Ida ATO Eq getan 1g bo ADOM RO Ode ECHO en cu Theose SARAAN AMAN S260 OD ATP de SENE do dis SAN ks bu SEGMEN Pedes 18 About Linking and Single Sign On SSO This chapter provides information about linking from a partner application for example an electronic medical record EMR application electronic health record EHR application or practice management system PMS to Care360 Labs amp Meds Application linking enables the partner application to directly access specific functions of Care360 Labs amp Meds from within the context of the partner application Linking to Care360 Labs amp Meds enables a partner application to effectively offer lab order and result services through an existing EMR solution Users can launch directly into a specific Care360 Labs amp Meds function using SSO and maintaining their current patient context SSO access allows the user to transparently log in to Care360 Labs amp Meds from within the partner application For more information ab
96. T A28 68 EVN fields ADT A29 94 EVN fields ADT A31 68 EVN fields ADT A39 105 EVN fields DFT 141 FT1 fields DFT 152 155 GTI fields ADT A28 84 88 GTI fields ADT A31 84 88 GTI fields DFT 159 162 IN1 fields ADT A28 88 91 IN1 fields ADT A31 88 91 IN1 fields DFT 162 165 MRG fields ADT A39 111 MSH fields ADT A28 67 68 MSH fields ADT A29 93 94 MSH fields ADT A31 67 68 MSH fields ADT A39 104 105 MSH fields DFT 139 140 MSH fields SIU 117 118 NK1 fields ADT A28 77 79 PD1 fields ADT A28 75 77 109 110 PD1 fields ADT A31 75 77 109 110 PD1 fields DFT 147 148 PID fields ADT A28 69 75 PID fields ADT A29 95 100 PID fields ADT A31 69 75 PID fields ADT A39 106 109 112 115 PID fields DFT 141 147 PID fields SIU 123 129 PRI fields DFT 155 156 PV1 fields ADT A28 79 81 PV1 fields ADT A29 100 102 PV1 fields ADT A31 79 81 PV1 fields DFT 148 152 PV1 fields SIU 129 131 RGS fields SIU 133 SCH fields SIU 119 123 Patient Demographics Services see Retrieve Patient Demographics Services or Submit Patient Demographics Services Patient demographics HL7 specification 63 oo NI NI D PD1 field requirements DFT 147 148 field requirements patient demographic ADT A28 75 77 109 110 d requirements patient demographic ADT A31 75 77 109 110 Pharmacy Benefit Manager PBM definition 196 PID fi o eld requirements DFT 141 147 eld requirements patient demographic
97. THE INFORMATION TEXT GRAPHICS OR OTHER ITEMS CONTAINED WITHIN THESE MATERIALS IN NO EVENT SHALL QUEST DIAGNOSTICS AND OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL INDIRECT INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING WITHOUT LIMITATION LOSS OF USE DATA OR PROFITS WHICH MAY ARISE OUT OF OR IN CONNECTION WITH THE USE OF THESE MATERIALS THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS THE INFORMATION CONTAINED IN THIS DOCUMENT IS PERIODICALLY CHANGED WITHOUT NOTICE QUEST DIAGNOSTICS MAY MAKE IMPROVEMENTS AND OR CHANGES IN THE PRODUCT S AND OR THE SOFTWARE DESCRIBED IN THIS DOCUMENT AT ANY TIME RESTRICTED RIGHTS LEGEND All Quest Diagnostics products and publications are commercial in nature Use duplication or disclosure by the U S Government is subject to restrictions of FAR 52 227 14 and FAR 52 227 19 or DFAR 252 227 7015 and DFAR 227 7202 3 Any rights not expressly granted herein are reserved Table of Contents About VES ib VERAS PEDES VEREOR RI A DA A vi an ea NA A TETTE TIT EA T A N A A T EEA A E E E A vii BIDS ETE e nm TEE a FPES vii Windes Newin THIS Reeds Essia aaa aeaa aaa eR PSI aa raa viii Documentation CONVE ONS i sd d dace dub Qi Ru CR OE AAA A AA hea AA SA epp bed dee dor Vend A Kn ix Abbreviations ane JUOD VES uid qa desc eoe ene dar qon dot adn ta Ra bap quan deb domo poe Rabe bar epa Rae a delis x Related DOCU TE READING o2 20523 5d pns tbo t eese Seba be doprbrbeRbebterbebba
98. X Balance PV1 47 Total Charges X PV1 48 Total Adjustments X PV1 49 Total Payments X PV1 50 Alternate Visit ID X PV1 51 Visit Indicator X PV1 52 Other Healthcare X Provider DG1 Diagnosis Segment The Diagnosis DG1 segment contains patient diagnosis information Field Name Type Length Comments Req d DG1 00 Segment Type ID ST 4 Must be DG1 R DG1 01 Set ID Patient ID SI 4 Used to number DG1 message segments sequentially R beginning with 1 DG1 02 Diagnosis Coding ID 2 R Method Patient Demographic HL7 Specification 131 Field Name Type Length Comments Req d DG1 03 Diagnosis Code CE 60 Format identifier ST text ST O name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST DG1 03 01 ICD 9 code DG1 03 03 19 This value appears on the External Diagnoses tab DG1 04 Diagnosis Description ST 40 Diagnosis name and description O DG1 05 Diagnosis Date Time TS 26 Date Time that the diagnosis was determined O Format yyyymmddhhmmss DG1 06 Diagnosis Type IS 2 Valid values R A Admitting W Working F Final DG1 07 Major Diagnostic CE 60 O Category DG1 08 Diagnostic Related CE 60 O Group DG1 09 DRG Approval ID 2 O Indicator DG1 10 DRG Grouper Review IS 2 O Code DG1 11 Outlier Type CE 60 O DG1 12 Outlier Days NM 3 O DG1 13 Outlier Cost CP 12 O DG1 14 Grouper Version and ST 4 O Type DG1 15 Diagnosis Pr
99. XML Tag Comments Req d Actors lt Address gt All of the Address elements are defined as xs string O continued type Example lt Address gt Linel 1234 Mulberry Lane lt Linel gt lt Line2 gt additional address lt Line2 gt lt City gt Toledo lt City gt State OH State lt PostalCode gt 54360 lt PostalCode gt lt Country gt USA lt Country gt lt Address gt lt Telephone gt Can be more than one depending on what Care360 O Labs amp Meds sends A separate telephone instance is created for each The Value and Type elements are all defined as xs string type Example lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Telephone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Nighttime Phone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Work Phone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Fax Number lt Text gt lt Type gt lt Telephone gt Values from Care360 Labs amp Meds PAGE BN CELLULAR CP FAX FX HOME HP NIGHT NP TELEPHONE TE WORK WP EMAIL EM CCR Message Specification 186 Attributes Data Objects XML Tag Comments Req d Actors lt Email gt If an email address is availabl
100. a Exchange Echoes Third Party Rx Order CCR Format Partner Application The following steps outline the process and associated systems involved in placing a prescription order and having the prescription order echoed back to the partner application 1 A user logs in to the partner application 2 The partner application user initiates a link to the Prescription Orders function of Care360 Labs amp Meds When linking to Prescription Orders the current patient context may be maintained if an appropriate match can be determined based on the supplied PID 3 The user creates and submits a prescription order or approves a renewal request Linking to Care360 Labs amp Meds 18 Care360 Labs amp Meds sends the prescription echo to the Data Exchange at the time the prescription is submitted The Data Exchange records the prescription order transaction and stores a copy of the discrete content of the prescription order The Data Exchange echoes returns a copy of the prescription order back to the partner application Note Clients must be able to utilize patient fuzzy matching for prescription orders without a Medical Record Number MRN Linking to Care360 Labs amp Meds 19 Chapter 2 Care360 Labs amp Meds SSO Specification In This Chapter v About the Cares 0 Labs amp Meds SSO Specification AE ea 21 Establishing Organizational Trust is cesciesteri PERPPREURATURPAA RRRG OG oraaeeimlepaedaonrhapl
101. adds the patient and marks the patient as a potential duplicate Delete Patient If Care360 Labs amp Meds finds no high confidence match between existing patients in the target organization and the incoming patient demographics Care360 Labs amp Meds returns an error to the partner application If Care360 Labs amp Meds finds a high confidence match between a single patient in the target organization and the incoming patient demographics the matching patient is deleted If Care360 Labs amp Meds finds more than one high confidence match between existing patients in the target Organization and the incoming patient demographics Care360 Labs amp Meds returns an error to the partner application Merge Patients If the target organization contains no match for either the correct patient or the incorrect patient Care360 Labs amp Meds returns an error to the partner application If the target organization contains a single high confidence match for the correct patient and a single high confidence match for the incorrect patient those patients are merged If thetarget organization contains more than one high confidence match for either the correct patient or the incorrect patient Care360 Labs amp Meds returns an error to the partner application Schedule Patient If the incoming PID matches no existing patient in the target organization the patient is added If the incoming PID matches a single p
102. agram Receiving Patient Demographic and or Billing Updates from Care360 Labs amp Meds MedPlus Network Partner Application Data Exchange Forwards Demographic and or Billing Updates to Partner Application Care360 Data Exchange Database Copy of Patient Demographic and or Billing Updates Care360 Labs amp Meds Submits Patient Demographic and or Billing Updates to Data Exchange The following steps outline the process and associated systems involved in a partner application receiving patient demographic and or billing updates from Care360 Labs amp Meds 1 The Data Exchange receives the patient demographic and or billing messages from Care360 Labs amp Meds and verifies the format and content of those messages 2 The Data Exchange records the patient demographic transaction and stores a copy of the discrete content of the messages for 90 days 3 The Data Exchange converts the Care360 Labs amp Meds patient demographic and or billing messages to the standard HL7 ADT and or DFT message format and then forwards pushes the messages to the partner application Note The configuration of outbound push services to the partner application for demographic or billing updates is outside the scope of the Submit Patient Demographic web service Contact Quest Diagnostics support for more information 4 The partner application applies the updates to its patient database and or billing system Any validation erro
103. and HL7 3 0 values O For HL7 2 3 values supported by Care360 Labs amp Meds are listed below H Hispanic N Non Hispanic U Unknown For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC ethnicity code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 840 1 113883 6 238 amp code 2133 7 with a Concept Status Date of 09 26 2008 PID 23 Birth Place ST 60 Indicates the location of the patient s birth O PID 24 Multiple Birth Indicator ID Indicates whether or not the patient was part of a multiple O birth Yes No indicator Valid values Y Yes N No blank The Data Exchange validates this field PID 25 Birth Order NM When a patient was part of a multiple birth a number O indicating the patient s birth order is entered in this field PID 26 Citizenship Contains the patient s country of citizenship O PID 27 Veterans Military Status CE 60 Contains the military status assigned to a veteran O Only the first subfield Identifier is passed from Care360 Labs amp Meds PID 28 Nationality CD 80 Contains a code that identifies the nation or national O grouping to which the insured person belongs This information may be different from a person s citizenship in countries in which multiple nationalities are recognized for example Spain Basque
104. and billing DFT messages that are retrieved from the Data Exchange refer to Chapter 6 Patient Demographic HL7 Specification beginning on page 62 A separate web service the Submit Patient Demographic web service enables a partner application to submit patient demographic and scheduling updates to the Data Exchange which it then forwards to Care360 Labs amp Meds For more information about the Submit Patient Demographic web service refer to Chapter 4 Submit Patient Demographic Web Service API Reference beginning on page 38 Retrieve Patient Demographic Web Service API Reference 51 Process Walkthrough Retrieving Patient Demographic Updates The diagram below illustrates at a high level the flow of information between Care360 Labs amp Meds the Data Exchange and a partner application Following the diagram is a step by step walkthrough of the patient demographic processes illustrated in the diagram Retrieving Patient Demographic and or Billing Updates from Care360 Labs amp Meds MedPlus Network Partner Application Partner Application Retrieves and Acknowledges Patient Demographic and or Billing Updates at Regular Intervals Care360 Data Exchange Database Patient Demographic and or Billing Update Queue Care360 Labs amp Meds Submits Patient Demographic and or Billing Updates to Data Exchange The following steps outline the process and associated systems involved in a partner applicati
105. anhiwadeeraaooes 22 Emen SEVIS srera iaar iu REDE Uo eR etr pO OLEI e pe qu PER EM iqe aqua 23 Scenario 1 Care360 Labs amp Meds SSO tor Interactive Users aa naa dana aa PRO Dive Dre e Pe OS PPS rp 26 s Scenario 2 CaresoD Labs amp Meds SSO for Web ServicBS isseasad o adea be RR GARA RR Re dads dcc E Pbe A RARUS 28 20 About the Care360 Labs amp Meds SSO Specification Care360 Labs amp Meds SSO utilizes the Oasis SAML 1 1 specification for exchanging credentials securely between itself and a partner application The implementation of this trust model is based upon a combination of the following items A digital certificate that identifies the external partner An organizational trust record that is recorded with Care360 Labs amp Meds The organizational trust record follows an assessment process verifying that the partner site can securely and accurately assert the identities of its users on behalf of Care360 Labs amp Meds Since password management is not required to access Care360 Labs amp Meds the password management at the partner application endpoint must be comparable Once the organizational trust has been established the partner application can submit authentication requests to Care360 Labs amp Meds in the form of a SAML assertion SAML is an XML based messaging standard that provides for the specification of a partner site identifier user name identifier digital signature of the asserted information a
106. ansaction the maximum number allowed is 50 If the batch size is not specified or if the specified number is not from 1 to 50 then it defaults to 50 Notes Demographic and billing messages are stored in the Data Exchange for 90 days regardless of whether or not they have been retrieved and or acknowledged For detailed specifications on the ADT and DFT messages that are retrieved from the Data Exchange see the Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Method Signature RetrievalResult retrieveDemographicMessages RetrievalRequest request throws SOAPException Retrieve Patient Demographic Web Service API Reference 53 Method ackDemographicMessages Description Summary Returns an acknowledgement ACK or negative acknowledgement NAK for the demographic and or billing messages received both of which remove the messages from the retrieval queue Also returns the number of ACK d or NAK d messages A NAK is returned for any messages that resulted in an error Note Demographic and billing messages are stored in the Data Exchange for 90 days regardless of whether or not they have been retrieved and or acknowledged Usage You must supply the AckRequest object which describes the demographic or billing messages being acknowledged This method must be called to acknowledge either ACK or NAK all demographic or billing messages that were retrieved Method Signature AckResult ackDemog
107. at identifies this transaction For R the first occurrence of the segment the sequence number shall be 1 for the second occurrence it shall be 2 etc PR1 02 Procedure Coding X Method PR1 03 Procedure Code CE 80 Used instead of PR1 02 and PR1 04 which are retained for R backward compatibility only for a unique identifier assigned to the procedure The value returned for the coding system will be either Current Procedural Terminology CPT or Healthcare Common Procedure Coding System HCPCS This is a repeating field with each instance delimited by tilde Patient Demographic HL7 Specification 155 Field Name Length Comments Req d PR1 04 Procedure Description X PR1 05 Procedure Date Time Contains the date time that the procedure was performed R per the Care360 Labs amp Meds encounter note Format yyyymmdd PR1 06 Procedure Functional X Type PR1 07 Procedure Minutes X PR1 08 Anesthesiologist X PR1 09 Anesthesia Code X PR1 10 Anesthesia Minutes X PR111 Surgeon X PR1 12 Procedure Practitioner X PR113 Consent Code X PR114 Procedure Priority X PR1 15 Associated Diagnosis Contains the diagnosis that is the primary reason this O Code procedure was performed Format lt identifier ST text ST gt name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST PR1 15 01 ICD 9 code PR1 15 03 I9
108. atient in the target organization that patient is updated If the incoming PID matches more than one existing patient Care360 Labs amp Meds returns an error to the partner application a You cannot delete a patient after clinical entries for example lab results have been associated with that patient or if the patient is associated with an alias patient If a delete cannot be performed due to either of these conditions an error message is returned Submit Patient Demographic Web Service API Reference 42 Process Walkthrough Submitting Patient Demographic Updates The diagram below illustrates at a high level the flow of information between a partner application the Data Exchange and Care360 Labs amp Meds Following the diagram is a step by step walkthrough of the patient demographic processes illustrated in the diagram Submitting Patient Demographic and or Scheduling Updates to Care360 Labs amp Meds MedPlus Network Partner Application Partner Application Submits Patient Demographic and or Scheduling Updates to Data Exchange Care360 Data Exchange Database Copy of Patient Demographic and or Scheduling Updates Data Exchange Forwards Patient Demographic and or Scheduling Updates to Care360 Labs amp Meds The following steps outline the process and associated systems involved in a partner application submitting patient demographic and or scheduling updates to Care360 Labs amp Meds 1 T
109. ation 23 Parameter Description Example Value Req d Default targetUri A Care360 Labs amp Meds page One of the following N Home identifier indicating the preferred NewBes lte landing page LabOrders Home BlankPage PatientSummary RxPad ActionItems ActionItemFailedFaxes ActionItemsPending Renewals ActionItemsPending Approvals Notes Home specifies the user s default page BlankPageisvalid only for web service calls branduid A string value indicating the preferred 2c9252d710e58d150110e5 N Care360 UI brand 8d67190001 Labs amp Meds default brand TARGET A SAML 1 1 parameter that identifies a any value N target page This parameter is not used by Care360 Labs amp Meds SSO even though it is in the standard If your SAML implementation or library requires this name value pair specify it with any arbitrary value the value is ignored Application Context Parameters ctx patientID A Care360 Labs amp Meds patient 23456 N identifier PID Note Valid only for the LabOrders PatientSummary and RxPad landing pages Care360 Labs amp Meds SSO Specification 24 D The SAML response is authenticated by Care360 Labs amp Meds Care360 Labs amp Meds SSO verifies the SAML response and authenticates the asserted user based upon the following Was the SAML response signed by a trusted partner The public key passed within the SAML response is sought i
110. bbbed iege added dag dadas xii Third Party Internet ResoOUFCeS iceprepbebirpEbeeibietl ePPODRRERREPSEPXqR Qe RE REIQ ANA AA E E ERE RECO xii Chapter 1 Linking to Care360 Labs amp Meds iie sese n RR RR ER RER KR RERLE AER NAE 1 About binding and simgle Sig RESSQD 5 dedirequame dre dha Robb pe pP top dd bobo Bob Moms had p dep A 2 Care360 Labs amp Meds Functions Available Tor linking 22emoq hihi REL RA P RE E RE LAN MS Rd 2 Formatting Requirements for Linking to Care360 Labs amp Meds cece cnet es 3 Aboul Sisle Siem QC OS eors M brU PERPE IOS d Oed ttp EPESOS pe ANA qoe toda d 4 Maintaining Pallelit Colb ext 1 2 cda pias Ep RUPEE RESPON pF ab Rd bebo Iob Ed Kobe Uds 4 Process Valero es Er iris andi SSO seisterq aee esirin i A Tn IOR ead PHEQTHPPP Y VaWRNR VR PR ORIS 9 Customizing the Cams360 Labs Meds User Interface 2 522 2b ioo bee Ri dc d GL dud An d Robe Rd d 11 Custom Ui SbeciicHiofis 2p pe o e Tk FE HP HP PREDP PU E FE PPRPERM PRO UU SR PEPPER PIE 12 About tte Care3so0 S5Q and Web Services Site ac2sebstopbiP MISI P P IPS PECORIS Godden ooh AAA eden daa 14 Accessing the Care360 SSO and Web Services Site een ns 14 Aout us Samples AVIS CaO aoctor ines te deb dut bou blo PANNE p ded dma do ACRIOR E AO 15 bou the Same COE 3a sco dba dh bd Od ANA AA KAN Cp RR du arid d ANA BA Oda data 16 Abou Lab Order ECHO Loisir nbazia tie DP IV UM EIE EUR CUPIT PIE A AA A A PIU dae ERR E UDP a 7 Process VV altho lew Lab Order Eel TB a sedeo trips esi
111. bs amp Meds so that a search for the matching patient can be performed as the linking occurs If an exact PID match is found then the patient context is maintained otherwise the user can access the selected Care360 Labs amp Meds function but will need to manually search for the desired patient For applications that do not utilize the ADT messaging the partner application can pass an additional HTTP Post parameter name Care360 Transaction with the initial SSO request The value of this parameter is XML which follows the rules defined in http custcenter medplus com tech support portalcenter docs xsd Care360 Transaction xsd This field can contain various forms of information one of which is patient demographics If Care360 Labs amp Meds is configured to accept updated patient information the demographics information contained within the message is used to create a patient if one does not exist This method relies solely on the ability of the partner application to identify a patient using a unique patient identifier PID and provide a full set of patient demographics on the SSO request to Care360 Labs amp Meds If the partner application is configured to accept updated information and uses this method to maintain patient context then the information provided by the partner application is always considered the most accurate that is it overrides any existing data in Care360 Labs amp Meds The patient demographics part of the Care360Tra
112. c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt CCR Message Specification 191 lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt IDs gt lt Address gt Linel 4690 Parkway Drive lt Linel gt lt City gt Mason lt City gt State OH State lt PostalCode gt 45040 lt PostalCode gt lt Address gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Telephone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Nighttime Phone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Work Phone lt Text gt lt Type gt lt Telephone gt lt Telephone gt lt Value gt 1234567890 lt Value gt lt Type gt lt Text gt Fax Number lt Text gt lt Type gt lt Telephone gt lt Source gt lt Actor gt lt ActorID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt Actor gt lt Actor gt lt ActorObject ID gt Care360 lt ActorObjectID gt lt InformationSystem gt lt Name gt Care360 Labs amp Meds lt Name gt lt Type gt EMR lt Type gt Version 2013 3 Version lt InformationSystem gt lt Source gt lt Actor gt lt ActorID
113. cheduling of an appointment It is included to provide an audit trail of persons responsible for the request This person may be someone other than the placer contact person who is responsible for entering orders and requests SCH 21 Entered by Phone XTN 40 O Number Patient Demographic HL7 Specification 122 Field Name Type Length Comments Req d SCH 22 Entered by Location PL 80 O SCH 23 Parent Placer EI 75 O Appointment ID SCH 24 Parent Filler EI 75 O Appointment ID SCH 25 Filler Status Code CE 200 Contains a code describing the status of the appointment O with respect to the filler application Valid values PENDING WAITLIST BOOKED STARTED COMPLETE DELETED BLOCKED OVERBOOK Note Values must be submitted in uppercase If this field is populated the Data Exchange validates it for one of the above values Note however that Care360 Labs amp Meds does not currently use this appointment status PID Patient Identification Segment The Patient Identification 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 Field Name Type Length Comments Req d PID OO Segment Type ID ST 4 Must be PID R PID O1 Set ID Patient ID SI 4 Allows identification of multiple PID segments withina me
114. cknowledge retrieved messages RequestedBatchSize The number of messages that were requested in the retrieve transaction ActualBatchSize The actual number of messages that were retrieved by the transaction isMore Indicates whether or not additional messages are available for retrieval Valid values TRUE if there are more messages or FALSE Cif no more messages are available Status The status of the transaction response Valid values SUCCESS or FAILURE ErrorDescription A description of the error that occurred if the status is FAILURE RetrievalResultltem The array of retrieved RetrievalResultltem objects returned String Integer Integer Boolean String String String Retrieve Patient Demographic Web Service API Reference 55 Object Description Attributes Data Type Req d RetrievalResultltem The content of the retrieved ADT or DFT message Includes the message control ID as well as the Base64 encoded message content Responses include Messageld The message control ID included in the ADT or DFT String R message that was retrieved from the Data Exchange This ID is used for acknowledging retrieved demographic or billing messages HI7AsBase64Encoded The Base64 encoded HL7 ADT or DFT base64Binary R message content AckRequest Represents the retrieval transaction being acknowledged Attributes that can be set for this object include Retrievalld The transaction ID that has
115. compatibility only EVN O2 Recorded Date Time X EVN 03 Date Time Planned X Event EVN 04 Event Reason Code X Patient Demographic HL7 Specification 94 Field Name Type Length Comments Req d EVN O5 Operator ID X EVN 06 Event Occurred X PID Patient Identification Segment The Patient Identification 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 Field PID OO Name Type Segment Type ID ST Length Comments Req d 4 Must be PID R PID O1 Set ID SI 4 Allows identification of multiple PID segments withina message Usually a sequential number beginning with 1 PID O2 Patient ID CX 40 Care360 patient identifier used to uniquely identify a R patient within Care360 When the patient is from another institution outside office etc the identifier used by that institution can be shown in this field This may be a number that multiple disparate corporations or facilities share Example BB1123 PID O3 Patient ID CX 40 The primary identifier or other identifiers used by the O facility to identify a patient uniquely for example medical record number billing number birth registry etc This is the patient identifier associated with the non Care360 system and it is not
116. cor Cornish ben Bengali cos Corsican bho Bhojpuri cre Cree bik Bikol mus Creek bis Bislama crp Creoles and pidgins byn Blin cpe Creoles and pidgins English based nob Bokmal Norwegian cpp Creoles and pidgins Portuguese based bos Bosnian crh Crimean Turkish bra Braj hrv Croatian bre Breton cze Czech bug Buginese dak Dakota Patient Demographic HL7 Specification 169 ISO 639 2 Code English Name ISO 639 2 Code English Name bul Bulgarian dan Danish del Delaware gla Gaelic dar Dargwa car Galibi Carib chp Dene Suline glg Galician din Dinka lug Ganda div Divehi gay Gayo doi Dogri gba Gbaya dgr Dogrib geo Georgian dua Duala gil Gilbertese dut Dutch gon Gondi dyu Dyula gor Gorontalo dzo Dzongkha grb Grebo frs Eastern Frisian kal Greenlandic bin Edo grn Guarani efi Efik guj Gujarati eka Ekajuk gwi Gwich in myv Erzya hai Haida epo Esperanto hat Haitian Creole est Estonian hau Hausa ewe Ewe haw Hawaiian ewo Ewondo heb Hebrew fan Fang her Herero fat Fanti hil Hiligaynon fao Faroese hmo Hiri Motu fij Fijian hmn Hmong fil Filipino hun Hungarian fin Finnish hup Hupa fon Fon iba Iban fur Friulian ice Icelandic Patient Demographic HL7 Specification 170 ISO 639 2 Code English Name ISO 639 2 Code English Name
117. d billing updates that occur within Care360 Labs amp Meds to be synchronized with a partner application for example a Practice Management System PMS to maintain the integrity of patient demographic and billing data between the two applications Care360 Labs amp Meds submits demographic and or billing updates to the Data Exchange where they are stored in a queue until they are retrieved by a partner application The Retrieve Patient Demographic web service enables a partner application to retrieve pull demographic and or billing updates from the Data Exchange on a regular basis 15 minute intervals are recommended This enables the partner application to stay current with any updates that have been submitted to the Data Exchange by Care360 Labs amp Meds Note Demographic and billing messages are stored in the Data Exchange for 90 days regardless of whether or not they have been retrieved and or acknowledged The types of patient demographic update and billing messages supported by the Retrieve Patient Demographic web service include the following Patient Add ADT A28 Patient Update ADT A31 Patient Delete ADT A29 Patient Merge ADT A39 Detail Financial Transaction DFT PO3 The Data Exchange maintains a record of all patient demographic transactions that occur whether they are initiated by Care360 Labs amp Meds or by a partner application Notes Fordetailed specifications on the HL7 demographic ADT
118. d to as the landing page New Results The EMR user can directly access the Care360 Labs amp Meds New Results page to view the latest test results that have been received for all of their patients Results can be viewed or printed and can be forwarded to other Care360 Labs amp Meds users via user messaging or fax Lab Orders The EMR user can directly access the Care360 Labs amp Meds Lab Orders page to create an electronic lab order for submission to either a Quest Diagnostics lab or a third party lab for processing The link to Lab Orders can occur in one of the following ways With patient context Lab Orders opens with the current EMR patient s data pre populated based on the patient s PID Without patient context Lab Orders opens with no specific patient pre populated The user can then search for a patient within Lab Orders as needed Linking to Care360 Labs amp Meds 2 Patient Summary The EMR user can directly access the Care360 Labs amp Meds Patient Summary page In Care360 Labs amp Meds a Patient Summary is essentially a collapsed or summarized view of the patient s complete chart To view a more detailed history for the patient you can access individual items within each section of the Patient Summary to display additional data Patient Summary fully expanded Patient Summary opens with all of the patient s latest data displayed as well as all of the page s navigational features visible
119. de that places the message in a queue for later delivery to Care360 Labs amp Meds Submit Patient Demographics Method Details The following table provides details about each of the methods listed above Method Description submitRealTimeADTMessage Summary Submits a patient demographic update in HL7 format to the Data Exchange in real time mode This means that each HL7 message is delivered to Care360 Labs amp Meds immediately Usage The DemographicRequest object contains the inbound patient demographic update Notes Even if an inbound patient demographic update is accepted by the Data Exchange it still may ultimately be rejected by Care360 Labs amp Meds For detailed specifications on formatting patient demographic update messages that are sent to the Data Exchange for processing see Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Method Signature DemographicResponse submitRealTimeADTMessage DemographicRequest request throws SOAPException Submit Patient Demographic Web Service API Reference 45 Method submitBatchADT Message Description Summary Submits a patient demographic update in HL7 format to the Data Exchange in batch mode This means that each HL7 message will be placed in a queue for later delivery for example several hours to Care360 Labs amp Meds Note Only one HL7 message for one patient can be submitted per submitBatchADT Message call Usage The Inb
120. dliirusuesoevesvop etrae te deem pede ee PeRqe SEA POI QUERN POE 66 Message Segment Specifications cs aa a A AA nee heh n 66 ADT A29 Patient Delete Message Segment Specifications kna kna kaa 92 Messo Sesimenit Hierde hy o Lies od bea QU S65 Feder A Ond du eddie da iba dade 92 Message Segment SHSCINCANONS cecseserbyteR ER patiaennp wn PT Wt HER beh oie eq dd ees d pep Pp GA 92 Table of Contents iv ADT A39 Patient Merge Message Segment Specifications siiis n 103 Message Sep meni PIIBESIE IY as dale au E v pu amd 6d d und ead R b adu ore o Ae A eR ETUR dA RS dat ead 103 Message Segment Specifications hae es 103 SIU Schedule Information Unsolicited Message Segment Specifications ee cnet eee eres 116 Messac Ssembpnt HIBEAECYCUS saos dod kaiera S09 od ba S dac ec Quid Pe Qnod dba bbb dd do Erb d dedo 116 Message Segment Smeelcaliolls Mei Se eb DR E pep Sq RUE VRMMMRR PIERDE MH PS Ter 117 DFT PO3 Detail Financial Transaction Message Segment Specifications seka 138 Message Segment Hierarchy 00 ccc ee has 138 Message Segment SOECIICATIONS aces aobrese RibPP Tee ques d petpetpepeensesOReeqe c d eirQotqpeveerb eee 139 Sample Patient Eemosraphic MESSdEES a ues date ede diad ohio das a TE RES b RE REESE ERES QR 166 About Patient Demographic Reference Data seni ccc ccc da teriteni EE p MIE ea 168 Panett Langpad PI S 4 iasasauoau e gen 25 653 03
121. dr Mandar nde North Ndebele man Mandingo frr Northern Frisian mni Manipuri sme Northern Sami glv Manx nso Northern Sotho mao Maori nor Norwegian arn Mapuche nno Norwegian Nynorsk mar Marathi iii Nuosu chm Mari nym Nyamwezi mah Marshallese nyn Nyankole mwr Marwari nyo Nyoro mas Masai nzi Nzima men Mende oji Ojibwa mic Micmac ori Oriya min Minangkabau orm Oromo mwl Mirandese osa Osage moh Mohawk oss Ossetian mdf Moksha pau Palauan lol Mongo pag Pangasinan Patient Demographic HL7 Specification 172 ISO 639 2 Code English Name ISO 639 2 Code English Name mon Mongolian pap Papiamento mos Mossi pus Pashto nqo N Ko pon Pohnpeian nau Nauru pan Punjabi que Quechua snk Soninke raj Rajasthani sot Sotho Southern rap Rapanui nbl South Ndebele rum Romanian alt Southern Altai roh Romansh sma Southern Sami rom Romany srn Sranan Tongo run Rundi suk Sukuma smo Samoan sun Sundanese sad Sandawe sus Susu sag Sango swa Swahili san Sanskrit SSW Swati sat Santali swe Swedish srd Sardinian syr Syriac sas Sasak tah Tahitian Sco Scots tgk Tajik sel Selkup tmh Tamashek srp Serbian tam Tamil srr Serer tat Tatar shn Shan tel Telugu sna Shona ter Tereno scn Sicilian tet Tetum sid Sidamo tha Thai bla Siksika tib Tibetan snd Sindhi tig Tigre sin Sinha
122. e Type Length Comments Req d AIS 00 Segment Type ID ST 4 Must be AIS R AlS 01 Set ID AIS SI 4 R AIS 02 Segment Action Code ID 3 AIS 03 Universal Service CE 200 R Identifier Patient Demographic HL7 Specification 133 Field Name Type Length Comments Req d AIS 04 Start Date Time TS 26 C AlS 05 Start Date Time Offset NM 20 C AlS 06 Start Date Time Units CE 200 C AIS 07 Duration NM 20 O AIS 08 Duration Units CE 200 O AIS 09 Allow Substitution IS 10 C Code AIS 10 Filler Status Code CE 200 AIG Appointment Information General Resources Segment The Appointment Information General Resources AIG segment contains information about various kinds of resources other than those with specifically defined segments in this chapter that can be scheduled Resources described by this segment are general kinds of resources such as equipment that are identified with a simple identification code Note This segment is not used by Care360 Labs amp Meds Field Name Type Length Comments Req d AIG 00 Segment Type ID ST 4 Must be AIG R AIG O1 Set ID AIG SI 4 R AIG 02 Segment Action Code ID 3 C AIG 03 Resource ID CE 200 C AIG O4 Resource Type CE 200 R AIG O5 Resource Group CE 200 O AlG 06 Resource Quantity NM 5 O AIG O7 Resource Quantity CE 200 O Units AIG 08 Start Date Time TS 26 C AIG 09 Start Date Time Offset NM 20 AIG 10 Start Date Time Offset CE 200 C Unit
123. e accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats Outbound yyyymmdd The patient s DOB appears along with the patient name throughout Care360 Labs amp Meds specifically on the Demography tab gt Patient Information section Possible values are listed below R M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated The patient s gender appears on the Demography tab gt Patient Information section PID 09 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suffix Prefix and Degree are passed to from Care360 Labs amp Meds Patient Demographic HL7 Specification 70 Field Name Type Length Comments Req d PID 10 Race CE 250 Repeating field with a maximum of three instances allowed O This field supports both HL7 2 3 and HL7 3 0 values For HL7 2 3 values supported by Care360 Labs amp Meds are listed below W White B Black A Asian American Indian or Alaskan O Other For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC race code set http phinvads cdc gov vads ViewCodeSystemConcept a ction oid 2 16 840 1 113883 6 238 amp code 1000 9 with a Concept Status Date of
124. e can be based on local and or universal codes Format lt identifier name of coding system ST text ST ST gt alternate identifier ST alternate text system ST gt ST name of alternate coding The following identifier codes are valid ROUTINE Routine appointment default if not valued WALKIN A previously unscheduled walk in visit CHECKUP A routine check up such as an annual physical FOLLOWUP A follow up visit from a previous appointment EMERGENCY Emergency appointment SCH 08 Appointment Type CE 200 Format lt identifier lt name of coding system alternate identifier ST text system Contains the identifier code for the type of appointment O ST text ST ST alternate ST name of alternate coding ST The following identifier codes are valid NORMAL Routine schedule request type default if not valued TENTATIVE A request for a tentative for example penciled in appointment COMPLETE A request to add a completed appointment used to maintain records of completed appointments that did not appear in the schedule for example STAT walk in etc SCH 09 Appointment Duration NM 20 SCH 10 Appointment Duration CE 200 Units Patient Demographic HL7 Specification 121 Field Name Type Length Comments Req d SCH 11 Appointment Timing TQ 200 Contai
125. e ded E ePETP E oedae A E HESSE TE 17 Aboul Da cid A A AN aa AAA Aa AA duo bdo AA A 18 Process Walkthrough Rx Order Pend A Lan nan in dl a EA PPP A a T AP IR PERPE 18 Chapter 2 Care360 Labs amp Meds SSO Specification 0 c cece cece cence ee naaa 20 About die Careseo Labs amp Meds SSO peria a a oix E Te PP E petean tga pees ea eas enewed a ea 21 Establisuro Oe A AAA A Pande Db ER Aa te lean edracyarae 22 A mESAM MR ee 23 Scenario 1 Care360 Labs amp Meds SSO for Interactive Users 0 0 cece cence es 26 About Session Timeouts and Terminations issiosise bb Rh ka dee RARE ERRDRERERPCRRRARAQPepbePRPad ed 26 About S50 Wiser alization daricted ces oe pense ds PSEUD ree tet PERITI SET OE Ubbu Aa 27 Scenario 2 Careso0 Labs amp Weds 550 for Web ServiEBS aa Sa nan ERES tad RO RU br dd ded ARR C pai E GA 28 About Session Timeouts and Terminations 22424 docs pada Hie ERE GI URIPM A A AA A eee NR RR PERS 30 About SSO User nia ang uoa oar teo p P IO PCPTOPCPPITTORe Tr T PPPIS M PPReSq PI POSTOTq HP PRESA 30 About the Landing Page 25225 aan E RETPULPODERRRDRERRAPRTPCURMEE PIER eb AS UR A Red 30 Chapter 3 User Summary Web Service API Reference ss nnn 31 About the User Summary Web SEIVIGB 2 v tea temo debe tetob Iba Upad AAA dee Top Rob ce aab Opa Pe db ot 32 Process Walkthrough Retrieving User Summary Dala 142 245 242 5 2d op ar LAN Eb SES eben CERE Ke AN
126. e detail data necessary to post charges payments adjustments etc to patient accounting records Field Name Type Length Comments Req d FT1 00 Segment Type ID ST 4 Must be FT1 R FT1 01 Set ID FT1 SI 4 Contains the number that identifies this transaction For O the first occurrence of the segment the sequence number shall be 1 for the second occurrence it shall be 2 etc FT1 02 Transaction ID X FT1 03 Transaction Batch ID X FT1 04 Transaction Date TS 26 Contains the date of the transaction per the Care360 Labs R amp Meds encounter note FT1 05 Transaction Posting TS 26 Contains the date of the transaction that was sent tothe O Date financial system for posting FT1 06 Transaction Type IS 8 Contains the code that identifies the type of transaction R CG Charge CD Credit PY Payment AJ Adjustment FT1 07 Transaction Code CE 80 Contains the ID assigned by Care360 Labs amp Meds tothis R transaction bill FT1 08 Transaction X Description FT1 09 Transaction X Description Alt FT110 Transaction Quantity NM 6 Contains the quantity of items associated with this O transaction Patient Demographic HL7 Specification 152 Field Name Length Comments Req d FT1 11 Transaction Amount X Extended FT112 Transaction Amount X Unit FT1 13 Department Code X FT11A Insurance Plan ID X FT115 Insurance Amount X FT116 Assigned Patient Con
127. e is used as follows Inbound partner application to Care360 Labs amp Meds For the partner application to delete patients from Care360 Labs amp Meds the ADT A29 messages must be written to the specifications in this chapter Note You cannot delete a patient from Care360 Labs amp Meds after clinical entries for example lab results have been associated with that patient or if the patient is associated with an alias patient If a delete cannot be performed due to either of these conditions an error message is returned if your EMR is configured to receive errors from Care360 Labs amp Meds Otherwise the error message is logged Outbound Care360 Labs amp Meds to partner application For Care360 Labs amp Meds to update the partner application with patients that were deleted from Care360 Labs amp Meds Care360 Labs amp Meds adheres to the ADT A29 message specification in this chapter so that the partner application knows what it will be receiving In general this message can be used to correct an error in adding the information to delete a duplicate patient record or to purge a patient from Care360 Labs amp Meds For a sample message see Sample 2 Delete Patient on page 166 Message Segment Hierarchy The ADT A29 message segment hierarchy is specified below MSH Message Header Required one per file EVN Event Type Required PID Patient Identification Required PD1 Additional Demographics Optional
128. e it will be includedin O continued the CCR message The lt Email gt element is used only for the Prescriber communication numbers and only the email address of the Prescriber is used All other communication numbers are ignored The Value and Type elements are all defined as xs string type Values from Care360 Labs amp Meds EMAIL EM lt URL gt Not currently used NS lt Status gt The Status element is defined as xs string type O Example lt Status gt Text Activec Text lt Status gt lt Source gt The ActorObjectID of the Care Site or Hub Account R All of the elements in the Source element are defined as xs string type Example Source Actor lt ActorID gt 0c32996a7 00010104507926d8e440 fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt InternalCCRLink gt ot currently used S lt ReferencelID gt ot currently used S lt Comment ID gt ot currently used S References References ot currently used S Comments Comments ot currently used S Signatures Signatures ot currently used S a R Required O Optional C Conditional required for drugs optional for supplies NS Not Supported CCR Message Specification 187 Sample CCR Message The following is a sample XML message formatted according to the CCR Me
129. e user may remain within Care360 Labs amp Meds and perform any other tasks he she is authorized to perform based upon the Care360 Labs amp Meds user access rights previously configured About Session Timeouts and Terminations A user who connects to Care360 Labs amp Meds via an SSO link is subject to the same timeout conditions as they would if they were to access Care360 Labs amp Meds directly When a directly accessed session times out Care360 Labs amp Meds displays the login page For an SSO authenticated session Care360 Labs amp Meds displays a page indicating that the user has timed out but it does not allow the user to re enter their login credentials A similar message appears if the user clicks Log Out within Care360 Labs amp Meds after authenticating via SSO The message presented to the user indicates that in order to begin a new session the user must return to the partner application and click a Care360 Labs amp Meds link Doing so results in a new SSO authentication request to Care360 Labs amp Meds It is quite possible that users who interact with Care360 Labs amp Meds only via links from the partner application will not be aware that a session timeout has occurred Each time a link from the partner application to Care360SSOSecurityCheck is invoked a new SAML assertion is passed using an HTML FORM of the type discussed above Care360 Labs amp Meds evaluates the current user session in conjunction with the SAML
130. eds SSO for Interactive Users In this scenario SSO is used to establish a Care360 Labs amp Meds session for an end user within a web browser window specifically Internet Explorer on the user s computer The SAML 1 1 Browser POST implementation as outlined in Implementing SAML on page 23 is manifested when the partner application launches the web browser Doing so loads an HTML document containing a form that targets the Care360 Labs amp Meds SSO security check servlet with the appropriate parameters as hidden input nodes Example Browser POST Note The SAMLResponse value in the following example is truncated for the sake of brevity lt HTML gt BODY Onload document forms 0 submit gt lt FORM METHOD POST ACTION https portal Care360 com Care360 Care360SSOSecurityCheck gt lt input type hidden name targetUri value NewResults gt lt input gt lt input type hidden name branduid value 2c9252d710e58d150110e58d67190001 gt lt input gt lt INPUT TYPE HIDDEN NAME SAMLResponse VALUE PHNhbWxw0O1J gt lt INPUT gt lt FORM gt lt BODY gt lt HTML gt In the example above the form is posted to Care360SSOSecurityCheck from the web browser such that the specified landing page is displayed to the user and the session cookie is established within the browser process for use on subsequent requests After the user has accessed Care360 Labs amp Meds from the partner application link th
131. eds web service usage is impacted Sessions established on behalf of Care360 Labs amp Meds user for web service usage as indicated by the X Care360 IsForWebService header are managed separately from sessions established for web browser usage This means that user browser sessions to Care360 Labs amp Meds will not be terminated due to a multiple login condition if the partner application invokes a web service call in the background on the user s behalf Web service sessions are limited to 60 seconds by default in order to avoid the proliferation of abandoned non interactive sessions on the Care360 Labs amp Meds server Sessions created for web service usage neither support nor require a log out feature in part due to the 60 second limit on web service oriented sessions About SSO User Initialization SSO authentication will not succeed when executed on behalf of a yet unmapped user for web service usage that is an HTTP 401 status will be returned with appropriate response text The partner application will need to gracefully handle this condition This differs from the web browser usage scenario where the user is directed to a login verification page About the Landing Page When accessing Care360 Labs amp Meds from a partner application via SSO linking in a web service context the BlankPage option is the only landing page option that is applicable The BlankPage option displays a blank page to the user This is used as
132. edule Patient or Detail Financial Transaction Sample 1 Add Patient MSH amp sending application DemographicDemo DemographicDemoOrg 20061211153336 A28 msgControlID123 P 2 3 EVN A28 PID 1 pid123 LH PATIENT LASTNAME PATIENT FIRSTNAME M 20000101153336 U ALIAS LASTNAME ALI AS FIRSTNAME 2056 0 2056 0 4690 Parkway Dr Mason OH 45040 USA cP 86 999 9999999 99999 513 9999999 ENG text Census EGL alttext Census2 M 1 FOUND 444669999 2148 5 text Census 2149 3 alttext Census NK1 1 LASTNAME FIRSTNAME II Mrs Ba Sister Main St austin TX 78704 USA 235 1320440 65 204 5551212 AGENT Pv1 1 0 GT1 1 GUARANTOR LASTNAME GUARANTOR FIRSTNAME M JR DR MD 1234 Emery Road Cincinnati OH 45010 1 513 8888888 1234 1 238 4444444 5678 19960708112233 M r 8 287889999 ABC Inc Limited M 1234 Main Drive oxford OH 45068 IN1 1 INSID123 Insurance Plan ABC INSCOID123 insuranceco 1800 Insurance Rd Detroit MI 45777 113433 name L HL E EL E ELE EL E EL LI EE LE LE FL IT Sample 2 Delete Patient MSH amp SecondSub DemographicDemo DemographicDemoOrg 20070321000000 A29 1 P 2 3 EVN A29 199608190820 PID 1 pid666 NEWMRN 2 LH PATIENT LASTNAME PATIENT FIRSTNAME 1 DR 20000101000000 F ALIAS _ LASTNAME ALIAS FIRSTNAME B i 513 8888888 9999 1 520 6666666 7777 a5 X 1 FOUND Pv1 1 0 Sample 3 Update Patient MSH amp sending application Demogra
133. egment contains guarantor for example the person or the organization with financial responsibility for payment of a patient account data for patient and insurance billing applications This segment is applicable only for patient and insurance billing Note If the guarantor name is blank in Care360 Labs amp Meds the GT1 segment is not created in outbound messages Field Name Type Length Comments Req d GT1 00 Segment Type ID ST 4 Must be GTI R GT1 01 Set ID SI 4 GT1 message segments should be numbered sequentially R from 1 GT1 02 Guarantor Number X GT1 03 Guarantor Name XPN 48 No more than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name family name ST given name ST middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID gt The Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab Guarantor Information section GT1 04 Guarantor Spouse X Name GT1 05 Guarantor Address XAD 106 No more than 106 characters Alphanumeric data only O street address ST other designation ST city ST state or province ST zip or postal code
134. ents Req d Medications lt Duration gt The duration is set as the Days Supply from the O continued order The Duration element is defined as xs string type Example lt Duration gt lt Description gt Text 35 Text lt Description gt lt Duration gt DoseRestrictions ot currently used S Indication ot currently used S lt StopIndicator gt ot currently used S lt DirectionSequencePosition gt Not currently used S lt MultipleDirectionModifier gt Not currently used S lt PatientInstructions gt Set to the Comments to the Pharmacist O The Patient Instructions element is defined as xs string type FulfillmentInstructions Not currently used NS Refill Set to the Refill Quantity from the order O The Refill element is defined as xs string type Example lt Refills gt Refill Quantity lt Value gt 1 lt Value gt lt Quantity gt lt Refill gt lt Refills gt lt SeriesNumber gt ot currently used S lt Consent gt ot currently used S Reaction ot currently used S lt FulfillmentHistory gt ot currently used S lt InternalCCRLink gt ot currently used S lt ReferenceID gt ot currently used S Medical lt MedicalEquipment gt ot currently used S Equipment CCR Message Specification 183 Attributes Data Objects XML Tag Comments Req d Immunizations Immunizations ot currently used S Vital Signs VitalSigns ot c
135. er is sent then telecommunication equipment type ID must equal CP The accepted length for each phone number is 20 numeric characters No dashes or other separating characters are allowed Example with just cell mobile phone P 777 8889999 O NK1 06 Business Phone Number XTN 40 Accepted length of this field is 20 numeric characters No dashes or other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 O Patient Demographic HL7 Specification 78 Field Name Type Length Comments Req d NK1 07 Contact Role CE 60 Values supported by Care360 Labs amp Meds are below The R default is PRS AGNT Agent e CAREGIVER Caregiver ECON Emergency Contact GUARD Guardian NOK Next of Kin PRS Personal Note When the value for NK1 07 is guardian the value for NK1 03 Relationship is also guardian NK1 08 X NK1 37 PV1 Patient Visit Data Segment The Patient Visit Data PV1 segment is used by registration patient administration applications to communicate information on a visit specific basis This segment can be used to send multiple visit statistic records to the same patient account or single visit records to more than one account Field Name Type Length Comments Req d PV1 00 Segment Type ID ST 4 Must be PV1 R PV1 01 Set ID SI 4 Will always be
136. er to access the URL corresponding to one of the following Data Exchange environments Staging environment Use this Data Exchange environment for developing testing and certifying your web service application For the Staging environment URL and endpoint see Staging Environment below Production environment Use this Data Exchange environment after your web service application has been certified For the Production environment URL and endpoint see Production Environment below To save the WSDL document to your hard disk access the document using your browser and then select File gt Save As Staging Environment To access the Retrieve Patient Demographic web service in the Staging environment access the following link WSDL Document https shubservices questemr com demographic retrieval service wsdl Endpoint https shubservices questemr com demographic retrieval service Production Environment Once you have developed tested and certified your web service client application in the Staging environment you can then update the application to work in the Production environment Connecting a web service client to the Production environment is similar to connecting to the Staging environment the exposed interfaces are equivalent Note Client applications developed against the Staging environment WSDL documents can also be used to access the Production environment and vice versa the WSDL content is identical in both en
137. er to enter a second set of user credentials User ID and Password Glossary 197 Index A Abbreviations and acronyms x Account see Hub account ACK message definition 194 ackDemographicMessages method description 54 AckRequest object description 56 AckRequestltem object description 56 AckResult object description 56 Add patient sample patient demographic message 166 Admission Discharge Transfer ADT definition 194 ADT A28 Patient Add message specifications 65 91 ADT A29 Patient Delete message specifications 92 102 ADT A31 Patient Update message specifications 65 91 ADT A39 Patient Merge message specifications 103 115 Advanced Beneficiary Notice ABN definition 194 AIG field requirements patient demographic 134 135 AIL field requirements patient demographic 135 AIP field requirements patient demographic 136 137 AIS field requirements patient demographic 133 API application programming interface Retrieve Patient Demographics Services 53 56 Submit Patient Demographics Services 45 47 User Summary Services 33 35 Application sample EMR 15 B Batch mode patient demographic integration 40 C Care360 Labs amp Meds access directly 10 access via SSO 10 linking and SSO 2 Production environment 36 Staging environment 36 UI customization vii 2 11 Care360 SSO and Web Services site overview 14 URL 14 Care360 SSO and web Services site sample code 16 CCR sample messages 188 193 Client application
138. essage segments are numbered sequentially from 1 R IN1 02 Insurance Plan ID CE 50 Populated with UNK for unknown when the insurance R plan ID is not available in Care360 Labs amp Meds IN1 03 Insurance Company ID CX 59 QDI Bill mnemonic C Note Required only if IN1 47 T Third Party Bill IN1 04 Insurance Company XON 130 O Name Patient Demographic HL7 Specification 162 Field Name Type Length Comments Req d IN1 05 Insurance Company XAD 106 No more than 106 characters Alphanumeric data only Address street address ST other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt IN1 06 Insurance Co Contact X Person IN1 07 Insurance Co Phone X Number IN1 08 Group Number ST 50 Characters permitted include O A Z and 0 9 IN1 09 Group Name XON 130 O IN110 Insured s Group Emp ID X IN1 11 Insured s Group Emp X Name IN112 Plan Effective Date X IN1 13 Plan Expiration Date X IN114 Authorization X Information IN1 15 Plan Type X IN116 Name Of Insured X IN1 17 Insured s Relationship X To Patient IN118 Insured s Date Of Birth X IN1 19 Insured s Address X IN1 20 Assignment Of X Benefits IN1 21 Coordination Of X Benefits IN1 22 Coord Of Ben Priority X IN1 23 Notice Of Admission X Flag
139. est of the message The value is a vertical bar MSH 02 MSH 03 Encoding Characters ST Sending Application HD 180 Four characters that are used in the following order R component separator repetition separator escape character and subcomponent separator Format amp These values are recommended by HL7 and are the only values supported The name of the sending application O MSH 04 Sending Facility HD 180 The sending facility Identifies the owner of the patient R data and who initiated the patient demographic request This value will be provided by Quest Diagnostics The Data Exchange verifies that the field is populated MSH 05 Receiving Application HD 180 The receiving application identifier O MSH 06 MSH 07 Receiving Facility HD Date Time of Message TS 180 26 The receiving facility The account number defined forthe R requester This value will be determined by the Client team and Quest Diagnostics The Data Exchange verifies that the field is populated The date and time that the sending system created the R message Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC The Data Exchange verifies that this field is populated and that the value complies with the format above MSH 08 Security MSH 09 Message Type CM The type of message being transmitted and the event R leading to the creati
140. ext gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt Product gt lt ProductName gt CCR Message Specification 188 lt Text gt fluocinolone topical lt Text gt lt Code gt lt Value gt 99220750917 lt Value gt lt CodingSystem gt NDC lt CodingSystem gt lt Code gt lt ProductName gt lt BrandName gt lt Text gt Synemol lt Text gt lt BrandName gt lt Strength gt lt Text gt 0 025 lt Text gt lt Strength gt lt Form gt lt Text gt cream lt Text gt lt Form gt lt Manufacturer gt lt ActorID gt 0c329b267 00010104507926758 725e lt ActorID gt lt Manufacturer gt Product Quantity lt Value gt 2 lt Value gt lt Quantity gt lt Directions gt lt Direction gt lt Dose gt lt Value gt Twice a day lt Value gt lt Dose gt lt Route gt lt Text gt topical lt Text gt lt Route gt lt Frequency gt lt Description gt lt Text gt lt Text gt lt Description gt lt Frequency gt lt Duration gt lt Description gt lt Text gt 35 lt Text gt lt Description gt lt Duration gt lt Direction gt lt Directions gt PatientInstructions Instruction Text Comments to Pharmacist lt Text gt Instruction PatientInstructions lt Refills gt lt Refill gt lt Quantity gt lt Value gt 1 lt Value gt lt Quantity gt lt Refill gt lt Refills gt lt Medication gt lt Medications gt lt
141. f X Benefits IN1 22 Coord Of Ben X Priority IN1 23 Notice Of Admission X Flag IN1 24 Notice Of Admission X Date IN1 25 Report Of Eligibility X Flag IN1 26 Report Of Eligibility X Date IN1 27 Release Information X Code IN1 28 Pre Admit Cert X PAC IN1 29 Verification X Date Time IN1 30 Verification By X IN1 31 Type Of Agreement X Code IN1 32 Billing Status X IN1 33 Lifetime Reserve X Days IN1 34 Delay Before L R Day X IN1 35 Company Plan Code X Patient Demographic HL7 Specification 90 Field Name Type Length Comments Req d IN1 36 Policy Number ST 50 This value appears on the Billing tab gt Primary Insurance O Information section IN1 37 Policy Deductible X IN1 38 Policy Limit X Amount IN1 39 Policy Limit Days X IN1 40 Room Rate Semi X Private IN1 41 Room Rate Private X IN1 42 Insured s X Employment Status IN1 43 Insured s Sex X IN1 44 Insured s Employer X Address IN1 45 Verification Status X IN1 46 Prior Insurance Plan X ID IN1 47 Coverage Type IS 3 Valid values include O T Third party bill P Patient bill C Client bill If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab IN1 48 Handicap X IN1 49 Insured s ID Number X Patient Demographic HL7 Specification 91 ADT A29 Patient Delete Message Segment Specifications The ADT A29 Patient Delete messag
142. f present the field is validated against any stated requirements For outbound feeds Optional indicates that the field may or may not be present in the message Conditional The field may or may not be required depending on certain conditions stipulated in the Comments column of each segment table For inbound feeds Conditional indicates that if the stated conditions are not met the message is rejected If present the field is validated against any stated requirements For outbound feeds Conditional indicates that the field may or may not be present in the message depending on the stated conditions Not Supported The field is not used the corresponding fields appear in gray text in the table Forinbound feeds Not Supported indicates that the field can be present The segment is accepted whether or not this field is present The content of the field is not used but it is validated for field type and length as well as conformance to the specified HL7 table or user defined table as applicable If all fields are successfully validated the content is passed through otherwise the message is rejected For outbound feeds Not Supported indicates that the field is never present in the message Patient Demographic HL7 Specification 64 ADT A28 Patient Add and ADT A31 Patient Update Message Segment Specifications The ADT A28 Patient Add message is used as follows Inbound partner application to Care360
143. graphic Web Service API Reference 56 Retrieve Patient Demographic Web Service XML Schema The messages that are sent to or retrieved from the hub to either retrieve or acknowledge demographic updates via the Retrieve Patient Demographic web service must conform to the following XML schema lt xml version 1 0 encoding UTF 8 gt lt Published by JAX WS RI at http jax ws dev java net RI s version is Oracle JAX WS 2 1 4 SS lt xs schema xmlns tns http www medplus com hub mpi retrieve xmlns xs http www w3 0rg 2001 XMLSchema elementFormDefault qualified version 1 0 targetNamespace http www medplus com hub mpi retrieve gt lt xs element name AckRequest gt lt xs complexType gt lt xsS Sequence gt lt xs element name Retrievalld type xs string gt lt xs element name AckRequestItem type tns ackRequestItemType minOccurs 0 maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name AckResult gt lt xs complexType gt lt xS Sequence gt lt xs element name Status type tns statusType gt lt xs element name ErrorDescription type xs string minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name RetrievalRequest gt lt xs complexType gt lt xs Sequence gt lt xs element name RequestedBatchSize type xs int minOccurs 0 gt lt xs element name RequestType type xs string
144. gt lt xs element name RequestType type xs string minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs complexType name retrieveDemographicMessagesResponse gt lt xs Sequence gt lt xs element name RetrievalResult form unqualified minOccurs 0 gt lt xs complexType gt lt xS Sequence gt lt xs element name Retrievalld type xs string gt lt xs element name RequestedBatchSize type xs int gt lt xs element name ActualBatchSize type xs int gt lt xs element name isMore type xs boolean gt lt xs element name Status type tns statusType gt lt xs element name ErrorDescription type xs string minOccurs 0 gt lt xs element name RetrievalResultItem type tns retrievalResultItemType minOccurs 0 maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs complexType name retrievalResultItemType gt lt xs sequence gt lt xs element name MessageId type xs string gt lt xs element name H17AsBase64Encoded type xs base6 4Binary lt xs sequence gt lt xs complexType gt lt xs complexType name ackDemographicMessages gt lt xs Sequence gt lt xs element name AckRequest form unqualified minOccurs 0 gt lt xs complexType gt lt xs Sequence gt lt xs element name Retrievall
145. hange Password function are accepted on this page Upon successful authentication of a user s Care360 Labs amp Meds User ID and Password a mapping record is stored within Care360 Labs amp Meds that relates the Care360 Labs amp Meds user identity to the partner application user identity passed within the SAML assertion At the same time the user s Care360 Labs amp Meds password is obfuscated so the user will only be able to access Care360 Labs amp Meds via SSO from that point forward If the user requires both SSO based and password based authentication Customer Support may be contacted to request a password reset Existing Care360 Labs amp Meds practices are employed for password resets that is the user must change the password upon the first password based login following a password reset Care360 Labs amp Meds SSO Specification 27 Scenario 2 Care360 Labs amp Meds SSO for Web Services A partner application can leverage SSO in the process of invoking Care360 Labs amp Meds web services on behalf of a previously mapped user see About SSO User Initialization on page 27 Establishing a session using SSO enables the partner application to establish a user specific context to Care360 Labs amp Meds without having to know or store the user s Care360 Labs amp Meds password The only web service available for integration is the User Summary service which is referenced in the following sections From the Care360
146. hanged or removed links to Care360 Labs amp Meds internal destination Custom URL Specifications In order for a partner application to link to a custom branded version of Care360 Labs amp Meds the partner application must connect via a custom URL that identifies the branded version of Care360 Labs amp Meds to display The custom URL can be used to programmatically link the applications or to enable an end user to access the branded version of Care360 Labs amp Meds directly outside the context of the partner application The format of the custom URL is as follows https portal server name gt lt port gt care360 login branduid lt brand uid where portal server name gt lt port gt are the server name and optional port number associated with the Care360 Labs amp Meds installation to which the partner application is connecting and brand uid isarandom number that is generated by Quest Diagnostics to identify the branded Care360 Labs amp Meds instance to display For example https portal care360 com care360 care360 10gin branduid 12345 Partners that allow their users to access Care360 Labs amp Meds directly outside the context of the partner application can either provide their users with the Quest Diagnostics supplied URL or they can create a custom URL by aliasing a more appropriate domain name User Manual and Help Specifications The Care360 Labs amp Meds User Manual and online
147. he field length complies with the rules above PID 12 County Code Patient Demographic HL7 Specification 113 Field Name Type Length Comments Req d PID 13 Phone Number Home XTN 40 Accepted length of this field is 40 numeric characters No O dashes or other separating characters Example extension and country code omitted 333 4445555 Example with country code 1 333 4445555 PID 14 Phone Number XTN 40 Accepted length of this field is 40 numeric characters No O Business dashes or other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 PID 15 Language Patient X PID 16 arital Status X PID 17 Religion X PID 18 Patient Account X umber PID 19 SSN Number Patient ST 16 Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above PID 20 Driver s Lic Num X Patient PID 21 other s Identifier X PID 22 Ethnic Group X PID 23 Birth Place X PID 24 ultiple Birth Indicator X PID 25 Birth Order X PID 26 Citizenship X PID 27 Veterans Military X Status PID 28 Nationality X PID 29 Patient Death Date amp X Time Patient Demographic HL7 Specification 114 Field Name Type Length Comments Req d PID 30 Patient
148. he partner application submits patient demographic and or scheduling update messages to the Data Exchange via the Submit Patient Demographic web service Note Patient demographic and or scheduling update messages provided by the partner application must be formatted according to the specifications detailed in the Chapter 6 Patient Demographic HL7 Specification beginning on page 62 2 The Data Exchange receives the patient demographic and or scheduling messages from the partner application and verifies the format and content of those messages 3 The Data Exchange records the patient demographic transaction and stores a copy of the discrete content of the messages for 90 days 4 The Data Exchange converts the patient demographic ADT and or scheduling SIU update messages to the Care360 Labs amp Meds format and then forwards the messages to Care360 Labs amp Meds 5 Care360 Labs amp Meds applies the updates to its patient database and or scheduling system Any validation errors that occur within Care360 Labs amp Meds are returned to the Data Exchange Submit Patient Demographic Web Service API Reference 43 Process Walkthrough Receiving Patient Demographic Updates The diagram below illustrates at a high level the flow of information between Care360 Labs amp Meds the Data Exchange and a partner application Following the diagram is a step by step walkthrough of the patient demographic processes illustrated in the di
149. he syntax of a message Field Name Type Length Comments Req d MSH O0 Segment Type ID ST 4 Must be MSH R MSH 01 Field Separator ST 1 The separator between the message segment ID MSH R and the first real data field MSH 02 Defines the character to be used as a separator for the rest of the message The value is a vertical bar MSH 02 Encoding Characters ST 4 Four characters that are used in the following order R component separator repetition separator escape character and subcomponent separator Format amp These values are recommended by HL7 and are the only values supported MSH 03 Sending Application HD 180 The name of the sending application O MSH 04 Sending Facility HD 180 The sending facility Identifies the owner of the patient data R and who initiated the patient demographic request This value will be provided by Quest Diagnostics The Data Exchange verifies that the field is populated MSH 05 Receiving HD 180 The receiving application identifier O Application MSH O6 Receiving Facility HD 180 The receiving facility The account number defined forthe R requester This value will be determined by the Client team and Quest Diagnostics The Data Exchange verifies that the field is populated MSH 07 Date Time of TS 26 The date and time that the sending system created the R Message message Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC
150. help can be replaced with a generic user manual and help which contain no references to Quest Diagnostics and no Care360 Labs amp Meds or Quest Diagnostics branding such as logos or images Linking to Care360 Labs amp Meds 13 About the Care360 SSO and Web Services Site The Care360 Labs amp Meds SSO and Web Services site is a companion to the Care360 Linking and Single Sign On SSO Programmer Reference that provides additional support to vendors who are developing partner applications to interact with Care360 Labs amp Meds The website provides sample code documentation and other tools and resources that can be used to understand how to develop a partner application to interact with Care360 Labs amp Meds via SSO and web services Care360 SINGLE SIGN ON AND WEB SERVICES Welcome to the reference site for connecting to Care360 This site is designed to provide resources to vendors who are implementing applications which will connect with Care360 for Single Sign On and for Web Services Support Contacts Connectivity Help Desk 800 697 9302 WSDL Stage https portal care180 com care360 services UsersummaryWebService WSDL Production https portal care360 com care360 services UserSummaryWebService WSDL Documentation Care360 Linking and SSO 14 1 Prog Ref pdf PDF 4 1 MB The documentation for creating and understanding the linking done through Single Sign On and Web Service is contained here Excellence Winner of STC s Inter
151. ice to perform the desired functions The following section describes how to obtain the WSDL document for Submit the Patient Demographic web service Note You must have a valid user name and password issued by Quest Diagnostics in order to access the WSDL interface documents For the Production environment a user name and password will be issued once your application has been developed tested and certified Accessing the Submit Patient Demographic Web Service WSDL Document To access the WSDL service description for the Submit Patient Demographic web service use your browser to access the URL corresponding to one of the following Data Exchange environments Staging environment Use this environment for developing testing and certifying your web service application For the Staging environment URL and endpoint see Staging Environment below Production environment Use this environment after your web service application has been certified For the Production environment URL and endpoint see Production Environment below To save the WSDL document to your hard disk access the document using your browser and then select File gt Save As Staging Environment To access the Submit Patient Demographic web service in the Staging environment access the following link WSDL Document https shubservices questemr com demographic service wsdl Endpoint https shubservices questemr com demographic service Production Envir
152. ill be provided by Quest Diagnostics The Data Exchange verifies that the field is populated MSH 05 Receiving Application HD 180 The receiving application identifier O Patient Demographic HL7 Specification 117 Field Name Type Length Comments Req d MSH 06 Receiving Facility HD 180 The receiving facility The account number defined forthe R requester This value will be determined by the Client team and Quest Diagnostics The Data Exchange verifies that the field is populated MSH 07 Date Time of Message TS 26 The date and time that the sending system created the R message Format yyyymmddhhmmss Note All date timestamps are set to Coordinated Universal Time UTC The Data Exchange verifies that this field is populated and that the value complies with the format above MSH O8 Security X MSH O9 Message Type CM 7 The type of message being transmitted and the event R leading to the creation of the message Acceptable values for this field SIU S12 New Appt SIU S14 Modify Appt SIU S15 Cancel Appt SIU ST7 Delete Appt MSH 10 Message Control ID ST 20 A number or other data that uniquely identifies the R message in its transmission to the receiving system MSH 11 Processing ID PT 3 The placer system s intent for the message Valid values R include P Production T Testing The Data Exchange verifies that the value in this field is P or T MSH 12 Version ID ID 8 The value for this field is 2 3 R
153. in a code describing the cancel reason the delete reason the discontinue reason the add reason the block reason or any other code describing the reason that a specific event will occur Both of the following subfields are required by Care360 Labs amp Meds and SCH 06 02 Event Reason Text must be populated for a DFT message to be generated SCH 06 01 Event reason ID SCH 06 02 Event reason text Format Event Reason ID Event Reason Text There is no validation that SCH 06 02 is populated SCH 06 02 is displayed in Care360 Labs amp Meds on the main page Today s Patients section The event reasonitself does not trigger an action such as canceling an appointment if the event reason is Canceled However lack of a value for SCH 06 02 prohibits a DFT message from being created Patient Demographic HL7 Specification 120 Field SCH 07 Name Type Appointment Reason CE 200 Length Comments Req d Contains an identifier code for the reason that the O appointment is to take place This field may contain a Universal Service Identifier describing the observation test battery procedure or other activity that is to take place during the requested appointment similar to the Universal Service Identifier defined for the OBR segment in the Order Entry chapter of the HL7 standard It may also contain a site specific code describing a pre defined set of reasons that an appointment may be set to occur This cod
154. ion 100 Field Name Type Length Comments ZA c Ee d PV1 09 Consulting Doctor X PV1 10 Hospital Service X PV1 11 Temporary Location X PV112 Preadmit Test Indicator X PV113 Readmission Indicator X PV114 Admit Source X PV115 Ambulatory Status X PV116 VIP Indicator X PV1 17 Admitting Doctor X PV118 Patient Type X PV119 Visit Number X PV1 20 Financial Class X PV1 21 Charge Price Indicator X PV1 22 Courtesy Code X PV1 23 Credit Rating X PV1 24 Contract Code X PV1 25 Contract Effective Date X PV1 26 Contract Amount X PV1 27 Contract Period X PV1 28 Interest Code X PV1 29 Transfer to Bad Debt X Code PV1 30 Transfer to Bad Debt X Date PV1 31 Bad Debt Agency Code X PV1 32 Bad Debt Transfer X Amount PV1 33 Bad Debt Recovery X Amount PV1 34 Delete Account X Indicator Patient Demographic HL7 Specification 101 Field Name Type Length Comments Req d PV1 35 Delete Account Date X PV1 36 Discharge Disposition X PV1 37 Discharged to Location X PV1 38 Diet Type X PV1 39 Servicing Facility X PV1 40 Bed Status X PV1 41 Account Status X PV1 42 Pending Location X PV1 43 Prior Temporary X Location PV1 44 Admit Date Time X PV1 45 Discharge Date Time X PV1 46 Current Patient Balance X PV1 47 Total Charges X PV1 48 Total Adjustments X PV1 49 Total Payments X PV1 50 Alternate Visit ID X PV1 51 Visit
155. iority NM 2 DG1 16 Diagnosing Clinician XCN 60 Patient Demographic HL7 Specification 132 Field Name Type Length Comments Req d DG117 Diagnosis IS 3 Valid values O Classification C Consultation D Diagnosis M Medication antibiotic O Other R Radiological scheduling not using ICDA codes S Sign and symptom T Tissue diagnosis Invasive procedure not classified elsewhere LV catheter etc DG118 Confidential Indicator ID 1 O DG119 Attestation Date Time TS 26 O RGS Resource Group Segment The Resource Group RGS segment contains resource group information The RGS segment is required by HL7 so it must be sent in the SIU message However Care360 Labs amp Meds does not use any of the information submitted in this segment Field Name Type Length Comments Req d RGS OO Segment Type ID ST 4 Must be RGS R RGS O1 Set ID RGS SI 4 R RGS 02 Segment Action Code ID 3 O RGS 03 Resource Group ID CE 200 O AIS Appointment Information Services Segment The Appointment Information Services 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 Note This segment is not used by Care360 Labs amp Meds Field Nam
156. is value appears on the Billing tab Primary Insurance Information section IN1 04 Insurance Company XON 130 This value appears on the Billing tab Primary Insurance O Name Information section IN1 05 Insurance Company XAD 106 No more than 106 characters Alphanumeric data only O Address lt street address ST gt lt other designation ST gt lt city ST gt lt state or province ST gt lt zip or postal code ST gt lt country ID gt lt address type ID gt lt other geographic designation ST gt lt county parish code IS gt lt census tract IS gt IN1 06 Insurance Co X Contact Person IN1 07 Insurance Co Phone X Number IN1 08 Group Number ST 50 Characters permitted include O A Z and 0 9 If present the Data Exchange verifies that the value complies with the rules above This value appears on the Billing tab Primary Insurance Information section IN1 09 Group Name XON 130 O IN1 10 Insured s Group Emp X ID IN1 11 Insured s Group Emp X ame IN1 12 Plan Effective Date X IN113 Plan Expiration Date X IN1 14 Authorization X Information IN115 Plan Type X IN116 ame Of Insured X Patient Demographic HL7 Specification 89 Field Name Type Length Comments Req d IN117 Insured s X Relationship To Patient IN118 Insured s Date Of X Birth IN1 19 Insured s Address X IN1 20 Assignment Of X Benefits IN1 21 Coordination O
157. isit Additional Info Optional not used DB1 Disability Information Optional not used OBX Observation Result Optional not used FT1 Financial Transaction Required multiple allowed One FT1 segment created for each procedure code PR1 Procedure Optional multiple allowed one per procedure code ROL Role Optional not used DG1 Diagnosis Optional multiple allowed DRG Diagnosis Related Group Optional not used GT1 Guarantor Optional multiple allowed IN1 Insurance Optional multiple allowed IN2 Insurance Additional Info Optional not used IN3 Insurance Additional Info Cert Optional not used Acc Accident Information Optional not used Note If no procedure codes are available in the billing data Care360 Labs amp Meds submits the DFT message as follows Only one FT1 Financial Transaction segment is created and FT1 25 Procedure Code is blank NoPRI Procedure segment is created In the hierarchy shown above braces indicate where multiple items are allowed and brackets 1 indicate items that are optional Patient Demographic HL7 Specification 138 Message Segment Specifications This section provides detailed specifications for each segment of the DFT PO3 message that can be submitted by Care360 Labs amp Meds Supported message segments include the following MSH Message Header Segment on page 139 e EVN Event Type Segment
158. istinguish real time and batch updates each type is submitted to the Data Exchange via its own Submit Patient Demographic web service method For information on the real time and batch methods see Submit Patient Demographics Method Details on page 45 PID Only vs Fuzzy Matching There are two methods available for processing patient demographic merge requests Partners must specify their preferred method during the initial integration process with Care360 Labs amp Meds The two methods include the following PID Only Matching This method relies solely on the ability of the partner application to identify a patient using a unique patient identifier PID When using this method the information provided by the partner application is always considered the most accurate that is it overrides any existing data in Care360 Labs amp Meds Fuzzy Matching This method requires the partner application to pass a minimum set of patient demographic data in addition to the PID to identify the patient Care360 Labs amp Meds uses the supplied patient demographic data to attempt to identify the matching patient s to complete the patient demographic update request For additional information see PID Only Matching Detail on page 40 and Fuzzy Matching Detail on page 41 PID Only Matching Detail The following table provides additional details on the rules associated with PID only matching for patient demographic updates PID Only
159. iv Content Type content text html charset UTF 8 gt lt meta gt title Care360 title head body bgcolor FFFFFF gt lt body gt lt html gt Care360 Labs amp Meds SSO Specification 28 Following are a few details from the traffic example on the previous page AUser Agent header must be specified Care360 Labs amp Meds authentication will fail if this header is not provided The header value is not important so you may specify anything you want as long as it is unique and does not match that of any popular web browser AX Care360 IsForWebService header must be specified in order to prevent concurrent session termination issues as the user will likely be using Care360 Labs amp Meds within a web browser as well ThetargetUri parameter is not needed However if provided it will be ignored A blank HTML page is returned regardless upon successful authentication Only the Care360 Labs amp Meds session cookies Set Cookie response headers are important within an HTTP response indicating success The session cookies are passed back to the Care360 Labs amp Meds server on a subsequent web service request Example 2 Traffic of HTTP SSL Request to User Summary Service Following Authentication REQUEST POST care360 services UserSummaryWebService HTTP 1 0 Host localhost 7001 Content Type text xml charset UTF 8 Content Length 400 Connection Keep Alive SOAPAction Cookie JSES
160. ix Prefix and Degree are passed to from Care360 Labs amp Meds PID 10 Race PID 11 Patient Address XAD 106 No more than 106 characters however limits may apply O to some subfields depending on your implementation Check with your project manager for the subfield limits Alphanumeric data only A street address ST gt lt other designation ST city ST state or province ST zip or postal code ST country ID address type ID other geographic designation ST county parish code IS census tract IS gt The Data Exchange verifies that the field length complies with the rules above PID 12 County Code Patient Demographic HL7 Specification 107 Field Name Type Length Comments Req d PID 13 Phone Number Home XTN 40 Accepted length of this field is 40 numeric characters No O dashes or other separating characters Example extension and country code omitted 333 4445555 Example with country code 1 333 4445555 PID 14 Phone Number XTN 40 Accepted length of this field is 40 numeric characters No O Business dashes or other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 PID 15 Language Patient X PID 16 arital Status X PID 17 Religion X PID 18 Patient Account X
161. kets 1 indicate items that are optional Message Segment Specifications This section provides detailed specifications for each segment of an ADT A39 Patient Merge message Supported message segments include the following MSH Message Header Segment on page 104 EVN Event Type Segment on page 105 PID Patient Identification Segment Correct on page 106 PD1 Patient Additional Demographic Segment on page 109 MRG Merge Patient Information Segment on page 111 PID Patient Identification Segment Incorrect on page 112 Notes ADT A39 message segments that are not supported are not included in this section for detailed specifications refer to the HL7 2 3 Specification All date timestamps are set to Coordinated Universal Time UTC Patient Demographic HL7 Specification 103 MSH Message Header Segment The Message Header MSH segment defines the intent source destination and some specifics of the syntax of a message Field MSH 00 MSH O1 Name Type Segment Type ID ST Field Separator ST Length Comments Req d 4 1 Must be MSH R The separator between the message segment ID MSH R and the first real data field MSH 02 Defines the character to be used as a separator for the rest of the message The value is a vertical bar MSH 02 MSH 03 Encoding Characters ST Sending Application HD 180 Four characters that are used in the
162. l Types These are the required fields based on what is sent XML XML Sub Header Main Tag Tag Description Client Patient Insurance ePre IN1 Insurance IN1 04 Insurance Name O O O Information Valid insurance names appear in continued the Select Carrier drop down list in Lab Orders and Results Note Insurance name is recommended for a bill type IN1 47 of T Insurance If insurance name is not provided it must be entered manually before an order can be placed If an invalid insurance name is provided a valid insurance carrier will need to be selected from the carriers listed during order entry IN1 05 ADI Address 1 O O O AD 2 Address 2 O O O AD 3 City O O O AD 4 State 2 digit alpha O O O AD 5 Zip 5 or 9 digits no hyphens or O O O dashes allowed AD 6 Country IN1 08 Group Number no hyphens or dashes allowed IN1 36 Insurance ID O O O IN1 47 Bill Type R R R O P Patient C Client T Insurance a R Required O Optional Ignored Linking to Care360 Labs amp Meds Process Walkthrough Linking and SSO The diagram below illustrates at a high level the flow of information between Care360 Labs amp Meds and a linked partner application Following the diagram is a step by step walkthrough of the linking and SSO processes illustrated in the diagram Linking to Care360 Labs amp Meds Physician Office Lab Orders SeachBy SSN
163. la tir Tigrinya Patient Demographic HL7 Specification 173 ISO 639 2 Code English Name ISO 639 2 Code English Name sms Skolt Sami tem Timne den Slave Athapascan tiv Tiv slo Slovak tli Tlingit slv Slovenian tpi Tok Pisin som Somali tkl Tokelau tog Tonga Nyasa vot Votic ton Tonga Tonga Islands win Walloon tsi Tsimshian war Waray tso Tsonga was Washo tsn Tswana wel Welsh tum Tumbuka fry Western Frisian tur Turkish wal Wolaytta tuk Turkmen wol Wolof tvi Tuvalu xho Xhosa tyv Tuvinian sah Yakut twi Twi yao Yao udm Udmurt yap Yapese ukr Ukrainian yid Yiddish umb Umbundu yor Yoruba und Undetermined zap Zapotec hsb Upper Sorbian zza Zazaki uig Uyghur zen Zenaga uzb Uzbek zha Zhuang vai Vai zul Zulu ven Venda zun Zuni Patient Demographic HL7 Specification 174 Chapter 7 CCR Message Specification In This Chapter A CCR Message SDECINECSEIBI dade ido aa a a a A a AEA aa a A Aa a A due pq edt a Ri A A A a a A a A 175 About the CCR Message Specification This chapter provides detailed format specifications for Prescription Order messages in Continuity of Care Record CCR format This chapter includes the following sections CCR message specifications The CCR Message Specification defines the intent source destination and some specifics of the syn
164. link WSDL Document https portal Care360 com Care360 services UserSummaryWebService WSDL Endpoint https portal Care360 com Care360 services UserSummaryWebService User Summary Web Service API Reference 37 Chapter 4 Submit Patient Demographic Web Service API Reference In This Chapter About the Submit Patient Demographic Web Service 0 cee as Submit Patient Demographic Web Service API Reference serik nee an Aboutthe WSDL lnteriace Document A peria er P deeded HWE he ad Ghee REG br obl dab ee bee aos About the Submit Patient Demographic Web Service Patient demographics integration enables patient demographic changes that occur within either Care360 Labs amp Meds or a partner application for example a Practice Management System PMS to be synchronized with the other in order to maintain the integrity of patient demographic data between the two applications The Submit Patient Demographic web service enables each application to submit patient demographic updates to the Data Exchange which then forwards pushes the updates to the opposing application In addition the Submit Patient Demographic web service enables a partner application to submit scheduling updates to Care360 Labs amp Meds and enable Care360 Labs amp Meds to submit financial billing transactions to a partner application Note The ability for Care360 Labs amp Meds to push scheduling updates to a partner application
165. lt orgName gt orgUID xsi type xsd string gt 2c928dc01195313601119a206c3700 6 orgUID Care360 Labs amp Meds SSO Specification 29 lt WSOrg gt WSOrg xsi type n1 WSOrg gt lt orgName xsi type xsd string gt AUTO LNR US06 lt orgName gt orgUID xsi type xsd string gt 2c928dc01195313601119a22079700 7 lt orgUID gt lt WSOrg gt WSOrg xsi type n1 WSOrg gt orgName xsi type xsd string gt AUTO LNR US07 lt orgName gt orgUID xsi type xsd string 2c928dc01195313601119a24307c00f 8 orgUID WSOrg WSOrg xsi type n1 WSOrg gt orgName xsi type xsd string gt AUTO LNR US08 orgName orgUID xsi type xsd string gt 2c928dc01195313601119a25a3 200 9 lt orguiID gt lt WSOrg gt orgList timeStamp xsi type xsd dateTime gt 2010 04 17T12 59 59 420Z lt timeStamp gt lt result gt lt m getOrgsResponse gt env Body lt env Envelope gt For more information about the User Summary services see Chapter 3 User Summary Web Service API Reference beginning on page 31 About Session Timeouts and Terminations Session timeout conditions do not need to be actively considered by the partner application integrator when establishing SSO for web services as long as an SSO authentication action is made on a new session each time a web service is called The example application code above demonstrates this model However following is some background as to how Care360 Labs amp M
166. lue gt set to the NDC DrugNumber and the lt Coding gt set to NDC as in the lt ProductName gt example above O CCR Message Specification 180 Attributes Data Objects XML Tag Medications lt BrandName gt continued Comments Call to Multim database to retrieve brand name using NDC The BrandName Text element is defined as xs string type Example lt BrandName gt lt Text gt Synemol lt Text gt lt BrandName gt Req d lt Manufacturer gt Call to Multim database to retrieve Manufacturer Name using NDC The Manufacturer contains an ActorlD which will correspond to an entry in the Actors section of the CCR Example lt Manufacturer gt lt ActorID gt 0c329b267f00010104507926758f 725e lt ActorID gt lt Manufacturer gt lt Strength gt Call to Multim database to retrieve strength using NDC The Strength element is defined as xs string type Example lt Strength gt lt Text gt 0 025 lt Text gt lt Strength gt lt Form gt Call to Multim database to retrieve dose form using NDC The Form element is defined as xs string type Example lt Form gt Text cream Text lt Form gt Concentration Not currently used NS Size Not currently used NS Quantity The amount of the medication to be given The Quantity element is defined as xs string type Example Quantity lt Value gt 2 lt Value gt lt Quan
167. mber but no primary Home phone number the first sequence must be blank The accepted length for each phone number is 20 numeric characters No dashes or other separating characters are allowed Example with home and cell phone extension and country code omitted and email 333 4445555 NET exampleGemail com CP 777 8889999 Example with home and cell phone including country code 1 333 4445555 cp 1 777 8889999 The Data Exchange verifies that the value complies with the rules above PID 14 Phone Number XTN 40 Accepted length of this field is 40 numeric characters No O Business dashes or other separating characters Example with extension country code omitted 5 333 4445555 999 Example with extension and country code 1 333 4445555 999 PID 15 Language Patient CE 250 Values supported by Care360 Labs amp Meds are listedin O Patient Language PID 15 on page 168 This field uses the HL7 3 0 field length of 250 rather than the HL7 2 3 field length of 60 Patient Demographic HL7 Specification 126 Field PID16 Name Marital Status Type IS Length Comments Req d 1 Values supported by Care360 Labs amp Meds are listed O below P Polygamous W Widowed D Divorced M Married A Annulled Sc Never Married L Legally Separated Interlocutory T Domestic Partner If a value other than those listed is sent the patient s mari
168. ment URL and endpoint see Staging Environment below Production environment Use this environment after your web service application has been certified For the Production environment URL and endpoint see Production Environment below To save the WSDL document to your hard disk access the document using your browser and then select File gt Save As Staging Environment To access the User Summary web service in the Care360 Labs amp Meds Staging environment access the following link WSDL Document https portal care180 com Care360 services UserSummaryWebService WSDL Endpoint https portal care180 com Care360 services UserSummaryWebService Production Environment Once you have developed tested and certified your web service client application in the Care360 Labs amp Meds Staging environment you can then update the application to work in the Care360 Labs amp Meds Production environment Connecting a web service client to the Care360 Labs amp Meds Production environment is similar to connecting to the Staging environment the exposed interfaces are equivalent Note Client applications developed against the Staging environment WSDL document can also be used to access the Care360 Labs amp Meds Production environment and vice versa the WSDL content is identical in both environments User Summary Web Service API Reference 36 To access the User Summary web service in the Production environment access the following
169. ments Req d PID 13 Phone Number Home XTN 40 Repeating field that can included Home phone number Cell Mobile phone number and email address Note the following If the Home phone number is sent it will be the first occurrence If the Cell Mobile phone number is sent then telecommunication equipment type ID gt will equal CP If there is a Cell Mobile phone number but no primary Home phone number the first sequence will be blank The accepted length for each phone number is 20 numeric characters No dashes or other separating characters are allowed Example with home and cell phone extension and country code omitted and email 333 4445555 NET exampleGemail com CP 777 8889999 Example with home and cell phone including country code 1 333 4445555 cp 1 777 8889999 PID 14 Phone Number XTN 40 Length of this field is 20 numeric characters Nodashes or O Business other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 PID 15 Language Patient CE 250 Values supported by Care360 Labs amp Meds are listed in O Patient Language PID 15 on page 168 This field uses the HL7 3 0 field length of 250 rather than the HL7 2 3 field length of 60 Patient Demographic HL7 Specification 144 Field PID16 Name Marital Status Type IS Length Comments 1
170. n If NDC is found in the supply tables set to Supply The Type element is defined as xs string type Example Type lt Text gt Medication lt Text gt lt Type gt CCR Message Specification 179 Attributes Data Objects XML Tag Medications lt Status gt continued Comments Always set to Active The Status element is defined as xs string type Example lt Status gt lt Text gt Active lt Text gt lt Status gt Req d lt Source gt This is an Actor tag with the ActorID of the Physician Actor in the Actor section The ActorlD and ActorRole elements are all defined as xs string type Example Source Actor ActorID 0C329aef7 0001010450792624f1f5cd lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt R Comment ID gt Not currently used NS lt Description gt Not currently used NS lt Product gt Structural grouping element lt ProductName gt Call to Multim database to retrieve product name using NDC The ProductName Text element and the Value and Coding System are all defined as xs string types Example lt ProductName gt lt Text gt fluocinolone topical lt Text gt Code gt Value 99220750917 Value CodingSystem NDC CodingSystem Code lt ProductName gt R lt Code gt The Code tag will have the lt Va
171. n the Care360 Labs amp Meds SSO keystore If found this step succeeds This control prevents rogue third parties from forging the identities of Care360 Labs amp Meds customers and also thwarts man in the middle attacks that attempt to modify the SAML message in transit Was the SAML response created in a timely manner Care360 Labs amp Meds SSO enforces a strict time tolerance window allowing only for a 180 second discrepancy between your clock and ours outside of which a SAML response is not accepted This control prevents the future posting of any intercepted and captured SAML response by a malicious third party should a security breach occur and helps to ensure that timely information transmitted Note You may specify a Conditions node within your SAML assertion to narrow the time tolerance window if you prefer The time tolerance window always reflects the narrower of the two settings Is the partner s Issuer recognized by Care360 Labs amp Meds Having verified the signature of the SAML response Care360 Labs amp Meds is assured that the Issuer value transmitted within the SAML assertion reflects your partner profile When Care360 Labs amp Meds SSO locates this value in its SAML partner configuration data your site s identity is verified as a viable SAML asserter stheasserted partner application user recognized by Care360 Labs amp Meds The NameIdentifier value within the SAML assertion provides unique identificatio
172. n contains a single patient with the same PID for the correct patient and a single patient with the same PID for the incorrect patient those patients are merged Ifthe target organization contains more than one patient with the same PID for either the correct patient or the incorrect patient Care360 Labs amp Meds returns an error to the partner application Schedule Patient If the incoming PID matches no existing patient in the target organization the patient is added ftheincoming PID matches a single patient in the target organization that patient is updated Ifthe incoming PID matches more than one existing patient Care360 Labs amp Meds returns an error to the partner application a You cannot delete a patient after clinical entries for example lab results have been associated with that patient or if the patient is associated with an alias patient If a delete cannot be performed due to either of these conditions an error message is returned Fuzzy Matching Detail The following table provides additional details on the rules associated with fuzzy matching for patient demographic updates Fuzzy Matching Request Potential Results Add Patient fCare360 Labs amp Meds finds no high confidence match between existing patients in the target organization and the incoming patient demographics the patient is added fCare360 Labs amp Meds finds a high confidence match between a single patient in
173. n of the user as recognized by the partner application Care360 Labs amp Meds SSO looks up this user identifier in its user mapping table to determine the correlating Care360 Labs amp Meds user identity If found a Care360 Labs amp Meds login session is established for the user If not found Care360 Labs amp Meds SSO presumes the user is accessing Care360 Labs amp Meds via SSO for the first time and directs the user to a one time Care360 Labs amp Meds login page for an overview of this process see Initializing a User s SSO Connection on page 9 Does the asserted partner application user correlate to the partner providing the assertion When a user s identity from the partner application is correlated to his her Care360 Labs amp Meds user identity the partner application s Issuer is also recorded for that user On subsequent requests to Care360 Labs amp Meds the SAML Issuer is compared to that stored in the user s mapping record If they match Care360 Labs amp Meds SSO is assured that the user does in fact belong to the partner site that is asserting the user s identity D HTTP Response is received The page requested via the targetUri HTTP POST parameter is returned by Care360 Labs amp Medstothe partner application user application within the HTTP Response The returned page reflects the user s new Care360 Labs amp Meds login session Care360 Labs amp Meds SSO Specification 25 Scenario 1 Care360 Labs amp M
174. nancial Transaction message DOB Date of Birth EHR Electronic Health Record EMR Electronic Medical Record HCPCS Healthcare Common Procedure Coding System HL7 Health Level Seven HTTP Hypertext Transfer Protocol HTTPS Hypertext Transfer Protocol Secure ICDA International Classification of Diseases ICD9 or ICD 9 International Classification of Diseases of the World Health Organization 9th Revision IPA Independent Physician Association MDM HL7 Medical Document Management message MRN Medical Record Number NPI National Provider Identifier NDC National Drug Code PBM Pharmacy Benefit Manager PDF Portable Document Format PMS Practice Management System PPMS Physician Practice Management System About This Manual Abbreviation Acronym Description SAML Security Assertion Markup Language SOAP Simple Object Access Protocol SIU HL7 Patient Schedule message SSL Secure Sockets Layer SSO Single Sign On UB Universal Bill UDDI Universal Description Discovery and Integration UPIN Universal Physician Identifier Number URI Uniform Resource Identifier URL Uniform Resource Locator W3C World Wide Web Consortium WSDL Web Services Definition Language XML eXtensible Markup Language About This Manual xi Related Documentation In addition to this Programmer Reference the following resources are also available for the individual components of Care360 Data Exchange Care360 E
175. national Summit Awards Competition 2013 Summit Aan k Applications Example SSO Care360 stage 8 21 09 zip ZIP 210 KB The executable connects through Single Sign On to the Care360 stage environment Code Example SSO Care360 stage src 8 15 09 zip ZIP 980 KB This is the source code for Example SSO Care360 Stage in C Requires ComponentSpace Trial License This section provides an overview of each of the tools provided on the Care360 Labs amp Meds SSO and Web Services site as well information about accessing the site online Note For information about linking a partner application to Care360 Labs amp Meds see Chapter 1 Linking to Care360 Labs amp Meds beginning on page 1 Accessing the Care360 SSO and Web Services Site The Example SSO Care360 Stage application in addition to a number of other resources for partners who are developing applications to interact with Care360 Labs amp Meds is available for download from the Care360 Labs amp Meds SSO and Web Services site The Example SSO application as well as the complete source code are provided as individual zip files and require a valid username and password provided by Quest Diagnostics for access In addition to providing access to the Example SSO application the Care360 SSO and Web Services site provides additional Care360 Labs amp Meds related information and resources such as the following Support Contact information for various member
176. nd so on This SAML message is typically posted directly to the Care360 Labs amp Meds secure web server using the SAML Browser POST profile Some of the various third party SAML toolsets available include the following ComponentSpace SAML NET for the Windows NET platform OpenSAML for Java Quest Diagnostics can provide sample implementations using the above toolsets which can be used as a starting point and for performing system checks for your configuration Care360 Labs amp Meds SSO Specification 21 Establishing Organizational Trust This section provides a list of business processes that you can follow to facilitate the collection of identifiers and credentials for your site as well as to assess the fitness and requirements of your application infrastructure for the use of SAML in place of Care360 Labs amp Meds passwords The high level processes for establishing organization trust include the following D Performing a security assessment Quest Diagnostics will work with you to review application security network security password aging practices password complexity rules and user account management practices to determine whether or not your system operates at a minimum level of discipline across these areas D Obtaining a digital certificate This is an RSA encrypted certificate that your application will use for signing SAML assertions before passing them to Care360 Labs amp Meds You must generate a private key
177. ng the check digit scheme employed ID assigning authority HD identifier type code IS assigning facility HD gt Subfields sent by Care360 Labs amp Meds as populated in SCH O2 Filler Appointment ID in the original SIU message PV1 19 01 The vendor specific appointment ID as populated in SCH O1 01 PV1 19 04 The system that created the ID as populated in SCH 02 02 PV1 19 is not always populated The following scenarios explain when you can expect a value for PV1 19 If the patient has one appointment and one superbill the first DFT message sent to the partner application after the appointment contains the visit number appointment ID in PV1 19 If the patient has one appointment and two superbills PV1 19 is populated only in the first superbill If the patient has two appointments on the same day and two superbills PV1 19 is populated as follows Forthe first SOAP note the Care360 Labs amp Meds user is prompted to select the correct appointment and that value is sent in PV1 19 in the first superbill For the second SOAP note the remaining appointment is automatically sent in PV1 19 in the second superbill If the patient has two appointments and one superbill then the other appointment ID is available to be billed as follows Ifyou want to send a superbill without that ID then you must manually select an older closed appointment one that has already been billed out o
178. not supported PV1 Patient Visit Data Required PV2 Patient Visit Additional Info Optional not supported DB1 Disability Information Optional not supported oBx Observation Result Optional not supported In the hierarchy shown above braces indicate where multiple items are allowed and brackets 1 indicate items that are optional Message Segment Specifications This section provides detailed specifications for each segment of an ADT A29 Patient Delete message Supported message segments include the following MSH Message Header Segment on page 93 EVN Event Type Segment on page 94 P D Patient Identification Segment on page 95 e PV1 Patient Visit Data Segment on page 100 Notes ADT A29 message segments that are not supported are not included in this section for detailed specifications refer to the HL7 2 3 Specification All date timestamps are set to Coordinated Universal Time UTC Patient Demographic HL7 Specification 92 MSH Message Header Segment The Message Header MSH segment defines the intent source destination and some specifics of the syntax of a message Field MSH 00 MSH O1 Name Type Segment Type ID ST Field Separator ST Length Comments Req d 4 1 Must be MSH R The separator between the message segment ID MSH R and the first real data field MSH 02 Defines the character to be used as a separator for the r
179. ns the scheduled appointment s timing and R Quantity quantity as scheduled by the filler application Format quantity CQ interval CM gt duration CM start date time TS end date time TS priority ID condition ST text TX conjunction ID order sequencing CM gt Note The date timestamp must be set to Coordinated Universal Time UTC The Data Exchange verifies that the start date and time SCH 11 04 and end date and time SCH 11 05 are valid Used on the Care360 Labs amp Meds main page in the Today s Patients section to group appointments by date and time SCH 12 Placer Contact Person XCN 48 Identifies the person responsible for requesting the O scheduling of a requested appointment Most often this person will be the same person responsible for executing the appointment SCH 13 Placer Contact Phone XTN 40 O Number SCH 14 Placer Contact Address XAD 106 O SCH 15 Placer Contact PL 80 O Location SCH 16 Filler Contact Person XCN 48 Identifies the person responsible for the scheduling ofthe R requested appointment Most often this person will be the same person responsible for maintaining the schedule and for reviewing appointment requests SCH 17 Filler Contact Phone XTN 40 O Number SCH 18 Filler Contact Address XAD 106 O SCH 19 Filler Contact Location PL 80 O SCH 20 Entered by Person XCN 48 Identifies the person responsible for entering the request R for the s
180. nsaction XML is based on the HL7 A31 segment defined by the xsd file http custcenter medplus com tech support portalcenter docs xsd ADT A31 xsd The value of the Care360Transaction parameter must be Base64 encoded by the partner application When utilizing the Care360Transaction method and requesting to land on the lab orders function a partner application must include the bill type Cclient patient or insurance and associated required fields Linking to Care360 Labs amp Meds 4 SSO Field Definitions The table below describes the required fields for each available bill type The Care360 transaction method also allows for the inclusion of diagnosis codes and test codes via the laborderInfo node when requesting the Lab Orders function The XSD files used to define the contents of the care360 Transaction HTTP parameter and a Care360 transaction example XML message can be accessed from the following URL http custcenter medplus com tech support portalcenter Bill Types Thesearethe required fields based on what is sent XML XML Sub Header Main Tag Tag Description Client Patient Insurance ePre lab Lab Order dxCodes Diagnosis Code ICD9 Codes O O O l Info 10 codes max testCodes Order Code Quest Diagnostics O O O specific 15 codes max PID Patient PID O2 CM Pat ID1 Unique patient ID R R R R Information Note The patient ID or SSN is always required If patient SSN PID 19 is supplied
181. ntation must employ the digital certificate and SAML identifiers shared and configured as outlined in the previous sections of this chapter This section outlines the general steps required to authenticate successfully to Care360 Labs amp Meds via SAML Sample implementations are provided later in this guide to illustrate how these steps are facilitated on various platforms and in various usage scenarios for example a web service vs a user s browser These instructions are based upon the SAML Browser POST profile model The following general actions must occur in order to authenticate a partner application user to Care360 Labs amp Meds using SAML 111 1 Theuser is authenticated in the partner application Before accessing a link to a Care360 Labs amp Meds feature using SSO the user must authenticate to the partner application environment The means used to authenticate must be that which was previously approved during the security assessment 2 The user selects a linked Care360 Labs amp Meds feature The user takes some action for example clicking a button or submitting a form that correlates to a feature hosted by Care360 Labs amp Meds This action triggers the SAML authentication process and directs Care360 Labs amp Meds to serve the requested content once authentication has been achieved The requested content contains a target URI targetUri plus possible application context parameters 3 TheSAML assertion is created Using a
182. ntly used S Alerts Alert Alerts are not currently being sent in this document NS Medications Medication Structural grouping element O lt CCRDataObjectID gt Must be a unique Object ID to identify this specific R instance of a Medication for this CCR document Type xs string should be a UUID or OID CCR Message Specification 178 Attributes Data Objects XML Tag Medications lt DateTime gt continued Comments Req d Medication start date O lt Type gt lt Text gt Start Date lt Text gt lt Type gt Date format is yyyy mm ddThh mm ss 00 00 The ExactDateTime element is defined as xs string type Example DateTime Type lt Text gt StartDate lt Text gt lt Type gt lt ExactDateTime gt 2010 03 12T12 00 00 00 00 lt ExactDateTime gt lt DateTime gt lt DateTime gt Medication stop date Using the Date Issued field O and the Days Supply calculate the Stop Date by Date Issued Days Supply lt Type gt lt Text gt Stop Date lt Text gt lt Type gt Date format is yyyy mm ddThh mm ss 00 00 The ExactDateTime element is defined as xs string type Example lt DateTime gt lt Type gt lt Text gt StopDate lt Text gt lt Type gt lt ExactDateTime gt 2010 04 16T12 00 00 00 00 lt ExactDateTime gt lt DateTime gt lt IDs gt Not currently used NS lt Type gt Call to Multim database If NDC is found in the O medication tables set to Medicatio
183. ny care delivery setting Included in this information are patient demographics progress notes problems medications vital signs past medical history immunizations laboratory data and radiology reports The EHR automates and streamlines the clinician s workflow The EHR has the ability to generate a complete record of a clinical patient encounter as well as supporting other care related activities directly or indirectly via interface including evidence based decision support quality management and outcomes reporting Electronic Medical Record EMR Technology that meets provider needs for real time data access and evaluation in medical care In concert with clinical workstations and clinical data repository technologies the EMR provides the means for longitudinal data storage and access The result will be increased efficiency reduced cost and improved quality of care ePrescribing A prescriber s ability to electronically send an accurate error free and understandable prescription directly to a pharmacy from the point of care which is an important element in improving the quality of patient care Formulary List of preferred medications They are used as a mechanism to encourage the use of less costly drugs Formularies are updated frequently to reflect new drugs being introduced into the market current clinical information and information on drug interactions 194 Health Level Seven HL7 A data interchange transaction
184. o indicate a newline will be rejected Field Delimiters A delimiter must separate each field Even if a field contains no data it must still be delimited The delimiter for HL7 messages is defined in the MSH segment of the message as the first character following the segment identifier MSH OO See the message segment specifications later in this chapter for more detail Standard HL7 delimiters are used Field Specifications The following table describes the parameters used to define the data fields within each message segment Parameter Description Type An HL7 standard data type as defined in the HL7 2 3 Specification Length The maximum allowed length for the field Required The fields within each segment are classified based on their requirement status of Required R Optional O Conditional C or Not Supported X in the context of an inbound partner application to Care360 Labs amp Meds or outbound Care360 Labs amp Meds to partner application message Required f the corresponding segment is present the field must also be present within the segment Forinbound feeds Required indicates that the field must be present or the message will be rejected Foroutbound feeds Required indicates that the field will always be present in the message Optional The field is not required For inbound feeds Optional indicates that the field can be present The segment is accepted whether or not this field is present I
185. on The Care360 Labs amp Meds SSO and Web Services site provides the Example SSO Care360 Stage executable client application shown below for linking to Care360 Labs amp Meds via SSO in the Care360 Labs amp Meds Staging environment Once connected the Example SSO Care360 Stage application demonstrates the use of the User Summary web service for retrieving user data and the Branding options for linking to Care360 Labs amp Meds with specific product branding displayed Hi Test EMR LI Te ERC Timon Pol Leos ENR Brand None ae lattes D Tem Test Pater UD Ga EMR Launch Care360 Web Serice D Saected Ora if Dome 0 etos Bet Mar Counts New Res Frerblon Pending Approval Court CrgCeurt Known Fiescibin Pend Renewal Curt Fresaiplon Faled Fan Count New sage Co User Fa Faled Result Court ig Fas Faled Result Count This sample application can be used to help understand SSO workflow as well as to verify responses to User Summary requests It can also be used to help troubleshoot issues for example to determine whether a problem exists within a vendor application or message format as opposed to within Care360 Labs amp Meds itself Sample Source Code The Care360 Labs amp Meds SSO and Web Services site also provides code samples and supporting project files as applicable to demonstrate the working Example SSO Care360 Stage application For more information about the sample code
186. on Rx Order echo involves Care360 Labs amp Meds sending a copy of the prescription order back to the partner application so that it can store a record of the prescription order for the associated patient Benefits of Rx prescription order echo include the following Enables the partner application to store a copy of each prescription order placed through the Prescription Orders function of Care360 Labs amp Meds to the patient s chart mproves patient records management and office workflow Eliminates the need for redundant data entry Note Only approved prescriptions can be echoed This includes both new prescriptions and renewals Rx Order messages that are echoed backto the partner application are formatted in Continuity of Care Record CCR format For more information see Chapter 7 CCR Message Specification beginning on page 175 Process Walkthrough Rx Order Echo The diagram below illustrates at a high level the flow of prescription order data between Care360 Labs amp Meds anda linked partner application Following the diagram is a step by step walkthrough of the Rx order echo process illustrated in the diagram Receiving Echoed Rx Order ePrescribing Networks MedPlus Network Care360 Care360 Labs amp Meds Data Exchange Database Surescripts Copy of Rx Order Rx Orders Data Exchange Receives Third Party Rx Order Surescripts Data Exchange Rx Renewals i Data Exchange Submits Rx Order to Dat
187. on beginning on page 62 Retrieve Patient Demographics Methods Following is a brief overview of each method provided by the Retrieve Patient Demographic web service Usage details for each method are provided in the following section Retrieve Patient Demographics Method Details retrieveDemographicMessages Retrieves demographic and or billing messages in HL7 format that have been submitted by Care360 Labs amp Meds for the associated hub account and stored in the Data Exchange retrieval queue ackDemographicMessages Returns an acknowledgement ACK or negative acknowledgement NAK for the demographic and or billing messages received both of which remove the messages from the retrieval queue Also returns the number of ACK d or NAK d messages Retrieve Patient Demographics Method Details The following table provides details about each of the methods listed above Method Description retrieveDemographicMessages Summary Retrieves a batch of available ADT and or DFT messages in HL7 format that have been submitted by Care360 Labs amp Meds for the associated hub account and stored in the Data Exchange retrieval queue Up to 50 messages can be retrieved at one time Usage The RetrievalRequest object specifies the requested batch size optional as well as the message types to retrieve ADT DFT or both The requested batch size indicates the number of demographic and or billing messages to be retrieved for the tr
188. on Personnel Resource Segment The Appointment Information Personnel Resource 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 types 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 This segment is optional when submitting an SIU message to Care360 Labs amp Meds However if you do send the AIP segment the fields identified as required below must be submitted in the message Field Name Type Length Comments Req d AIP 00 Segment Type ID ST 4 Must be AIP R AIP O1 Set ID AIP SI 4 R AIP 02 Segment Action Code X AIP 03 Personnel Resource ID XCN 80 Contains the ID number and name of the person being R requested or scheduled for an appointment Identifies a specific person being requested or a specific person who has been scheduled as a resource for an appointment If the specific person is not khown but the type of resource is AIP 04 Resource Role is used to identify the type of personnel resource required or scheduled Format lt ID number ST family name ST given name ST middle initial or name
189. on of the message Valid value A29 Delete Person Information MSH 10 Message Control ID ST 20 A number or other data that uniquely identifies the R message in its transmission to the receiving system The Data Exchange verifies that this field is populated Patient Demographic HL7 Specification 93 Field Name Type Length Comments Req d MSH 11 Processing ID PT 3 The placer system s intent for the message Valid values R include P Production T Testing The Data Exchange verifies that the value in this field is P or T MSH 12 Version ID ID 8 The value for this field is 2 3 R SH 13 Sequence Number X SH 14 Continuation Pointer X SH 15 Accept X Acknowledgment Type SH 16 Application X Acknowledgment Type SH 17 Country Code X SH 18 Character Set X SH 19 Principal Language of X Message EVN Event Type Segment The Event Type EVN segment is used to communicate necessary trigger event information to receiving applications Field Name Type Length Comments Req d EVN OO Segment Type ID ST 4 Must be EVN R EVN O1 Event Type Code ID 3 The second component trigger event of MSH 09 R Message Type should be used to transmit event type code information This field contains the events corresponding to the trigger events described in this section The Data Exchange verifies that this field is populated with A29 Note This field has been retained for backward
190. on page 141 P D Patient Identification Segment on page 141 PD1 Patient Additional Demographic Segment on page 147 PV1 Patient Visit Data Segment on page 148 FT1 Financial Transaction Segment on page 152 PR1 Procedure Segment on page 155 DGli Diagnosis Segment on page 156 GT1 Guarantor Segment on page 159 INI Insurance Segment on page 162 Notes DFT PO3 message segments that are not submitted by Care360 Labs amp Meds are not included in this section for detailed specifications refer to the HL7 2 3 Specification All date timestamps are set to Coordinated Universal Time UTC MSH Message Header Segment The Message Header MSH segment defines the intent source destination and some specifics of the syntax of a message Field Name Type Length Comments Req d MSH 00 Segment Type ID ST 4 Must be MSH R MSH O1 Field Separator ST 1 The separator between the message segment ID MSH R and the first real data field MSH 02 Defines the character to be used as a separator for the rest of the message The value is a vertical bar MSH 02 Encoding Characters ST Four characters that are used in the following order R component separator repetition separator escape character and subcomponent separator Format amp These values are recommended by HL7 and are the only values supported MSH 03
191. on retrieving pulling patient demographic and or billing updates from Care360 Labs amp Meds 1 Care360 Labs amp Meds submits patient demographic and or billing messages to the Data Exchange which verifies the format and content of those messages 2 The Data Exchange records the patient demographic transaction and stores a copy of the discrete content of the demographic and or billing messages for 90 days 3 The Data Exchange converts the demographic and or billing messages to the standard HL7 ADT or DFT message format respectively and then stores the messages in a queue for retrieval 4 The partner application retrieves and acknowledges ACKs or NAKs the messages from the Data Exchange and then applies the updates to its patient database and or billing system Retrieve Patient Demographic Web Service API Reference 52 Retrieve Patient Demographic Web Service API Reference This section provides details about the Retrieve Patient Demographic web service calls provided by the Data Exchange The Retrieve Patient Demographic web service provide operations that enable a partner application to retrieve and acknowledge patient demographic and billing updates submitted by Care360 Labs amp Meds An authorized user name and password are required for accessing this web service Note For detailed specifications on the HL7 ADT and DFT messages that are retrieved from the Data Exchange see Chapter 6 Patient Demographic HL7 Specificati
192. one new number in a transaction MRG O2 Prior Alternate Patient CX 20 The prior alternate patient identifier O ID MRG O3 Prior Patient Account CX 20 The prior patient account number O Number MRG 04 Prior Patient ID CX 40 The external prior patient identifier R External Note Must not contain the same value as PID O2 MRG O5 Prior Visit Number CX 20 The prior visit number O MRG O6 Prior Alternate Visit ID CX 20 The prior alternate visit number O MRG O7 Prior Patient Name XPN 48 The prior name of the patient This field is not used to R change a patient name No more than 48 characters including the delimiter between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name lt family name ST gt lt given name ST gt middle initial or name ST gt suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID The Data Exchange verifies that the value complies with the rules above Patient Demographic HL7 Specification 111 PID Patient Identification Segment Incorrect The Patient Identification PID segment is used by all applications as the primary means of communicating patient identification information This segment is identified as Incorrect which represents the patient identification inf
193. online help can be replaced with a generic version with Quest Diagnostics references and branding removed For details see User Manual and Help Specifications on page 13 Linking to Care360 Labs amp Meds Ti Custom UI Specifications The following sections provide detailed specifications of the Care360 Labs amp Meds UI elements that can be customized for use with a partner application Logo and Image Specifications The following Care360 Labs amp Meds logos and or images can be replaced or removed Logo Image Location File Type Dimensions Pixels Care360 Labs amp Meds logo Upper left corner of application GIF 197 W x 70H Quest Diagnostics logo Left hand navigation pane of application GIF 125 W x 41H Care360 Labs amp Meds logo Upper left corner of login page GIF 302 W x 99H Color Palette Specifications The overall color scheme of the Care360 Labs amp Meds user interface including navigational buttons can be customized to reflect the partner organization or application Elements for which color can be defined include the following Text color Background colors including lighter middle and darker Button text color Button background color Colors for each option are specified using one of the following three color formats RGB composed of three number or percentage values hexadecimal a 3 or 6 digit hex value or color name standard colors defined by the World Wide Web Consortium W3C
194. onment Once you have developed tested and certified your web service client application in the Staging environment you can then update the application to work in the Production environment Connecting a web service client to the Production environment is similar to connecting to the Staging environment the exposed interfaces are equivalent Note Client applications developed against the Staging environment WSDL documents can also be used to access the Production environment and vice versa the WSDL content is identical in both environments Submit Patient Demographic Web Service API Reference 48 To access the Submit Patient Demographic web service in the Production environment access the following link WSDL Document https hubservices medplus com demographic service wsdl Endpoint https hubservices medplus com demographic service Submit Patient Demographic Web Service API Reference 49 Chapter 5 Retrieve Patient Demographic Web Service API Reference In This Chapter About the Retrieve Patient Demographic Web Service eee ene teen nee bbe ene nas 51 Retrieve Patient Demographic Web Service API Reference cece teen n 53 Retrieve Patient Demographic Web Service XML Schema aaa aan eee s 57 gt Appt the VV a ce DOCUMEN AA AN EA A a EA AA AA A a 60 50 About the Retrieve Patient Demographic Web Service Patient demographics integration enables patient demographic an
195. ore than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name A A family name ST gt given name ST gt middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID The Data Exchange verifies that the field length complies with the rules above Patient Demographic HL7 Specification 106 Field Name Type PID 06 Mother s Maiden Name Length Comments Req d PID O7 Date Time of Birth TS 26 Patient DOB in the following format R Inbound yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats Outbound yyyymmdd PID 08 Sex IS Possible values are listed below R M Male F Female O Other U Unknown A Ambiguous N Not applicable Z Undifferentiated blank Note If Care360 Labs amp Meds does not support a value that is submitted on inbound feeds that value appears as a blank in the user interface PID 09 Patient Alias XPN 48 Patient alias name Only the first five subfields Family O Name Given Name Middle Name or Initial Suff
196. ormation that will be replaced as the result of a patient merge This segment contains permanent patient identifying and demographic information that for the most part is not likely to change frequently Note This segment is used on inbound transactions only Field Name Type Length Comments Req d PID OO Segment Type ID ST 4 Must be PID R PID O1 Set ID SI 4 Allows identification of multiple PID segments withina R message Usually a sequential number beginning with 1 Must be set to 2 to identify incorrect person information The Data Exchange verifies that the value complies with the rules above PID O2 Patient ID CX 40 Care360 patient identifier used to uniquely identify a R patient within Care360 The Data Exchange verifies that this field is populated Example BB1123 PID 03 Patient ID X PID O4 Alternate Patient ID X PID PID O5 Patient Name XPN 48 No more than 48 characters including the delimiter R between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name A A family name ST gt lt given name ST gt middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID The Data Exchange verifies that the field length complies with the rules above PID 06 Mother s
197. oses only and it may need to be modified to work in your environment It is provided as is without warranty of any kind or support from Quest Diagnostics About This Manual vii What s New in This Release Care360 Linking and Single Sign On SSO provides no feature updates or enhancements for the 14 2 release About This Manual viii Documentation Conventions This manual uses the following conventions Manual titles special terms webpage and dialog box titles menu items toolbar button names labels that appear on webpages and dialog boxes and keyboard key names appear in italic Italic is also used to indicate variables For example an email address might be presented as name company com When typing the address you would use the actual user name and company name rather than name and company Words that are being emphasized appear in bold Text that you type as well as messages and prompts that appear on the screen appearinthis type style The greater than symbol gt indicates a series of menu items to click For example the instructions to click the File menu item and then click Open might be presented in the following way Click File gt Open This manual calls your attention to important information in several ways Note A note indicates exceptions to the stated rule or information that emphasizes or supplements important points in the main text A note can supply information that might apply only in s
198. ould be used to transmit event type code information This field contains the events corresponding to the trigger events described in this section Valid values A28 Add Person Information A31 Update Person Information Note This field has been retained for backward compatibility only EVN O2 Recorded Date Time X Patient Demographic HL7 Specification 68 Field Name Type Length Comments Req d EVN 03 Date Time Planned X Event EVN 04 Event Reason Code X EVN O5 Operator ID X EVN 06 Event Occurred X PID Patient Identification Segment The Patient Identification 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 Field Name Type Length Comments Req d PID OO Segment Type ID ST 4 Must be PID R PID O1 Set ID SI 4 Only one PID segment per message is allowed so a valid O value would be 1 indicating one segment PID 02 Patient ID CX 40 Care360 patient identifier PID used to uniquely identify a R patient within Care360 The PID O2 value appears in the Care360 Labs amp Meds patient chart and several other places and can be used to search for patients After submitting an add or update it can be verified on the Demography tab Administrative Details section Example BB1123 PID 03 Patient
199. oundPatientDemographicRequest object contains the inbound patient demographic update Notes Even if an inbound patient demographic update is accepted by the Data Exchange it still may ultimately be rejected by Care360 Labs amp Meds For detailed specifications on formatting patient demographic update messages that are sent to the Data Exchange for processing see Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Method Signature DemographicResponse submitBatchADTMessage DemographicRequest request throws SOAPException Submit Patient Demographic Web Service API Reference 46 Submit Patient Demographics Objects The Submit Patient Demographic web service provides the objects described in the following table Note The attributes defined in this table are case sensitive Object DemographicRequest Description Attributes Contains the inbound patient demographic update Note For detailed specifications on formatting patient demographic updates that are sent to the Data Exchange for processing see Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Attributes that can be set for this object include ADTMessage The HL7 ADT and or SIU Patient Demographic update message content Data Type byte 1 Req d DemographicResponse Represents the response elements for a demographic update request This includes the transaction ID and any validation errors
200. out SSO see About Single Sign On SSO on page 4 A partner application that is linked to Care360 Labs amp Meds can also take advantage of a number of related services including the following Care360 Labs amp Meds UI customization For more information see Customizing the Care360 Labs amp Meds User Interface on page 11 Lab order echo For more information see About Lab Order Echo on page 17 Rxorder echo For more information see About Rx Order Echo on page 18 User summary services For more information see Chapter 3 User Summary Web Service API Reference beginning on page 31 Patient demographic scheduling and or billing services For more information see Chapter 4 Submit Patient Demographic Web Service API Reference beginning on page 38 and Chapter 5 Retrieve Patient Demographic Web Service API Reference beginning on page 50 Note A partner application must allow users to view Care360 Labs amp Meds in its native resolution 1024x768 displaying all existing menus headers and other navigation elements In most cases Care360 Labs amp Meds will appear in a new browser window otherwise the partner application must display in a higher resolution so that Care360 Labs amp Meds can appear in a separate frame within the application Care360 Labs amp Meds Functions Available for Linking A partner application can link directly to the following Care360 Labs amp Meds functions also referre
201. owing User summary services The ability to view Care360 Labs amp Meds lab result and user message counts from within the linked application Care360 Labs amp Meds user interface UI customization The ability to customize certain elements of the Care360 Labs amp Meds user interface to more closely resemble partner applications or product branding Order echo The ability to receive copies of lab orders and Rx orders placed using Care360 Labs amp Meds within the linked application Patient demographic updates The ability for the linked application to synchronize patient demographic scheduling and or billing data with Care360 Labs amp Meds patient database via Care360 Data Exchange The linked application can submit patient add update merge delete and or schedule updates to Care360 Labs amp Meds It also has the option to either receive via push or retrieve via pull patient demographic and or billing updates that have been submitted by Care360 Labs amp Meds Disclaimers This Programmer Reference provides specifications necessary for exchanging laboratory data between a third party Service Provider laboratory or EMR application and the various components of Care360 Data Exchange It does not however provide documentation on creating or updating an application to produce data files that conform to these specifications All sample code referenced in this Programmer Reference is provided for example purp
202. pecial cases Caution A caution indicates that failure to take or avoid a specified action could result in losing data When you see a caution follow the instructions carefully This manual may contain cross references to external documentation to which you may not currently have access Please contact Quest Diagnostics to obtain a copy of any additional product documentation that you require When viewing this manual using Adobe Reader we recommend that you do the following to ensure optimal display 1 Click Edit gt Preferences The Preferences dialog box appears In the Categories list click Page Display In the Rendering area clear the Enhance thin lines check box You may also want to clear the Use 2D graphics acceleration check box based on capabilities of your graphics card 4 Click OK Note The preceding steps are specific to Adobe Reader X the procedure may vary based on the version you are using About This Manual ix Abbreviations and Acronyms The following is a list of abbreviations and acronyms that are used in this manual Abbreviation Acronym Description ADT Admission Discharge Transfer AMA American Medical Association API Application Programming Interface CCR Continuity of Care Record CMS Centers for Medicare and Medicaid Services CPT Current Procedural Terminology CRNA Certified Registered Nurse Anesthetists DFT HL7 Detail Fi
203. phic HL7 Specification 140 EVN Event Type Segment The Event Type EVN segment is used to communicate necessary trigger event information to receiving applications Field Name Type Length Comments Req d EVN OO Segment Type ID ST 4 Must be EVN R EVN 01 Event Type Code ID 3 Note This field has been retained for backward R compatibility only The second component trigger event of MSH 09 Message Type will be used to transmit event type code information Will be set to PO3 EVN 02 Recorded Date Time X EVN 03 Date Time Planned X Event EVN 04 Event Reason Code X EVN 05 Operator ID X EVN 06 Event Occurred X PID Patient Identification Segment The Patient Identification 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 Field Name Type Length Comments Req d PID OO Segment Type ID ST 4 Must be PID R PID O1 Set ID SI 4 Will be set to 1 O PID O2 Patient ID CX 40 Care360 patient identifier used to uniquely identify a R patient within Care360 When the patient is from another institution outside office etc the identifier used by that institution can be shown in this field This may be a number that multiple disparate corporations or facilities share Example BB1123 PID 03 Patient ID CX 40 The
204. phicDemo DemographicDemoOrg 20061211153336 A31 msgControlID123 P 2 3 EVN A31 199608190820 PID 1 pid123 LH PATIENT LASTNAME PATIENT FIRSTNAME M 20000101153336 U ALIAS LASTNAME ALIAS FIRSTNAME 2056 0 2056 0 4690 Parkway Dr Mason OH 45040 USA cP se6 999 9999999 99999 513 9999999 ENG text Census EGL alttext Census2 M 1 FOUND 444669999 2148 5 text Census 2149 3 alttext Census NK1 1 LASTNAME FIRSTNAME II Mrs Ba Sister Main St Austin TX 78704 USA 235 1320440 65 204 5551212 AGENT PV1 1 O GT1 1 GUARANTOR LASTNAME GUARANTOR FIRSTNAME M JR DR MD 1234 Emery Road Cincinnati OH 45010 1 513 8888888 1234 1 238 4444444 5678 19960708000000 M 1 8 444556666 ABC Inc EFG M 1234 Main Dr oxford OH 45068 IN1 1 INSID123 Insurance Plan ABC INSCOID123 insuranceco 1000 Insurance Rd Detroit MI 45777 113433 name L LL E EL HELLE LE ELE ELE LE ELE ELE EL EL E FL IT Patient Demographic HL7 Specification 166 Sample 4 Merge Patient MSH N amp SecondSub DemographicDemo DemographicDemoOrg 20061211153336 A39 A39M P 2 3 EVN A39 199608190820 PID 1 ABC NEWMRN 2 PATIENT LASTNAME PATIENT FIRSTNAME Dr 20000101 F 4690 Parkway Dr Mason 0H 45040 1 226 1111111 2222 1 222 5555555 6666 287 87 8787 MRG pideee6 PRIOR LASTNAME PRIOR FIRSTNAME L PID 2 19681121 M 1234 Emery Rd Mason oH 45040 999 99 9999 Sample 5
205. populates the language field in Care360 Labs amp Meds only if the field is empty or if it contains an invalid value If the language field is already populated with a valid value it is never updated The language value appears on the Demography tab Ethnicity Race Language section PID 16 Marital Status IS 1 Values supported by Care360 Labs amp Meds O P Polygamous W Widowed D Divorced M Married A Annulled Sc Never Married L Legally Separated Interlocutory T Domestic Partner The patient s marital status appears on the Demography tab gt Patient Information section PID 17 Religion IS 3 Patient religion O PID 18 Patient Account CX 20 Contains the patient account number assigned by O Number accounting and to which all charges payments etc are recorded It is used to identify the patient s account Only the first subfield ID Number is passed to from Care360 Labs amp Meds PID 19 SSN Number ST 16 Must contain 9 numeric digits or 11 with hyphens Cannot O Patient be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above The patient s SSN appears on the Demography tab gt Patient Information section Patient Demographic HL7 Specification 73 Field Name Type Length Comments Req d PID 20 Driver s Lic Num DLN 25 DLN format O Patient lt license number ST gt
206. protocol for healthcare technology applications that simplifies the ability of different vendor supplied IS systems to assure inter operability Although not a software program in itself HL7 requires that each healthcare software vendor program supports HL7 interfaces for its products Healthcare Provider Directory HPD An electronic listing of individual and organizational healthcare providers that are classified by provider type specialties credentials relationships demographics and service locations The standards for the Healthcare Provider Directory were developed by Integrating the Healthcare Enterprise IHE Hospital Information System HIS The common term for the computer hardware and software that provides the support of the hospital Hub Account A unique account that enables an authorized external system for example EMR vendor to interact with the Data Exchange Interface The code written and the specifications and protocols used for the transmission of electronic data between the Data Exchange and the participants and or vendors computing environments Logical Observation Identifiers Names and Codes LOINC An industry database that is used to facilitate the exchange of pooling results for clinical care outcomes management and research LOINC codes are universal identifiers for laboratory and other clinical observations Master Files Files containing a current collection of all reference data needed to create
207. quence must be blank The accepted length for each phone number is 20 numeric characters No dashes or other separating characters are allowed Example with home and cell phone extension and country code omitted and email 333 4445555 NET exampleGemail com CP 7 77 8889999 Example with home and cell phone including country code 1 333 4445555 Cp 1 777 8889999 The Data Exchange verifies that the value complies with the rules above The home number mobile number and email address appear on the Demography tab gt Contact Information section PID 14 Phone Number XTN 40 Accepted length of this field is 20 numeric characters No O Business dashes or other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 The Data Exchange verifies that the value complies with the rules above Only the first phone number is passed to Care360 Labs amp Meds any other fields are ignored The work number appears on the Demography tab Contact Information section Patient Demographic HL7 Specification 72 Field Name Type PID 15 Language Patient CE Length Comments Req d 250 Values supported by Care360 Labs amp Meds are listed in O Patient Language PID 15 on page 168 This field uses the HL7 3 0 field length of 250 rather than the HL7 2 3 field length of 60 Note This value
208. r accessing the User Summary web service is referred to as a static web service client because the client knows where the web service is located without looking up the service ina UDDI registry The client calls the web service via a known service URL to obtain the Web Services Definition Language WSDL file that describes the web service A WSDL interface document describes all of the information that is needed by a web service client to interact with the associated web service The WSDL document includes the URL to locate the associated web service Once you have located the web service or after you have obtained the WSDL you can build a web service client application that uses the web service to perform the desired functions The following section describes how to obtain the WSDL document for the User Summary web service Note You must have a valid user name and password issued by Quest Diagnostics in order to access the WSDL interface document For the Care360 Labs amp Meds Production environment a user name and password will be issued once your application has been developed tested and certified Accessing the User Summary Web Service WSDL Document To access the WSDL service descriptions for the User Summary web service use your browser to access the URL corresponding to one of the following environments Staging environment Use this environment to develop test and certify your web service application For the Staging environ
209. r the new bill will contain the open appointment ID f another appointment is made so that there are two open appointment IDs select the appointment ID to use Req d O PV1 20 Financial Class PV1 21 Charge Price Indicator PV1 22 Courtesy Code Patient Demographic HL7 Specification 150 Field Name Type Length Comments Req d PV1 23 Credit Rating X PV1 24 Contract Code X PV1 25 Contract Effective Date X PV1 26 Contract Amount X PV1 27 Contract Period X PV1 28 Interest Code X PV1 29 Transfer to Bad Debt X Code PV1 30 Transfer to Bad Debt X Date PV1 31 Bad Debt Agency Code X PV1 32 Bad Debt Transfer X Amount PV1 33 Bad Debt Recovery X Amount PV1 34 Delete Account X Indicator PV1 35 Delete Account Date X PV1 36 Discharge Disposition X PV1 37 Discharged to Location X PV1 38 Diet Type X PV1 39 Servicing Facility X PV1 40 Bed Status X PV1 41 Account Status X PV1 42 Pending Location X PV1 43 Prior Temporary X Location PV1 44 Admit Date Time X PV1 45 Discharge Date Time X PV1 46 Current Patient Balance X PV1 47 Total Charges X Patient Demographic HL7 Specification 151 Field Name Type Length Comments Req d PV1 48 Total Adjustments X PV1 49 Total Payments X PV1 50 Alternate Visit ID X PV1 51 Visit Indicator X PV1 52 Other Healthcare X Provider FT1 Financial Transaction Segment The FT1 segment contains th
210. raphic HL7 Specification 87 Field Name Type Length Comments Req d GT1 41 Religion X GT1 42 Mother s Maiden X Name GT1 43 Nationality X GT1 44 Ethnic Group X GT1 45 Contact Person s X Name GT1 46 Contact Person s X Telephone Number GT1 47 Contact Reason X GT1 48 Contact Relationship X GT1 49 Job Title X GT1 50 Job Code Class X GT1 51 Guarantor X Employer s Organ Name GT1 52 Handicap X GT1 53 Job Status X GT1 54 Guarantor Financial X Class GT1 55 Guarantor Race X IN1 Insurance Segment The Insurance INT segment contains insurance policy coverage information necessary to produce properly pro rated and patient and insurance bills This segment is applicable only for insurance billing Field Name Type Length Comments Req d IN1 00 Segment Type ID ST 4 Must be INT R IN1 01 Set ID SI 4 INI message segments should be numbered sequentially R from 1 IN1 02 Insurance Plan ID CE 50 In outbound messages this field is populated with UNK for R unknown when the insurance plan ID is not available in Care360 Labs amp Meds In inbound messages the Data Exchange verifies that the field is populated Patient Demographic HL7 Specification 88 Field Name Type Length Comments Req d IN1 03 Insurance Company CX 59 QDI Bill mnemonic C ID Note Required only if IN1 47 T Third Party Bill Th
211. raphicMessages AckRequest acks throws SOAP exception Retrieve Patient Demographic Web Service API Reference 54 Retrieve Patient Demographics Objects The Retrieve Patient Demographic web service provides the objects described in the following table Note The attributes defined in this table are case sensitive Object Description Attributes RetrievalRequest Sets parameters to confine the retrieve transaction Note For detailed specifications on the ADT and DFT messages that are retrieved from the Data Exchange see Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Attributes that can be set for this object include RequestedBatchSize The number of demographic and or billing messages to be retrieved for the transaction the maximum number allowed is 50 If the batch size is not specified or if the specified number is not from 1 to 50 then it defaults to 50 RequestType The type s of messages to retrieve Valid values ADT and or DFT If no value is specified both message types are retrieved Data Type Integer String Req d RetrievalResult Represents the response elements for a demographic retrieval request This includes the transaction ID the requested and actual batch sizes a flag indicating whether or not more messages are available in the queue and any validation errors that occur Responses include Retrievalld The transaction ID for the retrieval response used to a
212. required 1024x768 resolution can be maintained 4 The user can then access any Care360 Labs amp Meds functions that are enabled by their user credentials Accessing Care360 Labs amp Meds Directly Allowing a user direct access to Care360 Labs amp Meds is optional When a user accesses Care360 Labs amp Meds directly there is no connection established to a partner application and Care360 Labs amp Meds may appear in its default format that is with no custom UI branding The procedure for accessing Care360 Labs amp Meds directly varies depending on the partner application s configuration If the partner application s SSO credentials are configured for direct access to Care360 Labs amp Meds all of the partner application s users can log directly into Care360 Labs amp Meds using their existing Care360 Labs amp Meds user ID and password If the partner application is not configured for direct access to Care360 Labs amp Meds direct access must be requested on a per user basis The following steps outline the procedure and associated systems involved in accessing Care360 Labs amp Meds directly for partner applications that are not configured for direct access 1 Quest Diagnostics issues a user a separate password associated with either their existing Care360 Labs amp Meds user ID or a separate user ID 2 Theuserlogs in to Care360 Labs amp Meds directly with their assigned user ID and password Note The Care360 Lab
213. resh requests on a predefined basis User Summary Web Service API Reference 32 User Summary Web Service API Reference This section provides details about the User Summary web service calls provided by Care360 Labs amp Meds The User Summary component of Care360 Labs amp Meds provides operations for receiving notification of the availability of user messages new results and pending prescriptions within Care360 Labs amp Meds An authorized user name and password are required for accessing this web service User Summary Web Service Methods Following is a brief overview of each method provided by the User Summary web service Usage details for each method are provided in the following section User Summary Web Service Method Details getCounts Retrieves user summary data from Care360 Labs amp Meds for all organizations with which the current partner application user is associated up to the maximum number of organizations allowed getCountsByOrg Retrieves user summary data from Care360 Labs amp Meds for one or more specific organization s with which the current partner application user is associated getOrgs Retrieves a list of organizations with which the partner application user is associated User Summary Web Service Method Details The following table provides details about each of the methods listed above Method Description getCounts Summary Retrieves user summary data from Care360 Labs amp Meds
214. rmulary definition 194 FT1 field requirements DFT 152 155 Fuzzy matching details 41 patient demographic integration 40 G Generic order echo see Order echo getCounts method description 33 getCountsByOrg method description 33 getOrgs method description 34 198 GTI field requirements DFT 159 162 field requirements patient demographic 84 88 H Healthcare Provider Directory HPD definition 195 HL7 Health Level 7 CCR specification 176 definition 195 patient demographic message segment requirements 64 Patient Demographic specification 63 Hospital Information System HIS definition 195 Hub account definition 195 l IN1 field requirements DFT 162 165 field requirements patient demographic 88 91 Inbound feeds Patient Demographic HL7 specification 63 Initialize SSO connection 9 Insurance coverage type 165 Interface definition 195 L Lab Orders page linking to 2 3 Labs amp Meds see Care360 Labs amp Meds Language patient demographic element ADT A28 73 ADT A31 73 DFT 144 SIU 126 values for Care360 Labs amp Meds 168 174 Linking available functions 2 formatting requirements 3 overview 2 10 process walkthrough 9 Logical Observation Identifiers Names and Codes LOINC definition 195 Logo customizing 11 M Master Files definition 195 Master Patient Index MPI definition 195 Merge patient sample patient demographic message 167 Message Disposition Notification MDN definition 195 Mes
215. rs that occur within the partner application are returned to the Data Exchange Submit Patient Demographic Web Service API Reference 44 Submit Patient Demographic Web Service API Reference This section provides details about the Submit Patient Demographic web service calls provided by the Data Exchange The Submit Patient Demographic web service component of the Data Exchange provides operations for receiving and processing patient demographic updates from a partner application and forwarding those updates to Care360 Labs amp Meds Demographic updates can be submitted either in real time or batch mode An authorized user name and password are required for accessing this web service Note For detailed specifications on the HL7 demographic ADT and scheduling SIU messages that are sent to the Data Exchange for processing see Chapter 6 Patient Demographic HL7 Specification beginning on page 62 Submit Patient Demographics Methods Following is a brief overview of each method provided by the Submit Patient Demographic web service Usage details for each method are provided in the following section Submit Patient Demographics Method Details submitRealTimeADTMessage Submits a patient demographic update ADT message in HL7 format to the Data Exchange for real time delivery to Care360 Labs amp Meds submitBatchADTMessage Submits a patient demographic update ADT message in HL7 format to the Data Exchange in batch mo
216. rth order is entered in this field PID 26 Citizenship IS 4 Contains the patient s country of citizenship O Patient Demographic HL7 Specification 74 Field PID 27 Name Type Veterans Military CE Status Length 60 Comments Req d Contains the military status assigned to a veteran O Only the first subfield Identifier is passed to from Care360 Labs amp Meds PID 28 Nationality CD 80 Contains a code that identifies the nation or national O grouping to which the insured person belongs This information may be different from a person s citizenship in countries in which multiple nationalities are recognized for example Spain Basque Catalan etc Only the first subfield Identifier is passed to from Care360 Labs amp Meds PID 29 Patient Death Date amp TS Time 26 Contains the date and time at which the patient death O occurred in the following format Inbound yyyymmdd or yyyymmddhhmmss The Data Exchange accepts the timestamp hhmmss but forwards only the date yyyymmdd to Care360 Labs amp Meds The Data Exchange verifies that the date is in one of these formats Outbound yyyymmdd PID 30 Patient Death ID Indicator Indicates whether or not the patient is deceased Yes No O indicator Valid values Y Yes N NO blank The Data Exchange validates this field PD1 Patient Additional Demographic Segment The Patient Additional Demographic PD1
217. s AIG 11 Duration NM 20 O AIG 12 Duration Units CE 200 O Patient Demographic HL7 Specification 134 Field Name Type Length Comments Req d AIG 13 Allow Substitution IS 10 C Code AIG 14 Filler Status Code CE 200 C AIL Appointment Information Location Segment The Appointment Information Location 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 Note This segment is not used by Care360 Labs amp Meds Field Name Type Length Comments Req d AIL OO Segment Type ID ST 4 Must be AIL R AIL O1 Set ID AIL SI 4 R AIL 02 Segment Action Code ID 1 C AIL 03 Location ResourceID PL 80 C AIL 04 Location Type CE 200 R AIL O5 Location Group X AIL 06 Start Date Time TS 26 C AIL O7 Start Date Time Offset NM 20 c AIL 08 Start Date Time Offset CE 200 C Units AIL 09 Duration X AIL1O Duration Units X AIL 11 Allow Substitution IS 10 C Code AIL 12 Filler Status Code X Patient Demographic HL7 Specification 135 AIP Appointment Informati
218. s amp Meds password is not the same password used to initialize or maintain the SSO link from the partner application The user ID may or may not be the same as used for SSO linking The user can access any Care360 Labs amp Meds functions that are enabled by their user credentials Linking to Care360 Labs amp Meds 10 Customizing the Care360 Labs amp Meds User Interface When Care360 Labs amp Meds is linked to a partner application it is possible to customize certain elements of the Care360 Labs amp Meds user interface UI to provide a more seamless experience for users as they move between the two applications New Lab Results New Clinical Documents Action Items Failed Fax Messages Results Pending Release Messages Received Date Subject Tasks 36 Overdue Tuna pr lt Population Compliance No selected guidelines currently pertain to your active patients Note Alerts and notices are based only on clinical information currently available in Care360 and may not reflect data added within the last 24 hours 53 Practice Wide 0 Unread Add a Task The elements of the Care360 Labs amp Meds that can be customized include the following Logos and images The Care360 Labs amp Meds logo in the upper left corner as well as the Quest Diagnostics logo in the lower left corner can each be replaced with a similarly sized logo or image to reflect the branding of the partner organization or application
219. s current patient context is maintained within the selected Care360 Labs amp Meds function see Maintaining Patient Context below 3 The partner application performs user authentication in the background to Care360 Labs amp Meds Note Authentication to Care360 Labs amp Meds is managed through the Sun Java System Access Manager which utilizes the Security Assertion Markup Language SAML single sign on protocol using 128 bit encryption For details on establishing an SSO connection to Care360 Labs amp Meds see About the Care360 SSO and Web Services Site on page 14 Maintaining Patient Context A partner application can be can be configured so that when a user accesses a Care360 Labs amp Meds function via SSO the current patient context is automatically maintained between the two applications whenever possible For example if the user has already searched for a particular patient within the partner application and then wants to place a new lab order for that patient the user clicks the appropriate link and Care360 Labs amp Meds opens to the Lab Orders function with the same patient preselected There are two ways in which patient context is maintained The partner application can use the Submit Patient Demographic Services to submit ADT messages to Care360 to populate the Care360 database with patient demographic information The partner application can then pass their unique patient identifier PID to Care360 La
220. s of the Care360 Labs amp Meds support team URLs for the WSDL documents for the Staging and Production environments and a PDF version of this Programmer Reference Resources Downloads of the latest Example SSO Care360 Stage sample application and source code Download the Sample Application and Source Code 1 Access the Care360 SSO and Web Services site at the following URL http custcenter medplus com tech support portalcenter 2 If prompted type your username and password and then press Enter Linking to Care360 Labs amp Meds 14 3 Fromthe Resources area do the following To download the sample application click the Example SSO Care360 stage link When prompted click Save and then locate the desired download directory on your hard disk Todownload the sample source code click the Example SSO Care360 stage src link When prompted click Save and then locate the desired download directory on your hard disk 4 Unzip the contents of the sample application and source code files For an overview of the file contents see About the Sample Application on page 15 About the Sample Application The Care360 Labs amp Meds SSO and Web Services site provides the resources described in this section for partner application developers In addition to the information provided here additional details of each of these resources are provided in a Readme file included with each sample application Example SSO Applicati
221. sages sample CCR 188 193 patient demographic 166 167 Methods ackDemographicMessages 54 getCounts 33 getCountsByOrg 33 getOrgs 34 retrieveDemographicMessages 53 submitBatchADTMessage 46 submitRealTimeADTMessage 45 MRG field requirements patient demographic 111 MSH field requirements DFT 139 140 field requirements patient demographic ADT A28 67 68 field requirements patient demographic ADT A29 93 94 field requirements patient demographic ADT A31 67 68 field requirements patient demographic ADT A39 104 105 field requirements patient demographic SIU 117 118 N National Drug Code NDC definition 195 New Results page linking to 2 NKI field requirements patient demographic ADT A28 77 79 Not supported definition 64 Oo Objects AckRequest 56 AckRequestltem 56 AckResult 56 DemographicRequest 47 DemographicResponse 47 RetrievalRequest 55 RetrievalResultltem 56 WSOrg 35 WSOrgData 35 WSUserSummaryCounts 34 WSUserSummaryData 34 Optional definition 64 Order Echo availability with Care360 Labs amp Meds 2 definition vii overview 17 process walkthrough 17 18 Orders Prescription 176 Prescription Order CCR specification 176 Organizational trust establishing for SSO 22 Outbound feeds Patient Demographic HL7 specification 63 Overviews Care360 Labs amp Meds UI customization 11 Care360 SSO and Web Services site 14 Linking and SSO 2 10 Order Echo 17 Patient Demographic HL7 specification 63 Prescription Order CCR
222. sample 15 Code sample for SSO 16 Conditional definition 64 Connectivity patient demographics 39 Contact Customer support 14 Copyright text customizing 11 Coverage type insurance 165 Customer Center overview 14 Customer support contact 14 Customization Care360 Labs amp Meds UI 11 D Delete patient sample patient demographic message 166 DemographicRequest object description 47 DemographicResponse object description 47 Demographics see Patient demographic integration Detail Financial Transaction DFT definition 194 message specifications 138 165 DFT message segment requirements DG1 fields 156 158 EVN fields 141 FT1 fields 152 155 GTI fields 159 162 IN1 fields 162 165 MSH fields 139 140 PD1 fields 147 148 PID fields 141 147 PR1 fields 155 156 PV1 fields 148 152 DG1 field requirements DFT 156 158 field requirements patient demographic 82 83 131 133 Diagnosis code 157 type 157 Diagnosis classification 158 Documentation conventions ix related xii Download sample EMR application 14 E Electronic Health Record EHR definition 194 Electronic Medical Record EMR definition 194 EMR sample application downloading 14 sample application overview 15 ePrescribing definition 194 Ethnic group patient demographic element ADT A28 74 ADT A31 74 DFT 146 SIU 128 EVN field requirements patient demographic ADT A28 68 ADT A29 94 ADT A31 68 ADT A39 105 DFT 141 F Formatting requirements linking 3 Fo
223. segment contains demographic information that is likely to change about the patient Field Name Type Length Comments Req d PD1 00 Segment Type ID ST 4 Must be PD1 R PD1 01 Living Dependency IS 2 O PD1 02 Living Arrangement IS 2 O PD1 03 Patient Primary XON 90 O Facility PD1 04 Patient Primary Care XON 90 O Provider Name amp ID No Patient Demographic HL7 Specification 75 Field Name Type Length Comments Req d PD1 05 Student Indicator IS 2 O PD1 06 Handicap IS 2 O PD1 07 Living Will IS 2 O PD1 08 Organ Donor IS 2 O PD1 09 Separate Bill ID 2 O PD110 Duplicate Patient CX 2 O PD1 11 Publicity Indicator CE 1 Represents the value for Consent given to share clinical O documentation in Demography tab gt Administrative Details section A A Format identifier ST gt lt text ST gt lt name of coding system ST gt lt alternate identifier ST gt lt alternate text ST gt name of alternate coding system ST gt Inbound valid values for PD1 11 01 Y Yes which overrides the existing setting in Care360 Labs amp Meds N No which overrides the existing setting in Care360 Labs amp Meds blank which retains the existing setting in Care360 Labs amp Meds Note Data Exchange will not edit to ensure valid values Outbound valid values Y Yes N No P Pending blank Patient Demographic HL7 Specification 76 Field PD1 12 Name Protection
224. ses tab DG1 05 Diagnosis TS 26 Date Time that the diagnosis was determined O Date Time Format yyyymmddhhmmss This value appears on the External Diagnoses tab DG1 06 Diagnosis Type IS 2 Valid values R A Admitting W Working F Final This value appears on the External Diagnoses tab DG1 07 Major Diagnostic CE 60 O Category DG1 08 Diagnostic Related CE 60 O Group DG1 09 DRG Approval ID 2 O Indicator DG1 10 DRG Grouper Review S 2 O Code DG1 11 Outlier Type CE 60 O DG1 12 Outlier Days NM 3 O Patient Demographic HL7 Specification 82 Field Name Type Length Comments Req d DG1 13 Outlier Cost CP 12 O DG114 Grouper Version and ST 4 O Type DG1 15 Diagnosis Priority NM 2 O DG1 16 Diagnosing Clinician XCN 60 This value appears on the External Diagnoses tab O DG117 Diagnosis IS 3 Valid values O Classification amp C Consultation D Diagnosis M5 Medication antibiotic O Other R Radiological scheduling not using ICDA codes S Sign and symptom T Tissue diagnosis Invasive procedure not classified elsewhere I V catheter etc This value appears on the External Diagnoses tab DG1 18 Confidential ID 1 Valid values for this field include O Indicator EE N No This value appears on the External Diagnoses tab DG1 19 Attestation TS 26 O Date Time Patient Demographic HL7 Specification 83 GT1 Guarantor Segment The Guarantor GT1 s
225. ssage Usually a sequential number beginning with 1 PID O2 Patient ID CX 40 Care360 patient identifier used to uniquely identify a R patient within Care360 When the patient is from another institution outside office etc the identifier used by that institution can be shown in this field This may be a number that multiple disparate corporations or facilities share Example BB1123 Patient Demographic HL7 Specification 123 Field PID 03 Name Type Patient ID CX Length Comments 40 The primary identifier or other identifiers used by the facility to identify a patient uniquely for example medical record number billing number birth registry etc This is the patient identifier associated with the non Care360 system and it is not always available within Care360 Req d O PID 04 Alternate Patient ID PID PID 05 Patient Name XPN 48 No more than 48 characters including the delimiter between the last and first names At least one character for first and last name Alphanumeric data only but a numeric value cannot be used as the first character of the last name family name ST gt middle initial or name ST suffix for example JR or III ST prefix for example DR ST degree for example MD ST name type code ID given name ST The Data Exchange verifies that the field length complies with the rules above PID 06
226. ssage Specification on page 177 lt xml version 1 0 encoding UTF 8 standalone yes gt ContinuityOfCareRecord xmlns urn astm org CCR gt lt CCRDocumentObj ect ID gt 0c3299627 0001010450792695a0 fd38 lt CCRDocumentObjectID gt lt Language gt lt Text gt English lt Text gt lt Language gt Version 1 0 Version DateTime lt ExactDateTime gt 2010 05 04T10 16 314 00 00 lt ExactDateTime gt lt DateTime gt lt Patient gt ActorID20c3299677 00010104507926bfbda468 ActorID Patient From lt ActorLink gt lt ActorID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt ActorLink gt lt From gt lt Body gt lt Medications gt lt Medication gt lt CCRDataObjectID gt 0c329ae17 00010104507926a3 3Dbb06 lt CCRDataObjectID gt lt DateTime gt lt Type gt lt Text gt Start Date lt Text gt lt Type gt lt ExactDateTime gt 2010 03 12T12 00 00 00 00 lt ExactDateTime gt lt DateTime gt lt DateTime gt lt Type gt lt Text gt Stop Date lt Text gt lt Type gt lt ExactDateTime gt 2010 04 16T12 00 00 00 00 lt ExactDateTime gt lt DateTime gt lt Type gt lt Text gt Medication lt Text gt lt Type gt lt Status gt lt Text gt Active lt Text gt lt Status gt lt Source gt lt Actor gt lt ActorID gt 0c329aef7 0001010450792624f1f5cd lt ActorID gt lt ActorRole gt lt T
227. t Text gt Primary Care Provider lt Text gt lt ActorRole gt CCR Message Specification 190 lt Actor gt lt Source gt lt Actor gt lt Actor gt lt ActorObj ect ID gt 0 c329b267 00010104507926758 725e lt ActorObjectID gt lt Organization gt lt Name gt Medicis Pharmaceutical Corporation lt Name gt lt Organization gt lt Source gt lt Actor gt ActorID Care360 ActorID lt ActorRole gt lt Text gt Medical Information System lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt Actor gt lt Actor gt ActorObjectID 0c329bc87 00010104507926c6a17d0e ActorObjectID Person Name lt CurrentName gt lt Given gt FirstName lt Given gt lt Family gt LastName lt Family gt lt CurrentName gt lt Name gt DateOfBirth lt ExactDateTime gt 1951 06 18 lt ExactDateTime gt DateOfBirth Gender lt Text gt Female lt Text gt lt Gender gt lt Person gt lt IDs gt lt Type gt lt Text gt 2U lt Text gt lt Type gt lt ID gt B000000 111111110 002 lt ID gt lt Source gt lt Actor gt lt Actor1ID gt 0c32996a7 00010104507926d8e440fc lt ActorID gt lt ActorRole gt lt Text gt Primary Care Provider lt Text gt lt ActorRole gt lt Actor gt lt Source gt lt IDs gt lt IDs gt lt Type gt lt Text gt Social Security Number lt Text gt lt Type gt lt ID gt 123456789 lt ID gt lt Source gt lt Actor gt lt ActorID gt 0
228. t specifications for patient demographic add delete update and merge requests that are submitted by a partner application to Care360 Labs amp Meds and vice versa This exchange of messages allows Care360 Labs amp Meds and the partner application to synchronize their patient databases In addition this chapter provides detailed format specifications for scheduling messages which are sent from a partner application to Care360 Labs amp Meds and for financial transaction billing messages which are sent from Care360 Labs amp Meds to a partner application All of the demographic messages submitted to Care360 Labs amp Meds must adhere to the HL7 2 3 Specification with any exceptions noted in this chapter for example there are three PID fields that support HL7 3 0 values Likewise Care360 Labs amp Meds adheres to this same specification when submitting messages to partner applications The following table shows which patient demographic messages are supported for inbound partner application to Care360 Labs amp Meds and outbound Care360 Labs amp Meds to partner application or other entity such as state or federal registry for immunization reports feeds HL7 Message Inbound Outbound A28 ADT A28 Patient Add Yes Yes A29 ADT A29 Patient Delete Yes Yes A31 ADT A31 Patient Update Yes Yes A39 ADT A39 Patient Merge Yes Yes SIU SIU Patient Schedule 12 New Appt S14 Modify Appt Yes No S15 Cancel Appt
229. ta getOrgs throws SOAPException User Summary Web Service Objects The User Summary web service provides the objects described in the following table Note The attributes defined in this table are case sensitive Object Description Attributes Data Type Req d WSUserSummaryData Contains the user summary data returned from Care360 Labs amp Meds Responses include counts An array of WSUserSummaryCounts WSUserSummaryCounts O objects one for each organization timeStamp The date and time at which the query DateTime O was run warnMesage A message indicating an error String O condition for example the maximum number of organizations was exceeded WSUserSummaryCounts Contains the individual data counts returned within the WSUserSummaryData object Responses include newResultCount The number of new results for Int O the organization finalAbnormalResultCount The number of final Int O abnormal results for the organization finalNormalResultCount The number of final Int O normal results for the organization ipAbnormalResultCount The number of Int O abnormal results that are not yet final for the organization User Summary Web Service API Reference 34 Object Description Attributes Data Type Req d WSUserSummaryCounts ipNormalResultCount The number of normal Int O continued results that are not final for the organization userFailedFaxCount The number of faxes that Int
230. tains the current patient location This can be the O Location location of the patient when the charge item was ordered or when the charged service was rendered FT1 17 Fee Schedule X FT118 Patient Type X FT1 19 Diagnosis Code Contains the primary diagnosis code for billing purposes O and is the most current diagnosis code that has been assigned to the patient This is a repeating field that contains all of the diagnosis codes for the procedure code specified in FT1 25 Procedure Code ICD9 CM is assumed for all diagnosis codes but CD10 can also be used Format lt identifier ST text ST name of coding system ST alternate identifier ST alternate text ST name of alternate coding System ST gt Subfields sent by Care360 Labs amp Meds FT119 01 Diagnosis code FT119 02 Diagnosis text FT119 03 Coding system I9 Patient Demographic HL7 Specification 153 Field FT1 20 Name Type Length Comments Req d Performed By Code XCN 120 Contains the composite number name of the O person group that performed the test procedure transaction etc Multiple names and identifiers for the same practitioner may be sent in this field not multiple practitioners The legal name is assumed to be in the first repetition When the legal name is not sent a repeat delimiter must be sent first for the first repetition Format lt ID number ST family name ST given name ST middle ini
231. tal status will not appear in the Care360 Labs amp Meds user interface PID 17 PID 18 Religion Patient Account Number CX 20 Patient religion O Contains the patient account number assigned by O accounting and to which all charges payments etc are recorded It is used to identify the patient s account Only the first subfield ID Number is passed to Care360 Labs amp Meds PID 19 PID 20 SSN Number Patient Driver s Lic Num Patient DLN 25 Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above DLN format O lt license number ST gt lt issuing state province country IS expiration date DT gt Only the first subfield License Number is passed to Care360 Labs amp Meds PID 21 Mother s Identifier CX 20 Used for example as a link field for newborns Typically a O patient ID or account number may be used This field can contain multiple identifiers for the same mother Only the first subfield ID Number is passed to Care360 Labs amp Meds Patient Demographic HL7 Specification 127 Field Name Type Length Comments Req d PID 22 Ethnic Group CE 250 This field supports both HL7 2 3 and HL7 3 0 values O For HL7 2 3 values supported by Care360 Labs amp Meds are listed
232. tandards iso639 2 php code_list php Send the ISO 639 2 code not the full name for the language For example for Japanese you would send jpn ISO 639 2 Code English Name ISO 639 2 Code English Name eng English urd Urdu spa Spanish vie Vietnamese ara Arabic abk Abkhazian chi Chinese ace Achinese fre French ach Acoli cpf French Creole ada Adangme ger German ady Adygei gre Greek aar Afar hin Hindi afr Afrikaans ita Italian ain Ainu jpn Japanese aka Akan kor Korean alb Albanian per Persian gsw Alemannic pol Polish ale Aleut por Portuguese amh Amharic rus Russian anp Angika sgn Sign Language arg Aragonese tgl Tagalog arp Arapaho Patient Demographic HL7 Specification 168 ISO 639 2 Code English Name ISO 639 2 Code English Name arw Arawak bua Buriat arm Armenian bur Burmese rup Aromanian cad Caddo asm Assamese cat Catalan ava Avaric ceb Cebuano awa Awadhi khm Central Khmer aym Aymara cha Chamorro aze Azerbaijani che Chechen ast Bable chr Cherokee ban Balinese chy Cheyenne bal Baluchi nya Chichewa bam Bambara chn Chinook jargon bas Basa cho Choctaw bak Bashkir chk Chuukese baq Basque chv Chuvash bej Beja rar Cook Islands Maori bel Belarusian cop Coptic bem Bemba
233. tax of a message The Data Exchange translates the Rx Order Echo message into the standard CCR Prescription message format For more information see CCR Message Specification on page 177 Sample CCR message The prescription order message is Echoed back to the Partner Application EMRs in CCR format For more information see Sample CCR Message on page 188 CCR Message Specification 176 CCR Message Specification The CCR Message Specification defines the intent source destination and some specifics of the syntax of a message The Data Exchange translates the Rx Order Echo message into the standard CCR Prescription message format Note The following table provides a partial list of the fields that are in the XSD In general if the field is in the XSD but not listed in the table below that field is not used in Rx order echo message translation Attributes Data Objects XML Tag Comments Req d CCR Header Care360 Labs amp Meds will now only send one header at atime but the CCR can support multiple headers no limit CCR Unique lt CCRDocumentObjectID gt Must be a unique Object ID to identify this specific R Identifier instance of a CCR Type xs string should be a UUID or OID Language Language Set to English with type of xs string R Version Version Set to 1 0 version of the CCR Implementation Guide R used as reference to develop this scope The Version element is defined as a xs string type CC
234. thnicity code set http phinvads cdc gov vads ViewCodeSystemConcep t action oid 2 16 840 1 113883 6 238 amp code 2133 7 with a Concept Status Date of 09 26 2008 For example for Mexican American you would send 2149 3 PID 23 Birth Place ST 60 Indicates the location of the patient s birth O PID 24 Multiple Birth Indicator ID O Indicates whether or not the patient was part of a multiple birth Yes No indicator Valid values Y Yes N No blank This field is validated PID 25 Birth Order NM When a patient was part of a multiple birth a number O indicating the patient s birth order is entered in this field PID 26 Citizenship Contains the patient s country of citizenship O PID 27 Veterans Military Status CE 60 Contains the military status assigned to a veteran O Only the first subfield Identifier is passed to from Care360 Labs amp Meds PID 28 Nationality CD 80 Contains a code that identifies the nation or national O grouping to which the insured person belongs This information may be different from a person s citizenship in countries in which multiple nationalities are recognized for example Spain Basque Catalan etc Only the first subfield Identifier is passed to from Care360 Labs amp Meds Patient Demographic HL7 Specification 99 Field Name Type Length Comments Req d PID 29 Patient Death Date amp TS
235. tial or name ST suffix e g JR or III ST prefix e g DR ST degree e g MD ST source table IS assigning authority HD name type ID identifier check digit ST code identifying the check digit scheme employed ID identifier type code IS assigning facility ID HD FT1 21 Ordered By Code XCN 120 Contains the composite number name of the O person group that ordered the test procedure transaction etc Multiple names and identifiers for the same practitioner may be sent in this field not multiple practitioners The legal name is assumed to be in the first repetition When the legal name is not sent a repeat delimiter must be sent first for the first repetition Unit Cost FT1 23 Filler Order Number X FT1 24 Entered By Code X Procedure Code CE 80 Contains a unique identifier assigned to the procedure if O any associated with the charge This field is a CEdatatype for compatibility with clinical and ancillary systems Format lt identifier ST text ST name of coding system ST alternate identifier ST alternate text ST name of alternate coding system ST gt Subfields sent by Care360 Labs amp Meds FT1 25 01 PC Procedure Code FT1 25 02 PC description FT1 25 03 PC coding system CPT or HCPCS Patient Demographic HL7 Specification 154 Field
236. tity gt CCR Message Specification 181 Attributes Data Objects XML Tag Medications lt Directions gt continued DoseIndicator Comments The directions given by the physician on the order The directions from Care360 Labs amp Meds are placed in their entirety in the Dose XML tag The Frequency XML tag is not used Example Directions Direction Route lt Text gt topical lt Text gt lt Route gt lt Duration gt lt Description gt lt Text gt 35 lt Text gt lt Description gt lt Duration gt lt Direction gt lt Directions gt Not currently used Req d NS lt DeliveryMethod gt Not currently used NS lt Dose gt Contains the drug directions from Care360 Labs amp Meds DoseCalculation Not currently used NS Vehicle Not currently used NS Route Call to Multim database to retrieve route using NDC The Route element is defined as xs string type Example Route lt Text gt topical lt Text gt lt Route gt lt Site gt Not currently used NS lt AdministrationTiming gt Not currently used NS lt Frequency gt Not currently used NS lt Interval gt Not currently used NS CCR Message Specification 182 Attributes Data Objects XML Tag Comm
237. tor Death Date X And Time GT1 25 Guarantor Death Flag X GT1 26 Guarantor Charge X Adjustment Code GT1 27 Guarantor Household X Annual Income GT1 28 Guarantor Household X Size GT1 29 Guarantor Employer ID X Number GT1 30 Guarantor Marital X Status Code GT1 31 Guarantor Hire X Effective Date GT1 32 Employment Stop Date X GT1 33 Living Dependency X GT1 34 Ambulatory Status X GT1 35 Citizenship X GT1 36 Primary Language X GT1 37 Living Arrangement X GT1 38 Publicity Indicator X GT1 39 Protection Indicator X GT1 40 Student Indicator X Patient Demographic HL7 Specification 161 Field Name Type Length Comments Req d GT1 41 Religion X GT1 42 Mother s Maiden X Name GT1 43 Nationality X GT1 44 Ethnic Group X GT1 45 Contact Person s Name X GT1 46 Contact Person s X Telephone Number GT1 47 Contact Reason X GT1 48 Contact Relationship X GT1 49 Job Title X GT1 50 Job Code Class X GT1 51 Guarantor Employer s X Organ Name GT1 52 Handicap X GT1 53 Job Status X GT1 54 Guarantor Financial X Class GT1 55 Guarantor Race X IN1 Insurance Segment The Insurance INT segment contains insurance policy coverage information necessary to produce properly pro rated and patient and insurance bills This segment is applicable only for insurance billing Field Name Type Length Comments Req d IN1 00 Segment Type ID ST 4 Must be INT R IN1 01 Set ID SI 4 INI m
238. tored user credentials When a user links to Care360 Labs amp Meds via an SSO connection they can then access any Care360 Labs amp Meds functions that are enabled by their user credentials Linking to Care360 Labs amp Meds 9 Accessing Care360 Labs amp Meds via an Established SSO Link The following steps outline the procedure and associated systems involved in accessing Care360 Labs amp Meds from a partner application after a user s SSO link has been initialized outlined in Initializing a User s SSO Connection on page 9 1 A user logs in to the partner application 2 The partner application user initiates a link to Care360 Labs amp Meds A link to Care360 Labs amp Meds can be established in one of the following ways The link can open Care360 Labs amp Meds directly to a specific function For example the Home page the Lab Orders page the New Results page the Patient Summary page or the Action Items Inbox For Lab Orders the current patient context may be maintained if an appropriate match can be determined based on the supplied patient identifier PID or inclusion of the care360 Transaction field ID Thelink can open Care360 Labs amp Meds with no specific function specified In this case the user s default page as configured in the Care360 Labs amp Meds appears 3 Care360 Labs amp Meds opens either in a separate browser window or framed within the context of the partner application if the
239. uest ID definition 196 Required definition 64 Requirements link formatting 3 RetrievalRequest object description 55 RetrievalResultltem object description 56 Retrieve patient demographic updates process walkthrough 52 Retrieve Patient Demographics Services access the WSDL 60 API 53 56 methods 53 objects 55 56 Index 200 Retrieve Patient Demographics Services continued overview 51 XML schema 57 retrieveDemographicMessages method description 53 RGS field requirements patient demographic 133 S SAML definition 196 implementing for SSO 23 25 Oasis specification 21 SAML Browser Artifact definition 196 SAML Browser POST definition 196 Sample CCR messages 188 193 EMR application 14 patient demographic messages 166 167 SSO and web services code 16 SCH field requirements patient demographic 119 123 Schedule patient sample patient demographic message 167 Schema Retrieve Patient Demographics Services XML 57 Single Sign On see SSO SIU Schedule Information Unsolicited message specifications 116 137 Source code EMR Sample application 15 SSO definition 197 establishing organizational trust 22 implementing 21 implementing SAML 23 25 initializing connection 9 overview 2 10 process walkthrough 9 Staging environment Retrieve Patient Demographics Services 60 Submit Patient Demographics Services 48 User Summary Services 36 Submit patient demographic updates process walkthrough 43 Submit Patient Demographics Services
240. umber assigned by O accounting and to which all charges payments etc are recorded It is used to identify the patient s account Only the first subfield ID Number is passed to from Care360 Labs amp Meds PID 19 SSN Number Patient Must contain 9 numeric digits or 11 with hyphens Cannot O be all zeros and first three numbers cannot be 666 800 or 900 If present the Data Exchange verifies that the value complies with the rules above PID 20 Driver s Lic Num Patient DLN 25 DLN format O license number ST issuing state province country IS expiration date DT gt Only the first subfield License Number is passed to from Care360 Labs amp Meds PID 21 Mother s Identifier CX 20 Used for example as a link field for newborns Typically a O patient ID or account number may be used This field can contain multiple identifiers for the same mother Only the first subfield ID Number is passed to from Care360 Labs amp Meds Patient Demographic HL7 Specification 98 Field PID 22 Name Ethnic Group Type IS Length Comments Req d 3 This field supports both HL7 2 3 and HL7 3 0 values O For HL7 2 3 values supported by Care360 Labs amp Meds are listed below H Hispanic N Non Hispanic U Unknown For HL7 3 0 values supported by Care360 Labs amp Meds are the same as the Centers for Disease Control and Prevention CDC e
241. untry O O GT1 06 Home Phone 1234567890 no O O hyphens or dashes allowed Note Home phone number is recommended for bill types of patient IN1 47 P and insurance IN1 47 T If home phone number is not provided it must be entered manually before an order can be placed GT1 07 Work Phone 1234567890 no O O O O hyphens or dashes allowed Linking to Care360 Labs amp Meds Bill Types These are the required fields based on what is sent XML XML Sub Header Main Tag Tag Description Client Patient Insurance ePre GT1 Guarantor GT1 08 Birth Date mm dd yyyyhhmmss or O O O O Information mmddyyyyhhmmss no hyphens or continued dashes allowed Note Pad the date with zeroes for the hhmmss timestamp for example 19901124000000 GT1 09 Gender M m or F f O O O O Note Unknown displays as blank GT1 11 Relationship to patient R R R O 1 Self 2 Spouse 3 Child GT1 12 SSN 9 digits no hyphens or O O O O dashes allowed Employer GT116 Employer Name O O O O Information GT1 17 ADI Address 1 O O O O AD 2 Address 2 O O O O AD 3 City O O O O AD 4 State 2 digit alpha O O O O AD 5 Zip 5 or 9 digits no hyphens or O O O O dashes allowed AD 6 Country O O O INT Insurance 1N1 03 Insurance Company ID Quest O R Information Diagnostics billing code Valid insurance IDs appear in the order entry Insurance ID field in Lab Orders and Results Linking to Care360 Labs amp Meds Bil
242. urrently used S Results Results ot currently used S Procedures Procedures ot currently used S Encounters Encounters ot currently used S Plan Of Care PlanOfCare ot currently used S Healthcare lt HealthCareProviders gt ot currently used S Providers CCR Footer Actors lt Actor gt Patient information structural grouping element R lt ActorObjectID gt Must be a unique Object ID to identify this specific R instance of an Actor for this CCR document Type xs string should be a UUID or OID lt Person gt Structural grouping element O lt Name gt Structural grouping element O lt BirthName gt Not currently used NS lt AdditionalName gt Not currently used NS lt CurrentName gt The Given Family Middle Title and Suffix are being O set The names are all defined as xs string type Example lt CurrentName gt lt Given gt Minnie lt Given gt lt Family gt Mouse lt Family gt lt CurrentName gt lt DisplayName gt Not currently used NS DateOfBirth The DateOfBirth element is defined as xs string type O DateOfBirth format is yyyy mm dd Example lt DateOfBirth gt lt ExactDateTime gt 1951 06 18 lt ExactDateTime gt lt DateOfBirth gt CCR Message Specification 184 Attributes Data Objects XML Tag Actors lt Gender gt continued Comments Req d Male Female Unknown O The Gender element is defined as xs string type Example lt Gender gt
243. ve PID 12 County Code X PID 13 Phone Number Home XTN 40 Accepted length of this field is 40 numeric characters No O dashes or other separating characters Example extension and country code omitted 333 4445555 Example with country code 1 333 4445555 The Data Exchange verifies that the value complies with the rules above PID14 Phone Number XTN Business 40 Accepted length of this field is 40 numeric characters No O dashes or other separating characters Example with extension country code omitted 333 4445555 999 Example with extension and country code 1 333 4445555 999 The Data Exchange verifies that the value complies with the rules above PID 15 Language Patient CE 250 Values supported by Care360 Labs amp Meds are listedin O Patient Language PID 15 on page 168 This field uses the HL7 3 0 field length of 250 rather than the HL7 2 3 field length of 60 Patient Demographic HL7 Specification 97 Field PID16 Name Marital Status Type IS Length Comments 1 Values supported by Care360 Labs amp Meds are listed O below P Polygamous W Widowed D Divorced M Married A Annulled Sc Never Married L Legally Separated Interlocutory T Domestic Partner Req d PID 17 Religion Patient religion O PID 18 Patient Account Number CX 20 Contains the patient account n
244. verage programs PBMs rely on a complex network of relationships with pharmacies drug manufacturers health plans employer groups providers and patients and use a variety of mechanisms to encourage cost effective utilization of prescription drugs Practice Management System PMS A category of healthcare software that deals with the day to day operations of a medical practice Such software frequently allows users to capture patient demographics schedule appointments maintain lists of insurance payers perform billing tasks and generate reports Prescriber A health care provider licensed to prescribe drugs Primary prescribers are physicians but others may have prescriptive authority depending on state statutes and laws Other prescribers may include dentists physician assistants nurse practitioners and others may have authority to prescribe typically within specific limits Provider An organization that provides information or data to the Data Exchange Organizations can include reference labs esoteric labs hospitals payers radiology clinics clearinghouses pharmacies or Pharmacy Benefit Managers PBMs Also referred to as service provider Provider Account An organization that uses the services of a provider such as a physician s office an Independent Physician Association IPA a clinic or a hospital The provider account uniquely defines the organization allowing accurate distribution of data to an authorized entit
245. vironments Retrieve Patient Demographic Web Service API Reference 60 To access the Retrieve Patient Demographic web service in the Production environment access the following link WSDL Document https hubservices medplus com demographic retrieval service wsdl Endpoint https hubservices medplus com demographic retrieval service Retrieve Patient Demographic Web Service API Reference 61 Chapter 6 Patient Demographic HL7 Specification In This Chapter s About the Patient Demographie HLZ SBBGIRICAllOF 252222224 nan Sena SA A dp ERR T3 ANA AA SESAMA Saba Bad 63 Patient Demographic Message Format Requirements ss ser sees 64 ADT A28 Patient Add and ADT A31 Patient Update Message Segment Specifications 65 ADT A29 Patient Delete Message Segment Specifications isses es 92 ADT A39 Patient Merge Message Segment Specifications sssssssssssssssssss nana nk akai 103 SIU Schedule Information Unsolicited Message Segment Specifications ete teenies 116 DFT PO3 Detail Financial Transaction Message Segment Specifications cee eens 138 s Sample Patient Demographie Messages uico add eder aet besa scenes LADEN RE IAS dE TAN SANA DAN tous 166 About Patient Demographic Reference Data a nina AA cece rt anken kie s 168 62 About the Patient Demographic HL7 Specification This chapter provides detailed forma
246. y Request ID A unique identifier that references a specific transaction made by an EMR system and received by the Hub This identifier is assigned to a request upon receipt of the request message The Request ID is unique across all Hub accounts SAML Browser Artifact A data exchange model by which SAML messages are created by an issuer EMR and an artifact small string token is transmitted to the consumer Care360 Labs amp Meds The consumer is then responsible for making a call back to the issuer site with the artifact so that the issuer can retrieve the actual SAML message for processing SAML Browser POST A data exchange model by which SAML messages are digitally signed and transmitted from the issuer EMR to the consumer Care360 Labs amp Meds via the user s web browser or through some HTTP connection simulating a browser The consumer does not make a callback request to the issuer and is able to verify the SAML message using the provided signature Security Assertion Markup Language SAML An XML standard for exchanging authentication and authorization data between security domains that is between an identity provider and a service provider SAML is a product of the OASIS Security Services Technical Committee Glossary 196 Single Sign On SSO The practice of facilitating user login to a single site or application and then allowing that same user access to another site or application without requiring the us

Message Segment Specifications

Contents

Download Pdf Manuals

Related Search

Related Contents