Release 5

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

2.1.27.8 Resource MetadataResource - Content

FHIR Infrastructure icon Work GroupMaturity 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 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 References to this Resource

No references for this Resource.

2.1.27.8.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MetadataResource «I»NCanonicalResourceCommon 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..1dateWhen the {{title}} was approved by publisher
... lastReviewDate 0..1dateWhen the {{title}} was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the {{title}} is expected to be used
... author 0..*ContactDetailWho authored the {{title}}

... editor 0..*ContactDetailWho edited the {{title}}

... reviewer 0..*ContactDetailWho reviewed the {{title}}

... endorser 0..*ContactDetailWho endorsed the {{title}}

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc


doco Documentation for this format icon

UML Diagram (Legend)

MetadataResource (CanonicalResource) «Interface»The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the {{title}} content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : 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 settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]

Changes from both R4 and R4B

MetadataResource
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MetadataResource «I»NCanonicalResourceCommon 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..1dateWhen the {{title}} was approved by publisher
... lastReviewDate 0..1dateWhen the {{title}} was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the {{title}} is expected to be used
... author 0..*ContactDetailWho authored the {{title}}

... editor 0..*ContactDetailWho edited the {{title}}

... reviewer 0..*ContactDetailWho reviewed the {{title}}

... endorser 0..*ContactDetailWho endorsed the {{title}}

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc


doco Documentation for this format icon

UML Diagram (Legend)

MetadataResource (CanonicalResource) «Interface»The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the {{title}} content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : 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 settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifactsrelatedArtifact : RelatedArtifact [0..*]

Changes from both R4 and R4B

MetadataResource
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 Terminology Bindings

PathValueSetTypeDocumentation
MetadataResource.topic DefinitionTopic Example

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

2.1.27.8.5 Search Parameters

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

NameTypeDescriptionPaths
contexttokenA use context assigned to the {{title}}{{name}}.useContext.valueCodeableConcept
context-quantityquantityA quantity- or range-valued use context assigned to the {{title}}{{name}}.useContext.valueQuantity, {{name}}.useContext.valueRange
context-referencereferenceA use context reference assigned to the {{title}}
context-typetokenA type of use context assigned to the {{title}}{{name}}.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the {{title}}
context-type-valuecompositeA use context type and value assigned to the {{title}}
datedateThe {{title}} publication date{{name}}.date
descriptionstringThe description of the {{title}}{{name}}.description
identifiertokenExternal identifier for the {{title}}{{name}}.identifier
jurisdictiontokenIntended jurisdiction for the {{title}}{{name}}.jurisdiction
namestringComputationally friendly name of the {{title}}{{name}}.name
publisherstringName of the publisher of the {{title}}{{name}}.publisher
statustokenThe current status of the {{title}}{{name}}.status
titlestringThe human-friendly name of the {{title}}{{name}}.title
urluriThe uri that identifies the {{title}}{{name}}.url
versiontokenThe business version of the {{title}}{{name}}.version
composed-ofreferenceA resource that the {{title}} is composed of{{name}}.relatedArtifact.resource
depends-onreferenceA resource that the {{title}} depends on{{name}}.relatedArtifact.resource
derived-fromreferenceA resource that the {{title}} is derived from{{name}}.relatedArtifact.resource
effectivedateThe time during which the {{title}} is intended to be in use{{name}}.effectivePeriod
predecessorreferenceThe predecessor of the {{title}}{{name}}.relatedArtifact.resource
successorreferenceThe successor of the {{title}}{{name}}.relatedArtifact.resource
topictokenTopics associated with the {{title}}{{name}}.topic