created readme.md

README.md

@@ -0,0 +1,41 @@
+# Everest
+<div class="wikidoc">
+<p>In short, the Everest Framework is designed to ease the creation, formatting, and transmission of HL7v3 structures with remote systems.&nbsp;</p>
+<p>The &quot;framework&quot; provides a series of consistent, well documented components that, when used together, provide a flexible mechanism for supporting HL7v3 standards within application. Through a combination of automatically generated code and carefully constructed
+ handwritten modules, Everest has the ability <a>to</a> serialize, validate, and transmit structures. Everest comes bundled with basic serialization capabilities for:</p>
+<ul>
+<li>HL7 Clinical Document Architecture r2 </li><li>HL7v3 Messaging </li><li>Normative Edition 2008 </li><li>Normative Edition 2010 </li><li>pan-Canadian Messaging Specifications </li><li>R02.04.01 </li><li>R02.04.02 </li><li>R02.04.03 </li></ul>
+<p><br>
+The serialization assemblies bundled with Everest represent the structures contained within the MIF files bundled with documentation (where license permits), functionality (validation, casting, etc.) and structure meta-data. Additional standards or documentation
+ for the bundled DLLs can be generated by processing Model Interchange Format (MIF) files (version 2.1.2, 2.1.3, 2.1.4, 2.1.5 and 2.1.6) using either the GPMR or GPMR Wizard tools bundled with the framework. The following (additional) standards are known to
+ work with Everest but are not included:</p>
+<ul>
+<li>pan-Canadian CeRX 4.3 messaging </li><li>Universal Normative Edition 2009 </li></ul>
+<p><br>
+Everest currently supports serializing structures to/from the following formats:</p>
+<ul>
+<li>XML ITS 1.0 </li><li>HL7v3 XML Data Types R1 (UV and CA extensions) </li><li>HL7v3 XML Data Types R2 </li><li>Binary format </li></ul>
+<p><br>
+Everest currently supports transporting structures to/from other systems using the following connectors:</p>
+<ul>
+<li>Windows Communication Foundation (Server/Client mode) (basicHttpBinding, wsHttpBinding, ws2007HttpBinding, netTcpBinding)
+</li><li>File Systems (Server/Client) </li><li>Msmq (Publish only) </li></ul>
+<p><br>
+The pillars of Everest are:</p>
+<ul>
+<li><strong>Intuitiveness: </strong>All components within Everest are designed to be intuitive to developers. Great care has been taken to reduce the complexity of the Framework and allow developers to focus on HL7v3 messaging
+</li><li><strong>Standards Compliance: </strong>Being a standards-based framework, one of the foundational pieces is standards compliance. The Everest framework is more than just a serialization engine; it will generate messages, transport them, and validate instances
+ in a standards-compliant manner. </li><li><strong>Quality:</strong> Everest code is held to the highest standard of quality in terms of regression testing and documentation. All changes made to the framework are reviewed for their quality and are subject to over 8,000 tests.
+</li><li><strong>Performance</strong>: Everest has been designed with long-term performance in mind. Many of the methods within Everest (especially formatting) have the ability to &quot;learn&quot; and become faster the more they are used.
+</li><li><strong>Flexibility</strong>: Everest has been designed to be flexible in the manner that allows it to support new HL7v3 standards.
+</li></ul>
+<h6>Architecture</h6>
+<p>The MARC-HI Everest Framework is modeled using a very loosely coupled architecture. This design allows application developers to program against one set of HL7v3 models, and serialize/de-serialize to many different Implementable Technology Specification
+ (ITS) formats. The MARC-HI Everest Framework also allows applications to consume or produce these models using a wide array of transport mechanisms.</p>
+<p>This flexible architecture ensures that the internal canonical data of your application is safely insulated from changes in the HL7v3 ITS, or transport specifications.</p>
+<p><img src="http://te.marc-hi.ca/projects/ev/images/framework-diagram.jpg" alt="framework diagram"></p>
+<h2>Continuous Integration Status:</h2>
+<p>You can view the CI build results of Everest here: <a href="http://ci-services.fyfesoftware.ca:8081/job/Everest%20Community%20Build/">
+http://ci-services.fyfesoftware.ca:8081/job/Everest%20Community%20Build/</a></p>
+<p>&nbsp;</p>
+</div><div class="ClearBoth"></div>