.. Indivo X documentation master file, created by
   sphinx-quickstart on Wed Jul 20 17:33:59 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Indivo X's technical documentation!
==============================================

.. contents::

Overview
^^^^^^^^

If you are interested in working with Indivo, you probably fall into one or more of
the following categories:

* `General Interest`_: You've heard about this 'Indivo X' project, and want to learn
  more about what it can do. You might want to check out our 
  `non-technical wiki <http://wiki.chip.org/indivo/index.php/Indivo>`_ before 
  diving into this more technical overview.

* `App Developers`_: You want to build applications that enable patients to engage in
  their care, using Indivo's RESTful API to store and fetch medical data. You are
  interested in the API, including functionality and authentication.

* `Indivo Administrators`_: You want to set up and host your own instance of Indivo,
  so that you or others can build applications on top of it. You are interested in
  pulling data into Indivo, setting up users, and managing your instance.

* `Indivo Hackers`_: You are a big fan of Indivo, but realize (as do we) that there 
  are plenty of additions that could make Indivo X even better! You want to dive
  into Indivo's core codebase and fix bugs or add features, and contribute back
  to our open-source community.

Based on your level of interest, check out the documentation below.

General Interest
^^^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1

   API <api>
   Architecture Overview <overview>
   Authentication <authentication>
   Client Libraries <client-libs>
   Data Models <data-models/index>
   Schemas <schemas/index>

App Developers
^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1

   Architecture Overview <overview>
   API <api>
   api-reference
   App UI Conventions <ui-conventions>
   Authentication <authentication>
   Basic Data Formats <data-formats>
   Client Libraries <client-libs>
   Coding Systems <coding-systems>
   Complex Queries over Indivo Reports <query-api>
   Data Models <data-models/index>
   Data Pipeline <data-pipeline>
   Experimental API <experimental-api>
   Messaging and Notifications <messaging>
   Python Client Reference <py-client-reference>
   Registering Apps with Indivo <app-registration>
   Sample Data <sample-data>
   Schemas <schemas/index>

Indivo Administrators
^^^^^^^^^^^^^^^^^^^^^

You'll probably want to start with our 
`Installation Instructions <http://wiki.chip.org/indivo/index.php/Technical_Documentation#HOWTOs>`_.

.. toctree::
   :maxdepth: 1

   Architecture Overview <overview>
   Auditing <audit>
   Coding Systems <coding-systems>
   Connecting Indivo to a Hospital <hospital-connector>
   Data Models <data-models/index>
   Data-Modeling Languages <sdm>
   Data Pipeline <data-pipeline>
   Localization <localization>
   Registering Apps with Indivo <app-registration>
   Sample Data <sample-data>
   Schemas <schemas/index>
   Transforms <transform>

Indivo Hackers
^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1

   Architecture Overview <overview>
   Access Control <access-control>
   API <api>
   Auditing <audit>
   Authentication <authentication>
   Auto-generated Documentation of the Indivo Codebase <autocode/modules>
   Basic Data Formats <data-formats>
   Client Libraries <client-libs>
   Coding Systems <coding-systems>
   Complex Queries over Indivo Reports <query-api>
   Connecting Indivo to a Hospital <hospital-connector>
   Documenting Indivo <documentation>
   Data Models <data-models/index>
   Data-Modeling Languages <sdm>
   Data Pipeline <data-pipeline>
   Experimental API <experimental-api>
   Generic Reports <generic-reports>
   Localization <localization>
   Messaging and Notifications <messaging>
   Python Client Reference <py-client-reference>
   Registering Apps with Indivo <app-registration>
   Sample Data <sample-data>
   Schemas <schemas/index>
   Transforms <transform>
   todos

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`