COVA Implementation Guide
Total Page:16
File Type:pdf, Size:1020Kb
ConnectVirginia EXCHANGE Services Implementation Guide Version 1.4 July 18, 2012 CONTENTS 1 Executive Summary .......................................................................................................... 5 2 Intended Audience ........................................................................................................... 5 3 Overview ......................................................................................................................... 5 4 Services ........................................................................................................................... 7 4.1 Authorization .......................................................................................................... 7 4.1.1 Security Assertion Markup Language (SAML) Attributes .................................. 7 4.1.2 Purpose of Use ............................................................................................... 9 4.1.3 Consent ......................................................................................................... 9 4.2 Patient Discovery ..................................................................................................... 9 4.2.1 Specifications ............................................................................................... 10 4.2.2 Initiating Node Scenarios ............................................................................. 10 4.2.3 Responding Node Scenarios ......................................................................... 10 4.2.4 Sample Messages ......................................................................................... 11 4.2.5 Request Parameters ..................................................................................... 11 4.2.6 Error Handling ............................................................................................. 14 4.3 Document Query ................................................................................................... 17 4.3.1 Specifications ............................................................................................... 17 4.3.2 Initiating Node Scenarios ............................................................................. 17 4.3.3 Responding Node Scenarios ......................................................................... 18 4.3.4 Sample Messages ......................................................................................... 18 4.3.5 Request Parameters ..................................................................................... 18 4.3.6 Error Handling ............................................................................................. 20 4.4 Document Retrieve ................................................................................................ 21 4.4.1 Specifications ............................................................................................... 21 4.4.2 Initiating Node Scenarios ............................................................................. 21 4.4.3 Responding Node Scenarios ......................................................................... 22 4.4.4 Sample Messages ......................................................................................... 22 4.4.5 Request Parameters ..................................................................................... 22 4.4.6 Error Handling ............................................................................................. 22 Support Contact Information: 800-446-4250 or [email protected] Page 2 of 84 MEDfx DOC ID: 34-1206-016 4.5 Document Submission ........................................................................................... 23 4.5.1 Specifications ............................................................................................... 23 4.5.2 Initiating Node Scenarios ............................................................................. 24 4.5.3 Responding Node Scenarios ......................................................................... 24 4.5.4 Sample Messages ......................................................................................... 24 4.5.5 Request Parameters ..................................................................................... 24 4.5.6 Error Handling ............................................................................................. 26 5 Appendix A – Sample Patient Discovery Messages .......................................................... 28 5.1 Patient Discovery Request Message ....................................................................... 28 5.2 Patient Discovery Response Message ..................................................................... 34 6 Appendix B – Sample Document Query Messages ........................................................... 41 6.1 Document Query Request Message ........................................................................ 41 6.2 Document Query Response Message ...................................................................... 46 6.3 Document Query Registry Error #1 ......................................................................... 55 6.4 Document Query Registry Error #2 ......................................................................... 56 7 Appendix C – Sample Document Retrieve Messages........................................................ 57 7.1 Document Retrieve Request Message .................................................................... 57 7.2 Document Retrieve Response Message .................................................................. 65 7.3 Document Retrieve Error #1 ................................................................................... 68 7.4 Document Retrieve Error #2 ................................................................................... 70 8 Appendix D – Sample Document Submission Messages ................................................... 70 8.1 Document Submission Request .............................................................................. 70 8.2 Document Submission Response ............................................................................ 78 8.3 Document Submission Error ................................................................................... 79 9 Appendix E – Sample Soap Fault Message ....................................................................... 80 10 Appendix F – Sample Query Parameter Validation Failure ............................................... 81 Support Contact Information: 800-446-4250 or [email protected] Page 3 of 84 MEDfx DOC ID: 34-1206-016 REVISION HISTORY Revision Implemented Approval Version Approved By Reason Date By Date Restructured Document 1.2 28 June 2012 MEDfx Added Content Update and Respond to 1.3 11 July 2012 Feedback Update and Respond to 1.4 18 July 2012 Feedback RELATED DOCUMENTATION This table includes key related documentation. ID Title Version Notes https://developer.connectopensource.org/download/attachment Patient Discovery 1 2.0 s/65601729/NHIN_Patient_Discovery_Production_Specification_v Specification 2.0.pdf?version=1&modificationDate=1330007330000 Query for https://developer.connectopensource.org/download/attachment 2 Documents 3.0 s/65601729/NHIN_QueryforDocumentsProductionSpecification_v Specification 3.0.pdf?version=1&modificationDate=1330007946000 Retrieve https://developer.connectopensource.org/download/attachment 3 Documents 3.0 s/65601729/NHIN_Retrieve_Documents_Production_Specificatio Specification n_v3.0.pdf?version=1&modificationDate=1330007320000 Document https://developer.connectopensource.org/download/attachment 4 Submissions 2.0 s/65601729/NHIN_document_submission_production_specificati Specification on_v2_0.pdf?version=1&modificationDate=1330007255000 Authorization https://developer.connectopensource.org/download/attachment 5 Framework 3.0 s/65601729/NHIN_AuthorizationFrameworkProductionSpecificati Specification on_v3.0.pdf?version=1&modificationDate=1330007296000 Messaging https://developer.connectopensource.org/download/attachment 6 Platform 2.0 s/36176694/NHIN_MessagingPlatformProductionSpecification_v2 Specification .0.pdf?version=1&modificationDate=1276728020000 Support Contact Information: 800-446-4250 or [email protected] Page 4 of 84 MEDfx DOC ID: 34-1206-016 1 EXECUTIVE SUMMARY ConnectVirginia is the Commonwealth of Virginia’s Health Information Exchange (HIE) which supports the exchange of medical records among healthcare entities in a secure, electronic, and internet-based technology. After applicant nodes have completed their application process, successfully performed their onboarding and certification activities, and remitted their subscription fee, an applicant node becomes known as a Certified Node. Each Certified Node is required to make the Patient Discovery, Document Query, Document Retrieve and Document Submission services available. This Implementation Guide defines the integration requirements for organizations in the process of becoming Certified Nodes. In general, strict adherence to the Nationwide Health Information Network (NwHIN) standards is required for successful integration with ConnectVirginia. 2 INTENDED AUDIENCE The intended audience for this document is technical staff such as System Analysts and Software Engineers for organizations in the process of becoming a Certified Node. It is assumed that the reader has familiarity with the NwHIN Interface Specifications and the CONNECT software, as well as experience with Web Services and Health