This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example OperationDefinition/EpisodeOfCare-everything (Narrative)

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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 EpisodeOfCare. See the Operation documentation

URL: [base]/EpisodeOfCare/[id]/$everything



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


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


See discussion below on the utility of paging through the results of the $everything operation


The bundle type is "searchset"

The key differences between this operation and simply searching the episodeofcare 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 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 episodeofcare, or determine whether the context has the rights to the nominated episodeofcare, if there is one, or can determine an appropriate list of episodeofcares to provide data for from the context of the request. If there is no nominated episodeofcare (GET /[base]/EpisodeOfCare/$everything) and the context is not associated with a single episodeofcare record, the actual list of episodeofcares is all episodeofcares 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 episodeofcare records is outside the scope of this specification (though see The Smart App Launch Implementation Guide.

When this operation is used to access multiple episodeofcare 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 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.

The _since parameter is provided to support periodic queries to get additional information that has changed about the episodeofcare 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.