This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Requirements-Annotations"

From HL7Wiki
Jump to navigation Jump to search
(New page: {{V3 Methodology Requirements}} Annotations are a set of free-hand descriptive elements that accompany most, though not all HL7 v3 artifacts and sub-artifacts. They are broken up into a s...)
 
Line 25: Line 25:
 
|-
 
|-
 
| ''Rationale''  
 
| ''Rationale''  
−
| todo
+
| HL7 artifacts often have constraints that can't be formally asserted using XMI or other constraint languages, possibly because they apply to content outside the instance or because there's simply no formal way to express the rule.  However, these are still rules that must be followed by implementations and therefore need to be called out distinctly from implementation notes or other general recommendations.
 
|-
 
|-
 
| ''MIF''  
 
| ''MIF''  
 
| mif-core-base.xsd\Annotations\documentation\usageConstraint
 
| mif-core-base.xsd\Annotations\documentation\usageConstraint
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\usageNotes
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\rationale
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\requirements
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\designComments
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\stabilityRemarks
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\walkthrough
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\appendix
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\otherAnnotation
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\mapping
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\formalConstraint
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\openIssue
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\staticExample
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\ballotComment
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\changeRequest
 +
|}
 +
 +
 +
{| border="2" cellspacing="0" cellpadding="3" width="600"
 +
| '''Requirement'''
 +
|
 +
|-
 +
| ''Rationale''
 +
|
 +
|-
 +
| ''MIF''
 +
| mif-core-base.xsd\Annotations\documentation\deprecationInfo
 
|}
 
|}

Revision as of 01:19, 23 June 2009

This page documents one or more V3 Methodology Requirements

Annotations are a set of free-hand descriptive elements that accompany most, though not all HL7 v3 artifacts and sub-artifacts. They are broken up into a series of categories, each having a distinct objective and target audience. Some may have additional supplemental metadata. Each artifact or component of an artifact that allows annotations identifies exactly which types of annotations are allowed for that particular element based on what makes sense for that element. For example, formal constraints may make sense for static model elements, but have little relevance for concept domains which are purely descriptive in nature and have nothing to formally constrain.

MIF: mif-core-base.xsd\Annotations

Requirement All major HL7 artifacts and artifact components require either a description that identifies what the element is or a definition that provides the semantic meaning for that element.
Rationale Some HL7 artifacts and components convey explicit semantic meaning, for example classes, attributes, concept domains, coded concepts, etc. Other artifacts do not represent particular meaning but still require an explanation of that the artifact is and why it exists.

Lack of documentation on an artifact or component can lead to confusion about what the artifact or component is or what it's for.

MIF
  • mif-core-base.xsd\Annotations\documentation\definition
  • mif-core-base.xsd\Annotations\documentation\description


Requirement It must be possible to identify constraints to the usage of a given element that can't be formally expressed
Rationale HL7 artifacts often have constraints that can't be formally asserted using XMI or other constraint languages, possibly because they apply to content outside the instance or because there's simply no formal way to express the rule. However, these are still rules that must be followed by implementations and therefore need to be called out distinctly from implementation notes or other general recommendations.
MIF mif-core-base.xsd\Annotations\documentation\usageConstraint


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\usageNotes


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\rationale


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\requirements


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\designComments


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\stabilityRemarks


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\walkthrough


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\appendix


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\otherAnnotation


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\mapping


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\formalConstraint


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\openIssue


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\staticExample


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\ballotComment


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\changeRequest


Requirement
Rationale
MIF mif-core-base.xsd\Annotations\documentation\deprecationInfo
Retrieved from "https://wiki.hl7.org/w/index.php?title=Requirements-Annotations&oldid=25279"