Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.30 MetadataResource Resource

http://www.hl7.org/Special/committees/fiwg/index.cfm

Maturity Level: N

Normative (from v4.2.0)

Compartments: Not linked to any defined compartments

This page has been approved as part of an ANSI

standard. See the Infrastructure Package for further details.

2.30.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.30.2 Boundaries and Relationships

This resource interface extends the CanonicalResource interface. The following resources implement this interface:

Structure

Name	Flags	Card.	Type	Description & Constraints
MetadataResource	«A»N		CanonicalResource	Common Ancestor declaration for definitional resources Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
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)

XML Template

<[name] xmlns="http://hl7.org/fhir"> 
 <!-- from Element: extension -->
 <approvalDate value="[date]"/><!-- 0..1 When the {{title}} was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the {{title}} was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the {{title}} is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the {{title}} --></author>
 <editor><!-- 0..* ContactDetail Who edited the {{title}} --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the {{title}} --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the {{title}} --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
</[name]>

JSON Template

{
  "resourceType" : "[name]",
  // from Resource: id, meta, implicitRules, and language
  "approvalDate" : "<date>", // When the {{title}} was approved by publisher
  "lastReviewDate" : "<date>", // When the {{title}} was last reviewed
  "effectivePeriod" : { Period }, // When the {{title}} is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the {{title}}
  "editor" : [{ ContactDetail }], // Who edited the {{title}}
  "reviewer" : [{ ContactDetail }], // Who reviewed the {{title}}
  "endorser" : [{ ContactDetail }], // Who endorsed the {{title}}
  "relatedArtifact" : [{ RelatedArtifact }] // Additional documentation, citations, etc.
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:MetadataResource.approvalDate [ date ]; # 0..1 When the {{title}} was approved by publisher
  fhir:MetadataResource.lastReviewDate [ date ]; # 0..1 When the {{title}} was last reviewed
  fhir:MetadataResource.effectivePeriod [ Period ]; # 0..1 When the {{title}} is expected to be used
  fhir:MetadataResource.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:MetadataResource.author [ ContactDetail ], ... ; # 0..* Who authored the {{title}}
  fhir:MetadataResource.editor [ ContactDetail ], ... ; # 0..* Who edited the {{title}}
  fhir:MetadataResource.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the {{title}}
  fhir:MetadataResource.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the {{title}}
  fhir:MetadataResource.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
]

Structure

Name	Flags	Card.	Type	Description & Constraints
MetadataResource	«A»N		CanonicalResource	Common Ancestor declaration for definitional resources Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
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)

XML Template

<[name] xmlns="http://hl7.org/fhir"> 
 <!-- from Element: extension -->
 <approvalDate value="[date]"/><!-- 0..1 When the {{title}} was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the {{title}} was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the {{title}} is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the {{title}} --></author>
 <editor><!-- 0..* ContactDetail Who edited the {{title}} --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the {{title}} --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the {{title}} --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
</[name]>

JSON Template

{
  "resourceType" : "[name]",
  // from Resource: id, meta, implicitRules, and language
  "approvalDate" : "<date>", // When the {{title}} was approved by publisher
  "lastReviewDate" : "<date>", // When the {{title}} was last reviewed
  "effectivePeriod" : { Period }, // When the {{title}} is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the {{title}}
  "editor" : [{ ContactDetail }], // Who edited the {{title}}
  "reviewer" : [{ ContactDetail }], // Who reviewed the {{title}}
  "endorser" : [{ ContactDetail }], // Who endorsed the {{title}}
  "relatedArtifact" : [{ RelatedArtifact }] // Additional documentation, citations, etc.
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:[name];
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

 # from Element: Element.extension
  fhir:MetadataResource.approvalDate [ date ]; # 0..1 When the {{title}} was approved by publisher
  fhir:MetadataResource.lastReviewDate [ date ]; # 0..1 When the {{title}} was last reviewed
  fhir:MetadataResource.effectivePeriod [ Period ]; # 0..1 When the {{title}} is expected to be used
  fhir:MetadataResource.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:MetadataResource.author [ ContactDetail ], ... ; # 0..* Who authored the {{title}}
  fhir:MetadataResource.editor [ ContactDetail ], ... ; # 0..* Who edited the {{title}}
  fhir:MetadataResource.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the {{title}}
  fhir:MetadataResource.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the {{title}}
  fhir:MetadataResource.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
]

2.30.3.1 Terminology Bindings

Path	Definition	Type	Reference
MetadataResource.topic		Example	DefinitionTopic

Path

Definition

Type

Reference

MetadataResource.topic

Example

DefinitionTopic

2.30.4 Search Parameters

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