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
Line 1: Line 1:
 
 
[[Category:SAIF Artifact Definition]]
 
[[Category:SAIF Artifact Definition]]
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
 
 
=Glossary - incomplete=
 
=Glossary - incomplete=
 
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
 
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
 
== Definition and Purpose ==
 
== Definition and Purpose ==
 
<!-- 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 -->
 
+
Is a '''collection of defined terms''' used in the specifications created for a particular domain or project.  It collects defined terms from a variety of sources and makes them and their definitions available for "re-use" in other standards and publications.
 
PRELIMINARY NOTES:
 
PRELIMINARY NOTES:
 
MIF -  (bold is element)
 
MIF -  (bold is element)
Line 47: Line 45:
  
 
== SAIF Matrix Location ==
 
== SAIF Matrix Location ==
 
 
<!-- Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate -->
 
<!-- Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate -->
 +
This artifact is '''"Level-independent"''' because it is may be required at any level at which other artifacts or specifications are being defined. Glossaries are managed to serve all levels.
 
'''Row(s)'''
 
'''Row(s)'''
 
* Conceptual (CIM)
 
* Conceptual (CIM)
Line 57: Line 55:
 
* Enterprise/Business
 
* Enterprise/Business
 
* Information
 
* Information
* Computational
 
* Engineering
 
* Technical
 
  
 
== Audience ==
 
== Audience ==
 +
<!-- Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.-->
 +
The audience is '''all audiences''' because the definitional clarity provided by a glossary is intended to inform any audience.
  
<!-- Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.-->
 
 
Health Care Community Audiences:
 
Health Care Community Audiences:
 
*General public <!-- as health care participants -->
 
*General public <!-- as health care participants -->
Line 77: Line 73:
  
 
== Applicability ==
 
== Applicability ==
 
 
<!-- Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why? -->
 
<!-- Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why? -->
Text
+
This artifact should be created wherever new terminology is being introduced for use in HL7 specifications. Because of the management requirements of glossaries, they should be defined, in general, at the [[Artifact Domain Artifact Definition#Domain|domain level]] rather than as part of artifacts of a lower scope.
 
+
:<i>Rationale</i>:Glossary term definitions need to be overseen by the Work Groups that create them and must be managed, overall, for publishing in HL7.  Thus the glossary content should be aggregated, to the degree possible, within Work Groups and domains.
<i>Rationale</i>: More text
 
 
 
 
== Requirements, Relationships and Content ==
 
== Requirements, Relationships and Content ==
 
 
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
 
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
# Some requirement
+
# Each glossary '''term must have a unique name''' within the context in which it is defined.
## <i>Rationale</i>Some reason
+
## <i>Rationale</i>Terms are referenced by their names.
# Some other requirement
+
# Each glossary term must be defined within a context that is one of:
 +
#:*A domain-realm combination of a [[Artifact Domain Artifact Definition#Namespace realm|namespace realm]] and an HL7 [[Artifact Domain Artifact Definition#Domain|domain level]] 
 
## <i>Rationale</i>Some other reason
 
## <i>Rationale</i>Some other reason
 
=== Relationships and traceability ===
 
=== Relationships and traceability ===

Revision as of 20:16, 19 April 2011

Return to Artifact List

Glossary - incomplete

Definition and Purpose

Is a collection of defined terms used in the specifications created for a particular domain or project. It collects defined terms from a variety of sources and makes them and their definitions available for "re-use" in other standards and publications. 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 string 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

This artifact is "Level-independent" because it is may be required at any level at which other artifacts or specifications are being defined. Glossaries are managed to serve all levels. Row(s)

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

Column(s)

  • Enterprise/Business
  • Information

Audience

The audience is all audiences because the definitional clarity provided by a glossary is intended to inform any 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

This artifact should be created wherever new terminology is being introduced for use in HL7 specifications. Because of the management requirements of glossaries, they should be defined, in general, at the domain level rather than as part of artifacts of a lower scope.

Rationale:Glossary term definitions need to be overseen by the Work Groups that create them and must be managed, overall, for publishing in HL7. Thus the glossary content should be aggregated, to the degree possible, within Work Groups and domains.

Requirements, Relationships and Content

  1. Each glossary term must have a unique name within the context in which it is defined.
    1. RationaleTerms are referenced by their names.
  2. Each glossary term must be defined within a context that is one of:
    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