Difference between revisions of "Publishing Package Artifact Definition"
Line 10: | Line 10: | ||
== 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 --> | ||
− | + | A mechanism by which to define a package that organizes and documents a set of SAIF artifacts for publication. Its purpose is to support balloting and distribution of specifications using SAIF artifacts, and includes a means of documenting the package itself, over and above the documentation inherent in each of the artifacts that it is packaging. The packaging occurs by reference to SAIF artifacts that are stored elsewhere. The package is not a "container." | |
+ | <!-- | ||
'''NOTES:''' | '''NOTES:''' | ||
Line 35: | Line 36: | ||
:*:'''OBSERVATION:''' Clearly, it does '''not apply to the DEFN file for CorePrinciples''', because it is not a "DC" and therefore its package location is (I believe): | :*:'''OBSERVATION:''' Clearly, it does '''not apply to the DEFN file for CorePrinciples''', because it is not a "DC" and therefore its package location is (I believe): | ||
:*::'''<mif:packageLocation root="DEFN" realmNamespace="UV" name="v3modelcoreprinciples"/>''' | :*::'''<mif:packageLocation root="DEFN" realmNamespace="UV" name="v3modelcoreprinciples"/>''' | ||
− | + | --> | |
== 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 used to package artifacts at any level. | ||
'''Row(s)''' | '''Row(s)''' | ||
* Conceptual (CIM) | * Conceptual (CIM) | ||
Line 52: | Line 53: | ||
== 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.--> | ||
+ | Briefly, publication packages may be assembled '''for any target audience'''. | ||
− | |||
Health Care Community Audiences: | Health Care Community Audiences: | ||
*General public <!-- as health care participants --> | *General public <!-- as health care participants --> | ||
Line 67: | Line 69: | ||
== 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? --> | ||
− | + | This artifact provides a convenient way to assemble and document artifacts for publication. Therefore it will be created wherever and whenever a Work Group, project team, or HL7 publishers wish to publish SAIF artifacts for whatever purpose. | |
− | <i>Rationale</i>: | + | :<i>Rationale</i>: Is designed as an aid for publication and will be core vehicle for the HL7 publishing software. |
== 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.) --> | ||
− | # | + | # Provide a means for uniquely identifying the package to be published. |
− | ## <i>Rationale</i> | + | ## <i>Rationale</i> Seems obvious. |
− | # | + | # Provide a means to "include", by reference, a specific SAIF artifact, or an identifiable sub-component of that artifact for publication. |
− | ## <i>Rationale</i> | + | ## <i>Rationale</i> The purpose is to publish SAIF artifacts and doing it by reference allows multiple such packages to include a given artifact without having to alter the content of the artifact itself. In some cases, it may be useful to, for example, include a single identified "class" from an information model. |
+ | # Provide a means for grouping (a sub-package, if you will) artifact references or other groups within the package. | ||
+ | ## <i>Rationale</i> Such grouping allows the package to have a hierarchical structure (chapters, sections, etc. in order to facilitate understanding of the content. | ||
+ | # Provide ability to add documentation (with mark-up) that precedes and follows each group and reference in the package, including the package itself. | ||
+ | ## <i>Rationale</i> Anticipate the need for "preceding" and "following" text that supplements the information in the components themselves. | ||
+ | # Include contextual data such as copyrights, authorship, responsibility, etc. to support publication. | ||
+ | ## <i>Rationale</i> Handle the meta-data for the publication itself. | ||
=== Relationships and traceability === | === Relationships and traceability === | ||
Revision as of 15:59, 21 April 2011
Contents
- 1 Publishing Package - initial layout only
- 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
Publishing Package - initial layout only
Alternate considerations:
- Publication Package
- Publishing Grouper
- Publication Grouper
Definition and Purpose
A mechanism by which to define a package that organizes and documents a set of SAIF artifacts for publication. Its purpose is to support balloting and distribution of specifications using SAIF artifacts, and includes a means of documenting the package itself, over and above the documentation inherent in each of the artifacts that it is packaging. The packaging occurs by reference to SAIF artifacts that are stored elsewhere. The package is not a "container."
SAIF Matrix Location
This artifact is "Level-independent" because it is may be used to package artifacts at any level. Row(s)
- Conceptual (CIM)
- Logical (PIM)
- Implementable (PSM)
Column(s)
- Enterprise/Business
- Information
- Computational
- Engineering
- Technical
Audience
Briefly, publication packages may be assembled for any target 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 provides a convenient way to assemble and document artifacts for publication. Therefore it will be created wherever and whenever a Work Group, project team, or HL7 publishers wish to publish SAIF artifacts for whatever purpose.
- Rationale: Is designed as an aid for publication and will be core vehicle for the HL7 publishing software.
Requirements, Relationships and Content
- Provide a means for uniquely identifying the package to be published.
- Rationale Seems obvious.
- Provide a means to "include", by reference, a specific SAIF artifact, or an identifiable sub-component of that artifact for publication.
- Rationale The purpose is to publish SAIF artifacts and doing it by reference allows multiple such packages to include a given artifact without having to alter the content of the artifact itself. In some cases, it may be useful to, for example, include a single identified "class" from an information model.
- Provide a means for grouping (a sub-package, if you will) artifact references or other groups within the package.
- Rationale Such grouping allows the package to have a hierarchical structure (chapters, sections, etc. in order to facilitate understanding of the content.
- Provide ability to add documentation (with mark-up) that precedes and follows each group and reference in the package, including the package itself.
- Rationale Anticipate the need for "preceding" and "following" text that supplements the information in the components themselves.
- Include contextual data such as copyrights, authorship, responsibility, etc. to support publication.
- Rationale Handle the meta-data for the publication itself.
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