2009-06-16T18:52:14Z Initial page creation. 2554 Architecture 53 8685 __TOC__ = Functional Description = A high-level description of HIEOS functional capabilities is provided in this section. == IHE Cross Enterprise Document Sharing (XDS.b) == === Actors (XDS.b) === HIEOS provides support for the following IHE XDS.b actors: {|- border="1" ! Actor ! Description ! HIEOS? |- | Document Registry | Acts as a <u>record locator service</u>. Stores meta-data describing documents resident in federated repositories. | Yes |- | Document Repository | Storage location for documents. Documents can be PDF, images, XML, text documents, etc. | Yes |- | Patient Identity Source | Source of patient identities that must be known to the Document Registry before meta-data submissions are allowed. | Yes (Client) |- | Document Consumer | Client application (could be an EMR system) that is interested in viewing shared patient records. | Yes (Client) |- | Document Source | Client application (typically an EMR system) that publishes documents for sharing within a broader community. | Yes (Client) |} === Transactions (XDS.b) === HIEOS implements each IHE XDS.b transaction as indicated in the diagram below: [[image: hieos_xdsb_graphic.JPG|403x251px] == IHE Cross Community Access (XCA) == === Actors (XCA) === HIEOS provides support for the following IHE XCA actors: {|- border="1" ! Actor ! Description ! HIEOS? |- | Initiating Gateway | Responds to document requests within a health information sharing community. Retrieves documents within local and remote communities. | Yes |- | Responding Gateway | Responds to document requests from remote health information sharing communities. | Yes |- | Document Registry | Acts as a <u>record locator service</u>. Stores meta-data describing documents resident in federated repositories. | Yes |- | Document Repository | Storage location for documents. Documents can be PDF, images, XML, text documents, etc. | Yes |- | Document Consumer | Client application (could be an EMR system) that is interested in viewing shared patient records. | Yes (Client) |} === Transactions (XCA) === HIEOS implements each IHE XCA transaction (implementing the ''XDS Affinity Domain Option'') as indicated in the diagram below: [[image: hieos_xca_graphic.JPG|503x251px]] = Technical Description = == Layered Architecture Diagram == HIEOS is implemented following a layered architecture pattern as depicted in the diagram below: [[image: hieos_layers_graphic.JPG|451x343px]] == Component Descriptions == The table below provides a brief description of each key HIEOS component: {|- border="1" ! Component ! Description ! Category |- | xtest | Client test harness provided by HIEOS. | Applications |- | xwebtools | Web application that includes an XDS.b Registry and Repository viewer. | Applications |- | logbrowser | Web application that provides a means to view HIEOS transaction logs. | Applications |- | XDS.b Registry | XDS.b Registry Axis2 Web Service. | Services |- | XDS.b Repository | XDS.b Repository Axis2 Web Service. | Services |- | XCA Gateway | XCA Gateway (Initiating and Responding) Axis2 Web Service. | Services |- | OMAR freebXML Registry | XDS.b Registry ebXML v3 storage mechanism. | Database Access Components |- | ADT | Stores patient registration data in support of XDS.b Registry operations. | Database Access Components |- | XLog | Message driven bean that logs HIEOS transactions asynchronously. | Database Access Components |- | RepoImpl | XDS.b Repository storage mechanism. Currently configured to store XDS.b documents in an RDBMS. | Database Access Components |- | Web Service Framework<br/>(Axis2) | Provides web services infrastructure used by HIEOS. | Infrastructure |- | Java Database Connectivity<br/>(JDBC) | Provides database access layer to underlying RDBMS for all HIEOS storage requests. | Infrastructure |- | Application Server<br/>(GlassFish ESB) | Provides J2EE-compliant web application server environment. | Infrastructure |- | RDBMS<br/>(MySQL, PostGres) | Provides RDBMS storage mechanism for HIEOS. | Infrastructure |} <div id='toc' class='toc'> <div id='toctitle' class='toc-title'> <span>Contents</span> </div> <div id='toccontents' class='toc-contents'><ul><li>1 <a href='#Functional_Description'> Functional Description </a></li> <ul><li>1.1 <a href='#IHE_Cross_Enterprise_Document_Sharing_(XDS.b)'> IHE Cross Enterprise Document Sharing (XDS.b) </a></li> <ul><li>1.1.1 <a href='#Actors_(XDS.b)'> Actors (XDS.b) </a></li> <li>1.1.2 <a href='#Transactions_(XDS.b)'> Transactions (XDS.b) </a></li> </ul><li>1.2 <a href='#IHE_Cross_Community_Access_(XCA)'> IHE Cross Community Access (XCA) </a></li> <ul><li>1.2.1 <a href='#Actors_(XCA)'> Actors (XCA) </a></li> <li>1.2.2 <a href='#Transactions_(XCA)'> Transactions (XCA) </a></li> </ul></ul><li>2 <a href='#Technical_Description'> Technical Description </a></li> <ul><li>2.1 <a href='#Layered_Architecture_Diagram'> Layered Architecture Diagram </a></li> <li>2.2 <a href='#Component_Descriptions'> Component Descriptions </a></li> </ul></ul></div> </div><h1><a name='Functional_Description'></a> Functional Description </h1> <p>A high-level description of HIEOS functional capabilities is provided in this section. </p><h2><a name='IHE_Cross_Enterprise_Document_Sharing_(XDS.b)'></a> IHE Cross Enterprise Document Sharing (XDS.b) </h2> <h3><a name='Actors_(XDS.b)'></a> Actors (XDS.b) </h3> <p>HIEOS provides support for the following IHE XDS.b actors: </p><div style="overflow-x: auto;"><div style="margin: 0px 2px 0px 2px;"> <table - border="1"><tr><th> Actor </th><th> Description </th><th> HIEOS? </th></tr> <tr><td> Document Registry </td><td> Acts as a <u>record locator service</u>. Stores meta-data describing documents resident in federated repositories. </td><td> Yes </td></tr> <tr><td> Document Repository </td><td> Storage location for documents. Documents can be PDF, images, XML, text documents, etc. </td><td> Yes </td></tr> <tr><td> Patient Identity Source </td><td> Source of patient identities that must be known to the Document Registry before meta-data submissions are allowed. </td><td> Yes (Client) </td></tr> <tr><td> Document Consumer </td><td> Client application (could be an EMR system) that is interested in viewing shared patient records. </td><td> Yes (Client) </td></tr> <tr><td> Document Source </td><td> Client application (typically an EMR system) that publishes documents for sharing within a broader community. </td><td> Yes (Client) </td></tr> </table> </div></div> <h3><a name='Transactions_(XDS.b)'></a> Transactions (XDS.b) </h3> <p>HIEOS implements each IHE XDS.b transaction as indicated in the diagram below: </p><p><?link_for_image hieos_xdsb_graphic.JPG|403x251px]?></p><h2><a name='IHE_Cross_Community_Access_(XCA)'></a> IHE Cross Community Access (XCA) </h2> <h3><a name='Actors_(XCA)'></a> Actors (XCA) </h3> <p>HIEOS provides support for the following IHE XCA actors: </p><div style="overflow-x: auto;"><div style="margin: 0px 2px 0px 2px;"> <table - border="1"><tr><th> Actor </th><th> Description </th><th> HIEOS? </th></tr> <tr><td> Initiating Gateway </td><td> Responds to document requests within a health information sharing community. Retrieves documents within local and remote communities. </td><td> Yes </td></tr> <tr><td> Responding Gateway </td><td> Responds to document requests from remote health information sharing communities. </td><td> Yes </td></tr> <tr><td> Document Registry </td><td> Acts as a <u>record locator service</u>. Stores meta-data describing documents resident in federated repositories. </td><td> Yes </td></tr> <tr><td> Document Repository </td><td> Storage location for documents. Documents can be PDF, images, XML, text documents, etc. </td><td> Yes </td></tr> <tr><td> Document Consumer </td><td> Client application (could be an EMR system) that is interested in viewing shared patient records. </td><td> Yes (Client) </td></tr> </table> </div></div> <h3><a name='Transactions_(XCA)'></a> Transactions (XCA) </h3> <p>HIEOS implements each IHE XCA transaction (implementing the <i>XDS Affinity Domain Option</i>) as indicated in the diagram below: </p><p><?link_for_image hieos_xca_graphic.JPG|503x251px?></p><h1><a name='Technical_Description'></a> Technical Description </h1> <h2><a name='Layered_Architecture_Diagram'></a> Layered Architecture Diagram </h2> <p>HIEOS is implemented following a layered architecture pattern as depicted in the diagram below: </p><p><?link_for_image hieos_layers_graphic.JPG|451x343px?></p><h2><a name='Component_Descriptions'></a> Component Descriptions </h2> <p>The table below provides a brief description of each key HIEOS component: </p><div style="overflow-x: auto;"><div style="margin: 0px 2px 0px 2px;"> <table - border="1"><tr><th> Component </th><th> Description </th><th> Category </th></tr> <tr><td> xtest </td><td> Client test harness provided by HIEOS. </td><td> Applications </td></tr> <tr><td> xwebtools </td><td> Web application that includes an XDS.b Registry and Repository viewer. </td><td> Applications </td></tr> <tr><td> logbrowser </td><td> Web application that provides a means to view HIEOS transaction logs. </td><td> Applications </td></tr> <tr><td> XDS.b Registry </td><td> XDS.b Registry Axis2 Web Service. </td><td> Services </td></tr> <tr><td> XDS.b Repository </td><td> XDS.b Repository Axis2 Web Service. </td><td> Services </td></tr> <tr><td> XCA Gateway </td><td> XCA Gateway (Initiating and Responding) Axis2 Web Service. </td><td> Services </td></tr> <tr><td> OMAR freebXML Registry </td><td> XDS.b Registry ebXML v3 storage mechanism. </td><td> Database Access Components </td></tr> <tr><td> ADT </td><td> Stores patient registration data in support of XDS.b Registry operations. </td><td> Database Access Components </td></tr> <tr><td> XLog </td><td> Message driven bean that logs HIEOS transactions asynchronously. </td><td> Database Access Components </td></tr> <tr><td> RepoImpl </td><td> XDS.b Repository storage mechanism. Currently configured to store XDS.b documents in an RDBMS. </td><td> Database Access Components </td></tr> <tr><td> Web Service Framework<br />(Axis2) </td><td> Provides web services infrastructure used by HIEOS. </td><td> Infrastructure </td></tr> <tr><td> Java Database Connectivity<br />(JDBC) </td><td> Provides database access layer to underlying RDBMS for all HIEOS storage requests. </td><td> Infrastructure </td></tr> <tr><td> Application Server<br />(GlassFish ESB) </td><td> Provides J2EE-compliant web application server environment. </td><td> Infrastructure </td></tr> <tr><td> RDBMS<br />(MySQL, PostGres) </td><td> Provides RDBMS storage mechanism for HIEOS. </td><td> Infrastructure </td></tr> </table> </div></div> 2009-06-16T21:12:53Z 8048