Templates for SAIF Generic Information Model Artifact Elements

Return to Artifact List

Generic Information Model Artifact Definition Elements

Definition and Purpose

This document is, of itself, neither an Artifact Definition nor a Template

This document and the templates it "includes" define generic elements for inclusion in the SAIF Artifact Definitions of the RIM and RIM-derived models. The inclusion will be verbatim from the templates where the actual generic content is maintained.

Key features of this document

This document:

• structured using the Template:SAIF Artifact Definition
• only selected sub-sections of that template are actually defined
• sections that appear as being defined here are actually contained in a set of Wiki templates that are "included" in this document
• where ever this template inclusion occurs, the name and span of that template will be indicated in large blue font

"Including" generic content in another Artifact Definition

To include a particular generic section, do the following:

1. Prepare the target document up to the point where the inclusion will occur
   • Note: This should include the header for the subsection in question
2. On a new line insert the template reference that is included in the large blue font text surrounding the inclusion
   • The template reference can be copied (select and Ctrl-C) from the normal viewing page for this document.

   • The template reference looks like {{Template:Referenced Template Name}}
3. If you intend to extend a "list" (numbered or bullet) that is at the end of the generic content, simple place your new line immediately following the line with the template reference. Do not leave a blank line.

4. When the target document is displayed (Show Preview or Save Page) the content from the template will be included as the page is rendered. The content is not copied into the "source" for the target page.

Note: Do not attempt to use this document as a template. All content that is displayed is marked for exclusion, with exception of the template references that are packaged here.

No generic content for this section.

SAIF Matrix Location

No generic content for this section.

Audience

No generic content for this section.

Applicability

No generic content for this section.

Requirements, Relationships and Content

The following set of generic Requirements is drawn from {{Template:SAIF Generic IM Requirements}} (select at left to copy reference)

1. This type of model MUST include the set of classes, attributes and associations from the parent (derived from) model that represent the information needed to support interoperability in the domain or project that this model will support.
   1. RationaleDerived Models must use the RIM-derived model content needed to support the interoperability project in question.
2. This model MUST maintain a degree of abstraction appropriate to the level of the model, remembering that models derived from this model can be more specific.
   1. Rationale Large models with myriad classes may obscure the core patterns and concepts that need to be represented in a particular DIM, SIM or other model.
3. This model must include (or be accompanied by) a "design walk-through" that documents the function of each class and "class-equivalent" (see Content section below) in all models, and each attribute in SIMs.
   1. Rationale Such walk-throughs are critical to the understanding of an information model, and are required as part of the ballot for such models.

end of contents from {{Template:SAIF Generic IM Requirements}} (click at left to go to template)

Relationships and traceability

1. All of the contents of this [Domain|Serializable|Loose|Simplified] Information Model MUST be derived from an artifact whose type is a [Reference|Domain|Serializable] Information Model. Derivation rules are discussed under Content Constraints below.
   1. Rationale These derivation relationships that ultimately dweriv from the RIM are at the heart of HL7's V3 model-driven methodology and architect.

   (Manually insert a variant of this relationship and rationale as the first element of your Artifact Definition.)

The following set of generic relationships is drawn from {{Template:SAIF Generic IM Relationships}} (select at left to copy reference)

• This model and its attributes must be bound to content from a specific "abstract" data type model formally adopted by HL7.
  • Rationale: The data structures that derive from the RIM draw much of their "type" information from data types assigned to RIM attributes.
• This model and its encoded attributes must be bound to content from a specific Vocabulary Model.
  • Rationale: Over 40 per-cent of RIM-derived attributes carry encoded values. The expected terminology binding for those attributes must be carefully defined.
• This model and its common interfaces (CMET references) must be bound to content from a specific Interface Model.
  • Rationale: References to a "Common Model" in a SAIF Information Model must be drawn from a package (model) of defined interfaces.
• Traceability of model content (perhaps via the "derived from" model) to content expressed in a Conceptual Information Model from the relevant domain or project.
  • Rationale: Provide traceability from project requirements expressed in a Conceptual Data Model to their realization as part of the model(s) in the PIM and PSM layers.

end of contents from {{Template:SAIF Generic IM Relationships}} (click at left to go to template)

Content

The following set of generic Content is drawn from {{Template:SAIF Generic IM Content }} (select at left to copy reference)

• Model data - Defining data (including name, version, responsible party, and description) captured at the model level.
  • HL7-defined properties - Properties that formally extend the definition of a model beyond the UML specifications.
• Association - UML element expressing relationships between classes with UML-specified characteristics such as descriptions, name, association ends, cardinalities, navigability, etc.
  • HL7-defined properties - Properties that formally extend the definition of an association beyond the UML specifications.
• Class - UML element with UML-specified characteristics such as descriptions, name, etc.
  • Attribute - UML element with UML-specified characteristics such as descriptions, name, cardinality, etc.
    • Data type - Type assignment from HL7 data types specification.
    • HL7-defined properties - Properties that formally extend the definition of an attribute beyond the UML specifications.
  • HL7-defined properties - Properties that formally extend the definition of a class beyond the UML specifications.
• Entry Point - A graphical model element that points to a single class that is the root class for serialization of this model, or may be the root class for serialization of derived models.
• Class-equivalent elements - Extensions to UML that are represented graphically and may appear anywhere in the model that a Class can appear. These include:
  • Common Model Reference - Reference to the root class of another model drawn from an Interface Model

  • Non-Common Model Reference - Reference to the root class of another model that is not a member of the Interface Model

  • Stub - A locus for binding to the root class of another model that will be contained within (be the "payload" for) this model.

end of contents from {{Template:SAIF Generic IM Content}} (click at left to go to template)

Artifact Technology

No generic content for this section.

Rationale

No generic content for this section.

Alternatives

No generic content for this section.

Content Constraints

No generic content for this section.

Content Guidelines

No generic content for this section.

Publishing Representation(s)

No generic content for this section.

Publishing Constraints

No generic content for this section.

Tooling Considerations

No generic content for this section.

Development Process Considerations

No generic content for this section.

Governance Process Considerations

No generic content for this section.

Issues

No generic content for this section.