This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
| Responsible Owner: FHIR Infrastructure Work Group | Standards Status : Informative | Compartments : Device , Patient , Practitioner |
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 Group. See the Operation documentation
Generated Narrative: OperationDefinition Group-everything
URL: [base]/Group/[id]/$everything
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | start | 0..1 | date |
The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. |
||
| IN | end | 0..1 | date |
The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope. |
||
| 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 between this operation and simply searching the group's patients compartment are:
This frees the client from needing to determine what it could or should ask for, particularly with regard to included resources.
It
is
assumed
that
the
server
has
identified
and
secured
the
context
appropriately,
and
can
either
associate
the
authorization
context
with
a
particular
group,
or
determine
whether
the
context
has
the
rights
to
the
nominated
group,
if
there
is
one,
or
can
determine
an
appropriate
list
of
groups
to
provide
data
for
from
the
context
of
the
request.
If
there
is
no
nominated
group
(GET
/[base]/Group/$everything)
and
the
context
is
not
associated
with
a
single
group
record,
the
actual
list
of
groups
is
all
groups
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
(and
is
likely
to
do
so,
but
not
required
to).
Specifying
the
relationship
between
the
context,
a
user
and
groups
is
outside
the
scope
of
this
specification
(though
see
The
Smart
SMART
App
Launch
Implementation
Guide
.
).
The return bundle from this operation is usually rather a lot of data; servers typically 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 consider sorting the returned resources in descending order of last record update, but are not required to do so.
The _since parameter is provided to support periodic queries to get additional information that has changed about the group 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.