--- type: "resource-definitions" title: "MetadataResource Definitions" resource: "MetadataResource" --- # MetadataResource Definitions ## MetadataResource Common Interface declaration for definitional resources **Definition:** Common Interface declaration for conformance and knowledge artifact resources. **Cardinality:** 1..1 **Mappings:** w5=conformance.behavior ## MetadataResource.usage Describes the clinical usage of the {{title}} **Definition:** A detailed description of how the {{title}} is used from a clinical/user perspective. **Cardinality:** 0..1 **Type:** [markdown](/markdown) **Mappings:** objimpl=no-gen-base ## MetadataResource.approvalDate When the {{title}} was approved by publisher **Definition:** The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. **Comments:** The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). **Cardinality:** 0..1 **Type:** [date](/date) **Mappings:** objimpl=no-gen-base ## MetadataResource.lastReviewDate When the {{title}} was last reviewed by the publisher **Definition:** The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. **Comments:** If specified, this date follows the original approval date. **Requirements:** Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). **Cardinality:** 0..1 **Type:** [date](/date) **Mappings:** objimpl=no-gen-base ## MetadataResource.effectivePeriod When the {{title}} is expected to be used **Definition:** The period during which the {{title}} content was or is planned to be in active use. **Comments:** The effective period for a {{title}} determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). **Requirements:** Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the {{title}} are or are expected to be used instead. **Cardinality:** 0..1 **Type:** [Period](/Period) **Summary:** true **Mappings:** objimpl=no-gen-base ## MetadataResource.topic E.g. Education, Treatment, Assessment, etc **Definition:** Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching. **Comments:** This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) **Requirements:** Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches. **Cardinality:** 0..* **Type:** [CodeableConcept](/CodeableConcept) **Binding:** example:[definition-topic](/valueset-definition-topic) ## MetadataResource.author Who authored the {{title}} **Definition:** An individiual or organization primarily involved in the creation and maintenance of the {{title}}. **Cardinality:** 0..* **Type:** [ContactDetail](/ContactDetail) ## MetadataResource.editor Who edited the {{title}} **Definition:** An individual or organization primarily responsible for internal coherence of the {{title}}. **Cardinality:** 0..* **Type:** [ContactDetail](/ContactDetail) ## MetadataResource.reviewer Who reviewed the {{title}} **Definition:** An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}. **Comments:** See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). **Cardinality:** 0..* **Type:** [ContactDetail](/ContactDetail) ## MetadataResource.endorser Who endorsed the {{title}} **Definition:** An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting. **Comments:** See guidance around (not) making local changes to elements [here](canonicalresource.html#localization). **Cardinality:** 0..* **Type:** [ContactDetail](/ContactDetail) ## MetadataResource.relatedArtifact Additional documentation, citations, etc **Definition:** Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. **Comments:** Each related artifact is either an attachment, or a reference to another resource, but not both. **Requirements:** A {{title}} must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. **Cardinality:** 0..* **Type:** [RelatedArtifact](/RelatedArtifact)