This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Glossary Artifact Definition"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "{{subst::Template:SAIF Artifact Definition}}")
 
Line 11: Line 11:
 
<!-- At a high level, what is this artifact and why is it needed?  Should ideally be only a few sentences -->
 
<!-- At a high level, what is this artifact and why is it needed?  Should ideally be only a few sentences -->
  
Put text here
+
PRELIMINARY NOTES:
 +
MIF -  (bold is element)
 +
*'''glossary'''
 +
**title (0..1)
 +
**secondaryId (0..1)
 +
**:
 +
**'''packageLocation (0..1)'''
 +
***all standard elements
 +
**:
 +
**'''replaces (0..*)''' (glossary by ref)
 +
**'''replacedBy (0..*)''' (glossary by ref)
 +
**'''importedGlossary (0..*)''' (glossary by ref) "base glossary" whose terms will be overridden if defined in current glossary
 +
**:
 +
**'''termDefinition (1..*)'''
 +
***term (1..1) note that this is the '''sole identifier''' at this level
 +
***:
 +
***'''definition (0..*)''' - despite being infinitely infinite, there is NO further identification except the "lang" in the text element
 +
****''''text (1..*)''' (with language)
 +
***:
 +
***'''termTranslation (0..*)'''
 +
****name (1..1) - translated term
 +
****lang (0..1)
 +
****'''realmNamespace (0..*)''' in which used or managed
 +
*****value  (1..1)
 +
***:
 +
***'''seeAlso (0..*)''' type is a syting holding a term to reference
 +
 
 +
identifier elements (min) reqd choices for publishing include : artifact realm domain name
 +
 
 +
gl identified by:
 +
 
 +
should be artifact (not defined in a domain like the RIM, DAM, DT, VO, DC , but these are NOT presently allowed a GL)
 +
 
 +
domain-realm
 +
artifact-domain-realm
 +
 
 +
name-realm (Like core principles)
  
 
== SAIF Matrix Location ==
 
== SAIF Matrix Location ==

Revision as of 05:02, 19 April 2011

Return to Artifact List

Some Artifact Name

Definition and Purpose

PRELIMINARY NOTES: MIF - (bold is element)

  • glossary
    • title (0..1)
    • secondaryId (0..1)
    • packageLocation (0..1)
      • all standard elements
    • replaces (0..*) (glossary by ref)
    • replacedBy (0..*) (glossary by ref)
    • importedGlossary (0..*) (glossary by ref) "base glossary" whose terms will be overridden if defined in current glossary
    • termDefinition (1..*)
      • term (1..1) note that this is the sole identifier at this level
      • definition (0..*) - despite being infinitely infinite, there is NO further identification except the "lang" in the text element
        • 'text (1..*) (with language)
      • termTranslation (0..*)
        • name (1..1) - translated term
        • lang (0..1)
        • realmNamespace (0..*) in which used or managed
          • value (1..1)
      • seeAlso (0..*) type is a syting holding a term to reference

identifier elements (min) reqd choices for publishing include : artifact realm domain name

gl identified by:

should be artifact (not defined in a domain like the RIM, DAM, DT, VO, DC , but these are NOT presently allowed a GL)

domain-realm artifact-domain-realm

name-realm (Like core principles)

SAIF Matrix Location

Row(s)

  • Conceptual (CIM)
  • Logical (PIM)
  • Implementable (PSM)

Column(s)

  • Enterprise/Business
  • Information
  • Computational
  • Engineering
  • Technical

Audience

Health Care Community Audiences:

  • General public
  • Health care practitioners
  • Health system administrators
  • Health care policy makers

Health Care Information Technology (IT) Audiences:

  • System designers and architects
  • System purchasers
  • Programmers/implementers
  • System vendor management

Applicability

Text

Rationale: More text

Requirements, Relationships and Content

  1. Some requirement
    1. RationaleSome reason
  2. Some other requirement
    1. RationaleSome other reason

Relationships and traceability

  • Some relationship
    • Rationale: Reason for relationship
  • Some other relationship
    • Rationale: Reason for other relationship

Artifact types that may or must relate to this artifact types:

  • Many-related Artifact Type
  • Another Many-related Artifact Type

Content

  • Content element name - Brief Description
  • Another content element name - Brief Description
    • Sub-element name - Brief Description
  • Another content element name - Brief Description

Artifact Technology

Text here

Rationale

  • Some reason
  • Some other reason

Alternatives

Some technology

  • Some pro or con
  • Some other pro or con

Content Constraints

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Content Guidelines

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Publishing Representation(s)

  1. Some text
    1. Rationale: Some rationale
  2. Some other text
    1. Rationale: Some other rationale

Publishing Constraints

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Tooling Considerations

  1. Nice-to-have|Required: Some feature
    1. Rationale: Some rationale
  2. Nice-to-have|Required: Some other feature
    1. Rationale: Some other rationale

Development Process Considerations

  1. Some text
    1. Rationale: Some rationale
  2. Some other text
    1. Rationale: Some other rationale

Governance Process Considerations

  1. Governance Process name - Some process description
    1. Rationale: Some rationale
  2. Another Governance Process name - Process description
    1. Rationale: Some other rationale

Issues

  • Some issue
  • Some other issue