|
3341 | 3341 | "resources": { |
3342 | 3342 | "fhir": { |
3343 | 3343 | "methods": { |
| 3344 | + "Binary-create": { |
| 3345 | + "description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", |
| 3346 | + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary", |
| 3347 | + "httpMethod": "POST", |
| 3348 | + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create", |
| 3349 | + "parameterOrder": [ |
| 3350 | + "parent" |
| 3351 | + ], |
| 3352 | + "parameters": { |
| 3353 | + "parent": { |
| 3354 | + "description": "Required. The name of the FHIR store this resource belongs to.", |
| 3355 | + "location": "path", |
| 3356 | + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", |
| 3357 | + "required": true, |
| 3358 | + "type": "string" |
| 3359 | + } |
| 3360 | + }, |
| 3361 | + "path": "v1/{+parent}/fhir/Binary", |
| 3362 | + "request": { |
| 3363 | + "$ref": "HttpBody" |
| 3364 | + }, |
| 3365 | + "response": { |
| 3366 | + "$ref": "HttpBody" |
| 3367 | + }, |
| 3368 | + "scopes": [ |
| 3369 | + "https://www.googleapis.com/auth/cloud-healthcare", |
| 3370 | + "https://www.googleapis.com/auth/cloud-platform" |
| 3371 | + ] |
| 3372 | + }, |
| 3373 | + "Binary-read": { |
| 3374 | + "description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", |
| 3375 | + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", |
| 3376 | + "httpMethod": "GET", |
| 3377 | + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read", |
| 3378 | + "parameterOrder": [ |
| 3379 | + "name" |
| 3380 | + ], |
| 3381 | + "parameters": { |
| 3382 | + "name": { |
| 3383 | + "description": "Required. The name of the Binary resource to retrieve.", |
| 3384 | + "location": "path", |
| 3385 | + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", |
| 3386 | + "required": true, |
| 3387 | + "type": "string" |
| 3388 | + } |
| 3389 | + }, |
| 3390 | + "path": "v1/{+name}", |
| 3391 | + "response": { |
| 3392 | + "$ref": "HttpBody" |
| 3393 | + }, |
| 3394 | + "scopes": [ |
| 3395 | + "https://www.googleapis.com/auth/cloud-healthcare", |
| 3396 | + "https://www.googleapis.com/auth/cloud-platform" |
| 3397 | + ] |
| 3398 | + }, |
| 3399 | + "Binary-update": { |
| 3400 | + "description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", |
| 3401 | + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", |
| 3402 | + "httpMethod": "PUT", |
| 3403 | + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update", |
| 3404 | + "parameterOrder": [ |
| 3405 | + "name" |
| 3406 | + ], |
| 3407 | + "parameters": { |
| 3408 | + "name": { |
| 3409 | + "description": "Required. The name of the resource to update.", |
| 3410 | + "location": "path", |
| 3411 | + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", |
| 3412 | + "required": true, |
| 3413 | + "type": "string" |
| 3414 | + } |
| 3415 | + }, |
| 3416 | + "path": "v1/{+name}", |
| 3417 | + "request": { |
| 3418 | + "$ref": "HttpBody" |
| 3419 | + }, |
| 3420 | + "response": { |
| 3421 | + "$ref": "HttpBody" |
| 3422 | + }, |
| 3423 | + "scopes": [ |
| 3424 | + "https://www.googleapis.com/auth/cloud-healthcare", |
| 3425 | + "https://www.googleapis.com/auth/cloud-platform" |
| 3426 | + ] |
| 3427 | + }, |
| 3428 | + "Binary-vread": { |
| 3429 | + "description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", |
| 3430 | + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}", |
| 3431 | + "httpMethod": "GET", |
| 3432 | + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread", |
| 3433 | + "parameterOrder": [ |
| 3434 | + "name" |
| 3435 | + ], |
| 3436 | + "parameters": { |
| 3437 | + "name": { |
| 3438 | + "description": "Required. The name of the Binary resource version to retrieve.", |
| 3439 | + "location": "path", |
| 3440 | + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$", |
| 3441 | + "required": true, |
| 3442 | + "type": "string" |
| 3443 | + } |
| 3444 | + }, |
| 3445 | + "path": "v1/{+name}", |
| 3446 | + "response": { |
| 3447 | + "$ref": "HttpBody" |
| 3448 | + }, |
| 3449 | + "scopes": [ |
| 3450 | + "https://www.googleapis.com/auth/cloud-healthcare", |
| 3451 | + "https://www.googleapis.com/auth/cloud-platform" |
| 3452 | + ] |
| 3453 | + }, |
3344 | 3454 | "Patient-everything": { |
3345 | 3455 | "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). 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 patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", |
3346 | 3456 | "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", |
|
4673 | 4783 | } |
4674 | 4784 | } |
4675 | 4785 | }, |
4676 | | - "revision": "20240819", |
| 4786 | + "revision": "20240822", |
4677 | 4787 | "rootUrl": "https://healthcare.googleapis.com/", |
4678 | 4788 | "schemas": { |
4679 | 4789 | "ActivateConsentRequest": { |
|
0 commit comments