This page is part of the FHIR Specification (v4.3.0-snapshot1: Release 4B Snapshot #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 . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is the narrative for the resource. See also the XML, JSON or Turtle format.
OPERATION: meta
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta
This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:
URL: [base]/$meta
URL: [base]/Resource/$meta
URL: [base]/Resource/[id]/$meta
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
OUT | return | 1..1 | Meta | The meta returned by the operation |
At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principal use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.