Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

2.1.27.8 2.1.26.7 Resource MetadataResource - Content

Responsible Owner: FHIR Infrastructure icon Work Group Maturity Level : N   Normative (from v4.2.0) Security Category : N/A Compartments : No defined compartments

Common Interface declaration for conformance and knowledge artifact resources.

2.1.27.8.1 2.1.26.7.1 Scope and Usage

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.

2.1.27.8.3 2.1.26.7.3 References to this Resource

No references for this Resource.

2.1.27.8.4 2.1.26.7.4 Resource Content

Structure

XD
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . 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
. . . usage 0..1 markdown Describes the clinical usage of the {{title}}
... approvalDate 0..1 date When the {{title}} was approved by publisher
. . . lastReviewDate 0..1 date When the {{title}} was last reviewed by the publisher
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( 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


doco Documentation for this format icon

UML Diagram ( Legend )

MetadataResource ( CanonicalResource ) «Interface» A detailed description of how the {{title}} is used from a clinical/user perspective usage : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the {{title}} content was or is planned to be in active use effectivePeriod : Period [0..1] 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 topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the {{title}} author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the {{title}} editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}} reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*]

Changes from both R4 and R4B

MetadataResource
MetadataResource.usage
  • Added Element
MetadataResource.approvalDate
  • Added Element
MetadataResource.lastReviewDate
  • Added Element
MetadataResource.effectivePeriod
  • Added Element
MetadataResource.topic
  • Added Element
MetadataResource.author
  • Added Element
MetadataResource.editor
  • Added Element
MetadataResource.reviewer
  • Added Element
MetadataResource.endorser
  • Added Element
MetadataResource.relatedArtifact
  • Added Element
MetadataResource.url
  • Deleted (-> CanonicalResource)
MetadataResource.version
  • Deleted (-> CanonicalResource)
MetadataResource.name
  • Deleted (-> CanonicalResource)
MetadataResource.title
  • Deleted (-> CanonicalResource)
MetadataResource.status
  • Deleted (-> CanonicalResource)
MetadataResource.experimental
  • Deleted (-> CanonicalResource)
MetadataResource.date
  • Deleted (-> CanonicalResource)
MetadataResource.publisher
  • Deleted (-> CanonicalResource)
MetadataResource.contact
  • Deleted (-> CanonicalResource)
MetadataResource.description
  • Deleted (-> CanonicalResource)
MetadataResource.useContext
  • Deleted (-> CanonicalResource)
MetadataResource.jurisdiction
  • Deleted (-> CanonicalResource)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and R4B as XML or JSON .

Structure

XD
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . 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
. . . usage 0..1 markdown Describes the clinical usage of the {{title}}
... approvalDate 0..1 date When the {{title}} was approved by publisher
. . . lastReviewDate 0..1 date When the {{title}} was last reviewed by the publisher
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( 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


doco Documentation for this format icon

UML Diagram ( Legend )

MetadataResource ( CanonicalResource ) «Interface» A detailed description of how the {{title}} is used from a clinical/user perspective usage : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the {{title}} content was or is planned to be in active use effectivePeriod : Period [0..1] 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 topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the {{title}} author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the {{title}} editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}} reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts relatedArtifact : RelatedArtifact [0..*]

Changes from both R4 and R4B

MetadataResource
MetadataResource.usage
  • Added Element
MetadataResource.approvalDate
  • Added Element
MetadataResource.lastReviewDate
  • Added Element
MetadataResource.effectivePeriod
  • Added Element
MetadataResource.topic
  • Added Element
MetadataResource.author
  • Added Element
MetadataResource.editor
  • Added Element
MetadataResource.reviewer
  • Added Element
MetadataResource.endorser
  • Added Element
MetadataResource.relatedArtifact
  • Added Element
MetadataResource.url
  • Deleted (-> CanonicalResource)
MetadataResource.version
  • Deleted (-> CanonicalResource)
MetadataResource.name
  • Deleted (-> CanonicalResource)
MetadataResource.title
  • Deleted (-> CanonicalResource)
MetadataResource.status
  • Deleted (-> CanonicalResource)
MetadataResource.experimental
  • Deleted (-> CanonicalResource)
MetadataResource.date
  • Deleted (-> CanonicalResource)
MetadataResource.publisher
  • Deleted (-> CanonicalResource)
MetadataResource.contact
  • Deleted (-> CanonicalResource)
MetadataResource.description
  • Deleted (-> CanonicalResource)
MetadataResource.useContext
  • Deleted (-> CanonicalResource)
MetadataResource.jurisdiction
  • Deleted (-> CanonicalResource)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and R4B as XML or JSON .

 

Additional definitions: Master Definition XML + JSON , the spreadsheet version & the dependency analysis

2.1.27.8.4.1 2.1.26.7.4.1 Terminology Bindings

Path ValueSet Type Documentation
MetadataResource.topic DefinitionTopic Example

High-level categorization of the definition, used for searching, sorting, and filtering.



2.1.27.8.5 2.1.26.7.5 Search Parameters

Search parameters defined by this interface for all implementations. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths
context token A use context assigned to the {{title}} {{name}}.useContext.valueCodeableConcept
context-quantity quantity A quantity- or range-valued use context assigned to the {{title}} {{name}}.useContext.valueQuantity, {{name}}.useContext.valueRange
context-reference reference A use context reference assigned to the {{title}}
context-type token A type of use context assigned to the {{title}} {{name}}.useContext.code
context-type-quantity composite A use context type and quantity- or range-based value assigned to the {{title}}
context-type-value composite A use context type and value assigned to the {{title}}
date date The {{title}} publication date {{name}}.date
description string The description of the {{title}} {{name}}.description
identifier token External identifier for the {{title}} {{name}}.identifier
jurisdiction token Intended jurisdiction for Jurisdiction of the authority that maintains the the {{title}} {{name}}.jurisdiction
name string Computationally friendly name of the {{title}} {{name}}.name
publisher string Name of the publisher of the {{title}} {{name}}.publisher
status token The current status of the {{title}} {{name}}.status
title string The human-friendly name of the {{title}} {{name}}.title
url uri The uri that identifies the {{title}} {{name}}.url
version token The business version of the {{title}} {{name}}.version
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