This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Getting Started with CIMI"

From HL7Wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Clinical_Information_Modeling_Initiative_Work_Group|back]]
 
[[Clinical_Information_Modeling_Initiative_Work_Group|back]]
  
Page maintained by Claude Nanjo
+
The CIMI Getting Started Guide will help you get acquainted with CIMI or get you on your way to becoming a productive contributor to the Open CIMI community.
  
== Where can I find the models ==
+
- Please note that this page is currently in development (maintained by Claude Nanjo)
  
CIMI models are maintained on the HL7 Github Repository.
+
== Where can I find the model files? ==
  
You can find the current version of the models [https://github.com/HL7/hl7-cimi-model here]
+
CIMI models are maintained on two [https://github.com/orgs/HL7/teams/cimi/repositories HL7 CIMI Github] Repositories.
You can find previous model submissions [https://github.com/HL7/hl7-cimi-model-distributions here]
+
 
 +
* You can find the current version of the models [https://github.com/HL7/hl7-cimi-model here]
 +
* You can find previous model submissions [https://github.com/HL7/hl7-cimi-model-distributions here]
 +
 
 +
== Where can I view the models? ==
 +
 
 +
What we call the CIMI Logical Model consists of two parts:
 +
 
 +
* '''The CIMI Reference Model'''. This model defines the structure of the logical model - that is, its classes and the properties of those classes. It can be viewed [http://models.opencimi.org/cimi_doc/ here].
 +
* '''The CIMI Archetypes'''. Archetypes are constraints on the reference model such as terminology bindings, data type constraints, and cardinality constraints. Archetypes can be viewed  [http://models.opencimi.org/ here].
 +
 
 +
== What about CIMI Tooling? ==
 +
 
 +
There are three general categories of CIMI tools:
 +
 
 +
* HL7 Build Tools consist of all build tools to support model documentation and the publishing of CIMI models. They can be found on the [https://github.com/orgs/HL7/teams/cimi/repositories HL7 CIMI Github] site.
 +
* CIMI also fosters an open source community which contributes tooling to advance the CIMI initiative. These tools reside on the [https://github.com/orgs/opencimi/dashboard OpenCIMI Github] site.
 +
* Other contributors may also host CIMI tooling on their own repositories. A list of such tools will be published here in the future.
 +
 
 +
== I would like to learn more about CIMI. Are there documents I could read? ==
 +
 
 +
If you are ready to fully immerse yourself in all things CIMI, we recommend reading the following documents:
 +
 
 +
* The CIMI architecture and core principles are documented [https://docs.google.com/document/d/107z1BB4Q87yvYnB4Ui5LeUf9keNoyInkVRQfFfONXrg/edit here].
 +
* The CIMI style guide provides some helpful instructions for building CIMI models and can be found [https://docs.google.com/document/d/1cxkF5pGkxaaUGjux1WtWGymmVA8fpUu0MjXJxL876dw/edit here].
 +
 
 +
== The above documents are dense. How can I get quickly oriented with core CIMI concepts? ==
 +
 
 +
We are currently working on a tutorial to help get you oriented with the CIMI modeling approach. It will be available [[CIMI Modeling Tutorial|here]] soon.

Latest revision as of 00:41, 9 December 2017

back

The CIMI Getting Started Guide will help you get acquainted with CIMI or get you on your way to becoming a productive contributor to the Open CIMI community.

- Please note that this page is currently in development (maintained by Claude Nanjo)

Where can I find the model files?

CIMI models are maintained on two HL7 CIMI Github Repositories.

  • You can find the current version of the models here
  • You can find previous model submissions here

Where can I view the models?

What we call the CIMI Logical Model consists of two parts:

  • The CIMI Reference Model. This model defines the structure of the logical model - that is, its classes and the properties of those classes. It can be viewed here.
  • The CIMI Archetypes. Archetypes are constraints on the reference model such as terminology bindings, data type constraints, and cardinality constraints. Archetypes can be viewed here.

What about CIMI Tooling?

There are three general categories of CIMI tools:

  • HL7 Build Tools consist of all build tools to support model documentation and the publishing of CIMI models. They can be found on the HL7 CIMI Github site.
  • CIMI also fosters an open source community which contributes tooling to advance the CIMI initiative. These tools reside on the OpenCIMI Github site.
  • Other contributors may also host CIMI tooling on their own repositories. A list of such tools will be published here in the future.

I would like to learn more about CIMI. Are there documents I could read?

If you are ready to fully immerse yourself in all things CIMI, we recommend reading the following documents:

  • The CIMI architecture and core principles are documented here.
  • The CIMI style guide provides some helpful instructions for building CIMI models and can be found here.

The above documents are dense. How can I get quickly oriented with core CIMI concepts?

We are currently working on a tutorial to help get you oriented with the CIMI modeling approach. It will be available here soon.