Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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
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>
</[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
}

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
]

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
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>
</[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
}

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
]

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
effective	date	The time during which the {{title}} is intended to be in use	{{name}}.effectivePeriod