This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Patient Administration Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Encounter , Patient , Practitioner , RelatedPerson |
This is the narrative for the resource. See also the XML , JSON or Turtle format.
Note that this is the formal definition for the everything operation as an OperationDefinition on Encounter. See the Operation documentation
Generated Narrative: OperationDefinition Encounter-everything
URL: [base]/Encounter/[id]/$everything
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _since | 0..1 | instant |
Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time |
||
| IN | _type | 0..* | code |
One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absense of any specified types, the server returns all resource types |
||
| IN | _count | 0..1 | integer |
See discussion below on the utility of paging through the results of the $everything operation |
||
| OUT | return | 1..1 | Bundle |
The bundle type is "searchset" |
The
key
differences
difference
between
this
operation
and
simply
searching
the
encounter
compartment
are:
unless
the
client
requests
otherwise,
the
server
returns
the
entire
result
set
in
a
single
bundle
(rather
than
using
paging)
the
server
is
responsible
for
determining
what
resources
to
return
as
included
resources
(rather
than
the
client
specifying
which
ones)
This
that
it
frees
the
client
from
needing
to
determine
what
it
could
or
should
ask
for,
particularly
with
regard
to
included
resources.
Servers
should
consider
returning
appropriate
Provenance
and
AuditTrail
on
the
returned
resources,
even
though
these
are
not
directly
part
of
the
patient
compartment.
It
is
assumed
that
the
server
has
identified
and
secured
the
context
appropriately,
and
can
either
associate
the
authorization
context
with
a
single
encounter,
or
determine
whether
the
context
has
the
rights
to
the
nominated
encounter,
if
there
is
one,
or
can
determine
an
appropriate
list
of
encouners
to
provide
data
for
from
the
context
of
the
request.
If
there
is
no
nominated
encounter
(GET
/[base]/Encounter/$everything)
and
the
context
is
not
associated
with
a
single
encounter
record,
the
actual
list
of
encounters
is
all
encounters
that
the
user
associated
with
the
request
has
access
to.
In
such
cases,
the
server
may
choose
to
return
an
error
rather
than
all
the
records.
Specifying
the
relationship
between
the
context,
a
user
and
encounter
records
is
outside
the
scope
of
this
specification
(though
see
The
Smart
SMART
App
Launch
Implementation
Guide
.
).
When
this
operation
is
used
to
access
multiple
encounter
records
at
once,
the
return
bundle
could
be
rather
a
lot
of
data;
servers
may
choose
to
require
that
such
requests
are
made
asynchronously
,
and
associated
with
bulk
data
formats
.
Alternatively,
clients
may
choose
to
page
through
the
result
set
(or
servers
may
require
this).
Paging
through
the
results
is
done
the
same
as
for
Searching
,
using
the
_count
parameter,
and
Bundle
links.
Implementers
should
note
that
paging
will
be
slower
than
simply
returning
all
the
results
at
once
(more
network
traffic,
multiple
latency
delays)
but
may
be
required
in
order
not
to
exhaust
available
memory
reading
or
writing
the
whole
response
in
a
single
package.
Unlike
searching,
there
is
no
inherent
user-display
order
for
the
$everything
operation.
Servers
might
MAY
consider
sorting
the
returned
resources
in
descending
order
of
last
record
update,
but
are
not
required
to
do
so.
Servers
should
consider
returning
appropriate
Provenance
and
AuditTrail
on
the
returned
resources,
even
though
these
are
not
directly
part
of
the
patient
compartment.
update.
The _since parameter is provided to support periodic queries to get additional information that has changed about the encounter since the last query. This means that the _since parameter is based on record time. The value of the _since parameter should be set to the time from the server. If using direct response, this is the timestamp in the response header. If using the async interface, this is the transaction timestamp in the json response. Servers should ensure that the timestamps a managed such that the client does not miss any changes. Clients should be able to handle getting the same response more than once in the case that the transaction falls on a time boundary. Clients should ensure that the other query parameters are constant to ensure a coherent set of records when doing periodic queries.
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.