Release 5 Ballot
FoundationThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N | Normative (from v4.2.0) | Security Category: N/A | Compartments: Not linked to any defined compartments |
Common Interface declaration for conformance and knowledge artifact resources.
The MetadataResource represents resources that carry additional publication metadata over other canonical resources, describing their review and use in more details.
As an interface, this type is never created directly - see Resource Interfaces for more details.
This resource interface extends the CanonicalResource interface. The following resources implement this interface:
No references for this Resource.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MetadataResource | «I»N | CanonicalResource | Common Interface declaration for definitional resources Elements defined in Ancestor Resources: id, meta, implicitRules, language, text, contained, extension, modifierExtension Elements defined in Ancestor interfaces: url, identifier, version, versionAlgorithm[x], name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, copyrightLabel | |
  approvalDate | 0..1 | date | When the {{title}} was approved by publisher | |
| lastReviewDate | 0..1 | date | When the {{title}} was last reviewed | |
 effectivePeriod | Σ | 0..1 | Period | When the {{title}} is expected to be used |
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
| author | 0..* | ContactDetail | Who authored the {{title}} | |
| editor | 0..* | ContactDetail | Who edited the {{title}} | |
| reviewer | 0..* | ContactDetail | Who reviewed the {{title}} | |
| endorser | 0..* | ContactDetail | Who endorsed the {{title}} | |
 relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
| Documentation for this format | ||||
UML Diagram (Legend)
Changes since R4
| MetadataResource | |
| MetadataResource.approvalDate |
|
| MetadataResource.lastReviewDate |
|
| MetadataResource.effectivePeriod |
|
| MetadataResource.topic |
|
| MetadataResource.author |
|
| MetadataResource.editor |
|
| MetadataResource.reviewer |
|
| MetadataResource.endorser |
|
| MetadataResource.relatedArtifact |
|
| MetadataResource.url |
|
| MetadataResource.version |
|
| MetadataResource.name |
|
| MetadataResource.title |
|
| MetadataResource.status |
|
| MetadataResource.experimental |
|
| MetadataResource.date |
|
| MetadataResource.publisher |
|
| MetadataResource.contact |
|
| MetadataResource.description |
|
| MetadataResource.useContext |
|
| MetadataResource.jurisdiction |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MetadataResource | «I»N | CanonicalResource | Common Interface declaration for definitional resources Elements defined in Ancestor Resources: id, meta, implicitRules, language, text, contained, extension, modifierExtension Elements defined in Ancestor interfaces: url, identifier, version, versionAlgorithm[x], name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, copyrightLabel | |
| approvalDate | 0..1 | date | When the {{title}} was approved by publisher | |
| lastReviewDate | 0..1 | date | When the {{title}} was last reviewed | |
| effectivePeriod | Σ | 0..1 | Period | When the {{title}} is expected to be used |
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
| author | 0..* | ContactDetail | Who authored the {{title}} | |
| editor | 0..* | ContactDetail | Who edited the {{title}} | |
| reviewer | 0..* | ContactDetail | Who reviewed the {{title}} | |
| endorser | 0..* | ContactDetail | Who endorsed the {{title}} | |
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
| Documentation for this format | ||||
Changes since Release 4
| MetadataResource | |
| MetadataResource.approvalDate |
|
| MetadataResource.lastReviewDate |
|
| MetadataResource.effectivePeriod |
|
| MetadataResource.topic |
|
| MetadataResource.author |
|
| MetadataResource.editor |
|
| MetadataResource.reviewer |
|
| MetadataResource.endorser |
|
| MetadataResource.relatedArtifact |
|
| MetadataResource.url |
|
| MetadataResource.version |
|
| MetadataResource.name |
|
| MetadataResource.title |
|
| MetadataResource.status |
|
| MetadataResource.experimental |
|
| MetadataResource.date |
|
| MetadataResource.publisher |
|
| MetadataResource.contact |
|
| MetadataResource.description |
|
| MetadataResource.useContext |
|
| MetadataResource.jurisdiction |
|
See the Full Difference for further information
Additional definitions: Master Definition XML + JSON, the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| MetadataResource.topic | High-level categorization of the definition, used for searching, sorting, and filtering. | Example | DefinitionTopic |
Common search parameters defined by this resource. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| composed-of | reference | A resource that the {{title}} is composed of | {{name}}.relatedArtifact.resource |
| depends-on | reference | A resource that the {{title}} depends on | {{name}}.relatedArtifact.resource |
| derived-from | reference | A resource that the {{title}} is derived from | {{name}}.relatedArtifact.resource |
| effective | date | The time during which the {{title}} is intended to be in use | {{name}}.effectivePeriod |
| predecessor | reference | The predecessor of the {{title}} | {{name}}.relatedArtifact.resource |
| successor | reference | The successor of the {{title}} | {{name}}.relatedArtifact.resource |
| topic | token | Topics associated with the {{title}} | {{name}}.topic |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:06+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change