Getting started

Getting started.

Welcome to our openEHR-ruby implementation project. This project provide core library to build EHR by the openEHR standard specifications. You should learn about these technology to utilize this library.

• The openEHR Project

  The openEHR architectural overview is a good summary for developers. Other specification documents are available at this page.

• Ruby

  We use Ruby 1.9.3 and will move to 2.0.0 in near future. Textbook and documents are available in anywhere and I recommend these textbooks.

  • Programming Ruby 1.9
  • The Ruby Programming Language
  • Official documents

• TDD/BDD(Test Driven Development/Behavior Driven Development)

  This library adopts RSpec for test framework. If you need sample codes, spec files are helpful. RSpec textbook is also available and useful to understand behavior driven development.

What you need to implement

This library contains only the core of openEHR technology. If you want to create Rails apps with this library, you need to implement these components, which we are working on. If you can collaborate with us, please, please contact me or leave comment on this page. I always welcome your pull requests and messages.

• Persistent layer for RMs
• RM Factory
• Security module, authentication and user management
• Demographic service(Patient/People management)
• Managed UI

How to use library

A 'openehr' gem is available from rubygems.org. To install this 'openehr' gem, only to run gem install command.

gem install openehr

After you successfully install, you can generate AM/RM instance with this library.

• AM

AM instance can be generated from ADL file, which defines archetype of clinical information model. For example,

`` require 'openehr'

adl_parser = OpenEHR::Parser::ADLParser.new(File('sample.adl')) archetype = adl_parser.parse ``

• RM

  RM