Full name: projects.locations.datasets.fhirStores.fhir.Encounter-everything
Retrieves an Encounter resource and resources related to that Encounter.
Implements the FHIR extended operation Encounter-everything (DSTU2, STU3, or R4.
On success, the response body contains a JSON-encoded representation of a Bundle
resource of type searchset
, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome
resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
The resources in scope for the response are:
- The Encounter resource itself.
- All the resources directly referenced by the Encounter resource, including attachments and binaries.
- Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition (DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters.
- Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension.
HTTP request
GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Encounter/*}/$everything
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. Name of the Encounter resource for which the information is required. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
_page_token |
Optional. Used to retrieve the next or previous page of results when using pagination. Set Omit |
_count |
Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. |
_since |
Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, |
_type |
Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple |
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-healthcare
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.