Operation-patient-everything

This operation is used to return all the information related to the patient one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". "searchset". At a minimum, the patient resource resource(s) itself is returned, along with any other resources that the server has that are related to the patient, patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc.

The principle intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"). "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient, patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in DAF . Other applicable implementation guides may make additional rules about how much information that is returned returned.

The key differences between this operation and simply searching the patient 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 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 single patient, or determine whether the context has the rights to the nominated patient, if there is one. one, or can determine an appropriate list of patients to provide data for from the context of the request. If there is no nominated patient (e.g. the operation is invoked at the system level) (GET /Patient/$everything) and the context is not associated with a single patient record, then the actual list of patients is all patients that the user associated with the request has access to. This may be all patients in the family that the patient has access to, or it may be all patients that a care provider has access to, or all patients on the entire record system. In such cases, the server should may choose to return an error. error rather than all the records. Specifying the relationship between the context, a user and patient records is outside the scope of this specification. specification (though see The Smart App Launch Implementation Guide .

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