This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
http://www.hl7.org/Special/committees/fiwg/index.cfm | Maturity Level: N | Normative (from v4.2.0) | Compartments: No defined compartments |
Detailed Descriptions for the elements in the MetadataResource Resource.
MetadataResource | |
Definition | Common Interface declaration for conformance and knowledge artifact resources. |
Short Display | Common Interface declaration for definitional resources |
Cardinality | 0..* |
Type | CanonicalResource |
Summary | false |
MetadataResource.approvalDate | |
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Short Display | When the {{title}} was approved by publisher |
Cardinality | 0..1 |
Type | date |
Summary | false |
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. |
MetadataResource.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. |
Short Display | When the {{title}} was last reviewed by the publisher |
Cardinality | 0..1 |
Type | 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. |
Summary | false |
Comments | If specified, this date follows the original approval date. |
MetadataResource.effectivePeriod | |
Definition | The period during which the {{title}} content was or is planned to be in active use. |
Short Display | When the {{title}} is expected to be used |
Cardinality | 0..1 |
Type | Period |
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. |
Summary | true |
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. |
MetadataResource.topic | |
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource |
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. |
Short Display | E.g. Education, Treatment, Assessment, etc |
Cardinality | 0..* |
Terminology Binding | Definition Topic (Example) |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches. |
Summary | false |
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) |
MetadataResource.author | |
Definition | An individiual or organization primarily involved in the creation and maintenance of the {{title}}. |
Short Display | Who authored the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Summary | false |
MetadataResource.editor | |
Definition | An individual or organization primarily responsible for internal coherence of the {{title}}. |
Short Display | Who edited the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Summary | false |
MetadataResource.reviewer | |
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}. |
Short Display | Who reviewed the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Summary | false |
Comments | See guidance around (not) making local changes to elements here. |
MetadataResource.endorser | |
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting. |
Short Display | Who endorsed the {{title}} |
Cardinality | 0..* |
Type | ContactDetail |
Summary | false |
Comments | See guidance around (not) making local changes to elements here. |
MetadataResource.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. |
Short Display | Additional documentation, citations, etc |
Cardinality | 0..* |
Type | RelatedArtifact |
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. |
Summary | false |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |