This wiki has undergone a migration to Confluence found Here
Difference between revisions of "Glossary Artifact Definition"
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 --> | ||
− | + | 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
Contents
- 1 Some Artifact Name
- 1.1 Definition and Purpose
- 1.2 SAIF Matrix Location
- 1.3 Audience
- 1.4 Applicability
- 1.5 Requirements, Relationships and Content
- 1.6 Artifact Technology
- 1.7 Content Constraints
- 1.8 Content Guidelines
- 1.9 Publishing Representation(s)
- 1.10 Publishing Constraints
- 1.11 Tooling Considerations
- 1.12 Development Process Considerations
- 1.13 Governance Process Considerations
- 1.14 Issues
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
- term (1..1) note that this is the sole identifier at this level
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
- Some requirement
- RationaleSome reason
- Some other requirement
- 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
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Content Guidelines
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Publishing Representation(s)
- Some text
- Rationale: Some rationale
- Some other text
- Rationale: Some other rationale
Publishing Constraints
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Tooling Considerations
- Nice-to-have|Required: Some feature
- Rationale: Some rationale
- Nice-to-have|Required: Some other feature
- Rationale: Some other rationale
Development Process Considerations
- Some text
- Rationale: Some rationale
- Some other text
- Rationale: Some other rationale
Governance Process Considerations
- Governance Process name - Some process description
- Rationale: Some rationale
- Another Governance Process name - Process description
- Rationale: Some other rationale
Issues
- Some issue
- Some other issue