Release 5 Draft Ballot

2.30 MetadataResource Resource

http://www.hl7.org/Special/committees/fiwg/index.cfmMaturity 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.

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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MetadataResource «A»NCanonicalResourceCommon 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..1dateWhen the {{title}} was approved by publisher
... lastReviewDate 0..1dateWhen the {{title}} was last reviewed
... 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

XML Template

Turtle Template

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


[ 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MetadataResource «A»NCanonicalResourceCommon 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..1dateWhen the {{title}} was approved by publisher
... lastReviewDate 0..1dateWhen the {{title}} was last reviewed
... 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

XML Template

Turtle Template

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


[ 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.
]
PathDefinitionTypeReference
MetadataResource.topic ExampleDefinitionTopic

Common search parameters defined by this resource. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
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