Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU 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 . Page versions: R5 R4B R4 R3 R2

Operation-resource-meta

Example OperationDefinition/Resource-meta (Narrative)

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.

Meta OPERATION: Meta The official URL for

Note that 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: system-wide: a list of all profiles, tags and security labels in use by the system resource-type level: A list of all profiles, tags, and security labels for is the resource type individual resource level: A list of all profiles, tags, and security labels formal definition for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed operation as an OperationDefinition on a historical version of a resource) Resource. See the Operation documentation

URL: [base]/$meta

URL: [base]/Resource/$meta

URL: [base]/Resource/[id]/$meta

Parameters

Use Name Scope 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.