This wiki has undergone a migration to Confluence found Here
Difference between revisions of "Template Versioning Requirements"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
=Statement on template backward compatibility= | =Statement on template backward compatibility= | ||
| − | *An instance that conforms to a new version of a template will also continue to conform to a prior version of the template. (Example: Template X, version 1 constrains observation.code to Y. Version 2 constrains observation.code to Y and also constrains observation.effectiveTime to TS) | + | *An instance that conforms to a new version of a template will also continue to conform to a prior version of the template. (Example: Template X, version 1 constrains observation.code to Y. Version 2 constrains observation.code to Y and also constrains observation.effectiveTime to TS) |
=From the perspective of the IG constraint= | =From the perspective of the IG constraint= | ||
| + | *Template referencing is ALWAYS static (e.g. is ALWAYS to a specific version). | ||
*Ability to constrain to a particular version of a template. | *Ability to constrain to a particular version of a template. | ||
| + | *Different versions retain the same name (suggesting the need for id and setId) | ||
| + | |||
| + | =From the perspective of the instance= | ||
| + | *Template referencing is ALWAYS static (e.g. is ALWAYS to a specific version). | ||
| + | *An instance needs to be able to claim conformance with a particular version of a template. | ||
=Template metadata requirements= | =Template metadata requirements= | ||
*Version history | *Version history | ||
| − | |||
| − | |||
| − | |||
=Legacy template representation= | =Legacy template representation= | ||
Revision as of 16:55, 12 November 2009
SDWG page.
Contents
Statement on template backward compatibility
- An instance that conforms to a new version of a template will also continue to conform to a prior version of the template. (Example: Template X, version 1 constrains observation.code to Y. Version 2 constrains observation.code to Y and also constrains observation.effectiveTime to TS)
From the perspective of the IG constraint
- Template referencing is ALWAYS static (e.g. is ALWAYS to a specific version).
- Ability to constrain to a particular version of a template.
- Different versions retain the same name (suggesting the need for id and setId)
From the perspective of the instance
- Template referencing is ALWAYS static (e.g. is ALWAYS to a specific version).
- An instance needs to be able to claim conformance with a particular version of a template.
Template metadata requirements
- Version history
Legacy template representation
- Given that these requirements are developed on top of existing IGs...
Template representation bakeoff
- No versioning. Any change results in new templateId.
- Add version number / version date to template (and allow for inclusion in references).
Background sources
- HITSP Template versioning position statement
- IHE Template versioning position statement
- Value set versioning
- Data types R2 Instance Identifier representation
