This wiki has undergone a migration to Confluence found Here
Requirements-Metadata
Jump to navigation
Jump to search
This section lists metadata that is common to all HL7 stand-alone artifacts. In some cases, parts of this metadata also appears on child artifacts or components of artifacts. When this occurs, those artifacts will include a reference to this section.
| Requirement | All versions of HL7 specifications and stand-alone artifacts must have a unique identifier that permits: human readability, human recognizability and distributed assignment |
| Rationale | Without a unique identifier, HL7 artifacts and their versions cannot be safely referenced by other HL7 artifacts or by other documents (RFPs, conformance claims) which use them. However in order to be useful in publications such as RFPs and within HL7 specifications, those identifiers need to be ones that can be recognized and interpreted by humans. Because HL7 artifacts will be created by a variety of organizations and groups, both within HL7.org and its affiliates as well as by implementers (e.g. templates and conformance profiles), it's essential that the identification scheme make provision for delegation of issuance of identifiers within discrete namespaces. |
| Methodology | HL7 has adopted a "package-based" naming approach for both definitional and published versions of artifacts. This approach uses a hierarchy of packages to identify the type of artifacts within the package, the affiliate or other organizational namespace responsible for the artifact, the healthcare domain associated with the artifact, a unique identifier for the artifact within the context of the above and the version of the artifact.
Not all of these components will be present for all types of artifacts. The specific components, their order, their allowed values and lengths are all defined by HL7. |
MIF
|
| Requirement | Most versions of HL7 specifications and stand-alone artifacts require a descriptive title |
| Rationale | "DEFN=PO=RX=MT=123456=UV=01" is not terribly meaningful to most readers. Therefore a more semantically meaningful label for an artifact is required. This label should ideally be unique but is not subject to the same namespacing requirements as it is used for understanding, not for reference |
| MIF | mif-core-base.xsd/PackageArtifact/@title |
