feat(healthcare): update the api

#### healthcare:v1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.applyAdminConsents (Total Keys: 12) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.applyConsents (Total Keys: 12) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.explainDataAccess (Total Keys: 13) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Consent-enforcement-status (Total Keys: 11) - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Patient-consent-enforcement-status (Total Keys: 16) - schemas.AccessDeterminationLogConfig (Total Keys: 3) - schemas.AdminConsents (Total Keys: 4) - schemas.ApplyAdminConsentsErrorDetail (Total Keys: 6) - schemas.ApplyAdminConsentsRequest (Total Keys: 4) - schemas.ApplyAdminConsentsResponse (Total Keys: 8) - schemas.ApplyConsentsRequest (Total Keys: 5) - schemas.ApplyConsentsResponse (Total Keys: 10) - schemas.ConsentAccessorScope (Total Keys: 5) - schemas.ConsentConfig (Total Keys: 9) - schemas.ConsentErrors (Total Keys: 4) - schemas.ConsentHeaderHandling (Total Keys: 3) - schemas.ExplainDataAccessConsentInfo (Total Keys: 13) - schemas.ExplainDataAccessConsentScope (Total Keys: 8) - schemas.ExplainDataAccessResponse (Total Keys: 5) - schemas.FhirStore.properties.consentConfig.$ref (Total Keys: 1) - schemas.PatientScope (Total Keys: 4) - schemas.TimeRange (Total Keys: 4) #### healthcare:v1beta1 The following keys were added: - schemas.GoogleCloudHealthcareV1beta1FhirBigQueryDestination.properties.changeDataCaptureConfig.$ref (Total Keys: 1) - schemas.GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig (Total Keys: 3)
googleapis · Dec 17, 2024 · 421a937 · 421a937
1 parent 8d1e066
commit 421a937
Show file tree

Hide file tree

Showing 5 changed files with 885 additions and 2 deletions.
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html
@@ -86,6 +86,12 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#Binary_vread">Binary_vread(name, x__xgafv=None)</a></code></p>
 <p class="firstline">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.</p>
+<p class="toc_element">
+  <code><a href="#Consent_enforcement_status">Consent_enforcement_status(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.</p>
+<p class="toc_element">
+  <code><a href="#Patient_consent_enforcement_status">Patient_consent_enforcement_status(name, x__xgafv=None, x_count=None, x_page_token=None)</a></code></p>
+<p class="firstline">Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2.</p>
 <p class="toc_element">
   <code><a href="#Patient_everything">Patient_everything(name, end=None, start=None, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None)</a></code></p>
 <p class="firstline">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).</p>
@@ -267,6 +273,58 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="Consent_enforcement_status">Consent_enforcement_status(name, x__xgafv=None)</code>
+  <pre>Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.
+
+Args:
+  name: string, Required. The name of the consent resource to find enforcement status, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{consent_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
+  &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
+  &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}</pre>
+</div>
+
+<div class="method">
+    <code class="details" id="Patient_consent_enforcement_status">Patient_consent_enforcement_status(name, x__xgafv=None, x_count=None, x_page_token=None)</code>
+  <pre>Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2.
+
+Args:
+  name: string, Required. The name of the patient to find enforcement statuses, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_count: integer, Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000.
+  x_page_token: string, Optional. Used to retrieve the first, previous, next, or last page of consent enforcement statuses when using pagination. Value should be set to the value of `_page_token` set in next or previous page links&#x27; URLs. Next and previous page are returned in the response bundle&#x27;s links field, where `link.relation` is &quot;previous&quot; or &quot;next&quot;. Omit `_page_token` if no previous request has been made.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
+  &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
+  &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="Patient_everything">Patient_everything(name, end=None, start=None, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None)</code>
   <pre>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).