This wiki has undergone a migration to Confluence found Here
Annotations Best Practices
Jump to navigation
Jump to search
This summary of "best practices" in creating annotations for RIM, Vocabulary and other content is drawn from recommendations of the HL7 Technical Editing Project. These style rules have used to revise all annotations in the HL7 Reference Information Model.
| HL7 Technical Editing Project - Annotation Style Guide | |||
| Annotation Type | Description | Used By | Criteria |
| Definition | An explanation of the meaning of the element. Intended to explain the semantics of the element. Should be sufficient to differentiate the semantics of the element from other sibling elements. | Internal, Designer, Consumer, Implementer, Academic | A definition is a noun phrase. It SHALL NOT include examples or explanations of usage. It MAY include clarifying sentences. A definition addresses the semantic space of the feature: it SHALL NOT constrain data types (e.g., "a code indicating . . ."). |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure |
| TypeName | Description | Users | Rules of structure
|
