This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
This is the narrative for the resource. See also the
XML
or
or
JSON
format.
format.
OPERATION:
Access
a
list
of
profiles,
tags,
and
security
labels
OPERATION: Access a list of profiles, tags, and security labels
This
operation
retrieves
a
summary
of
the
profiles,
tags,
and
security
labels
for
the
given
scope;
e.g.
for
each
scope:
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
the
resource
type
individual
resource
level:
A
list
of
all
profiles,
tags,
and
security
labels
for
the
current
version
of
the
resource.
Also,
as
a
special
case,
this
operation
(and
other
meta
operations)
can
be
performed
on
a
historical
version
of
a
resource)
URL:
[base]/$meta
URL: [base]/$meta
URL:
[base]/Resource/$meta
URL: [base]/Resource/$meta
URL:
[base]/Resource/[id]/$meta
URL: [base]/Resource/[id]/$meta
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| OUT | return | 1..1 | Meta |
|
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
principle
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
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 principle 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.