Administrative Incubator
0.1.0 - International flag

Administrative Incubator, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/admin-incubator/ and changes regularly. See the Directory of published versions

OperationDefinition: Fetch EpisodeOfCare Record

Official URL: http://hl7.org/fhir/build/OperationDefinition/EpisodeOfCare-everything Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-05 Maturity Level: 2 Computable Name: Everything

This operation is used to return all the information related to an episodeofcare described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the episodeofcare resource itself is returned, along with any other resources that the server has available for the given episodeofcare for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an episodeofcare for efficient display).

The server SHOULD return all resources it has that:

  • are included in the episodeofcare compartment for the identified episodeofcare (have a reference to the episodeofcare)
  • are referenced by the standard extension for associating an episodeofcare (where no reference element exists) http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
  • the server believes are relevant to the context of the episodeofcare for any other reason (internally defined/decided)
  • any resource referenced by the above, including binaries and attachments (to make a more complete package)

Last updated: 2021-01-05 10:01:24+1100

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN_since0..1instant

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_type0..*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_count0..1integer

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

OUTreturn1..1Bundle

The bundle type is "searchset"