happygapi.healthcare.projects — happygapi 0.4.8

Cloud Healthcare API: projects. Manage, store, and access healthcare data in Google Cloud Platform. See: https://cloud.google.com/healthcareapi/reference/rest/v1/projects

locations-datasets-consentStores-attributeDefinitions-create$ clj

(locations-datasets-consentStores-attributeDefinitions-create$ auth
                                                               parameters
                                                               body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/attributeDefinitions/create

Required parameters: parent

Optional parameters: attributeDefinitionId

Body:

{:consentDefaultValues [string], :name string, :category string, :description string, :dataMappingDefaultValue string, :allowedValues [string]}

Creates a new Attribute definition in the parent consent store.

locations-datasets-consentStores-attributeDefinitions-delete$ clj

(locations-datasets-consentStores-attributeDefinitions-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/attributeDefinitions/delete

Required parameters: name

Optional parameters: none

Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.

locations-datasets-consentStores-attributeDefinitions-get$ clj

(locations-datasets-consentStores-attributeDefinitions-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/attributeDefinitions/get

Required parameters: name

Optional parameters: none

Gets the specified Attribute definition.

locations-datasets-consentStores-attributeDefinitions-list$ clj

(locations-datasets-consentStores-attributeDefinitions-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/attributeDefinitions/list

Required parameters: parent

Optional parameters: filter, pageToken, pageSize

Lists the Attribute definitions in the specified consent store.

locations-datasets-consentStores-attributeDefinitions-patch$ clj

(locations-datasets-consentStores-attributeDefinitions-patch$ auth
                                                              parameters
                                                              body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/attributeDefinitions/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:consentDefaultValues [string], :name string, :category string, :description string, :dataMappingDefaultValue string, :allowedValues [string]}

Updates the specified Attribute definition.

locations-datasets-consentStores-checkDataAccess$ clj

(locations-datasets-consentStores-checkDataAccess$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/checkDataAccess

Required parameters: consentStore

Optional parameters: none

Body:

{:dataId string, :consentList {:consents [string]}, :requestAttributes {}, :responseView string}

Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

locations-datasets-consentStores-consentArtifacts-create$ clj

(locations-datasets-consentStores-consentArtifacts-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consentArtifacts/create

Required parameters: parent

Optional parameters: none

Body:

{:userSignature {:userId string, :signatureTime string, :image Image, :metadata {}}, :metadata {}, :consentContentVersion string, :guardianSignature {:userId string, :signatureTime string, :image Image, :metadata {}}, :witnessSignature {:userId string, :signatureTime string, :image Image, :metadata {}}, :name string, :consentContentScreenshots [{:gcsUri string, :rawBytes string}], :userId string}

Creates a new Consent artifact in the parent consent store.

locations-datasets-consentStores-consentArtifacts-delete$ clj

(locations-datasets-consentStores-consentArtifacts-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consentArtifacts/delete

Required parameters: name

Optional parameters: none

Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

locations-datasets-consentStores-consentArtifacts-get$ clj

(locations-datasets-consentStores-consentArtifacts-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consentArtifacts/get

Required parameters: name

Optional parameters: none

Gets the specified Consent artifact.

locations-datasets-consentStores-consentArtifacts-list$ clj

(locations-datasets-consentStores-consentArtifacts-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consentArtifacts/list

Required parameters: parent

Optional parameters: pageToken, pageSize, filter

Lists the Consent artifacts in the specified consent store.

locations-datasets-consentStores-consents-activate$ clj

(locations-datasets-consentStores-consents-activate$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/activate

Required parameters: name

Optional parameters: none

Body:

{:consentArtifact string, :ttl string, :expireTime string}

Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified Consent is in the ACTIVE state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

locations-datasets-consentStores-consents-create$ clj

(locations-datasets-consentStores-consents-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/create

Required parameters: parent

Optional parameters: none

Body:

{:policies [{:authorizationRule Expr, :resourceAttributes [Attribute]}], :revisionCreateTime string, :name string, :revisionId string, :state string, :ttl string, :consentArtifact string, :userId string, :expireTime string, :metadata {}}

Creates a new Consent in the parent consent store.

locations-datasets-consentStores-consents-delete$ clj

(locations-datasets-consentStores-consents-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/delete

Required parameters: name

Optional parameters: none

Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact.

locations-datasets-consentStores-consents-deleteRevision$ clj

(locations-datasets-consentStores-consents-deleteRevision$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/deleteRevision

Required parameters: name

Optional parameters: none

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

locations-datasets-consentStores-consents-get$ clj

(locations-datasets-consentStores-consents-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/get

Required parameters: name

Optional parameters: none

Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

locations-datasets-consentStores-consents-list$ clj

(locations-datasets-consentStores-consents-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/list

Required parameters: parent

Optional parameters: filter, pageSize, pageToken

Lists the Consent in the given consent store, returning each Consent's latest revision.

locations-datasets-consentStores-consents-listRevisions$ clj

(locations-datasets-consentStores-consents-listRevisions$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/listRevisions

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists the revisions of the specified Consent in reverse chronological order.

locations-datasets-consentStores-consents-patch$ clj

(locations-datasets-consentStores-consents-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:policies [{:authorizationRule Expr, :resourceAttributes [Attribute]}], :revisionCreateTime string, :name string, :revisionId string, :state string, :ttl string, :consentArtifact string, :userId string, :expireTime string, :metadata {}}

Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

locations-datasets-consentStores-consents-reject$ clj

(locations-datasets-consentStores-consents-reject$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/reject

Required parameters: name

Optional parameters: none

Body:

{:consentArtifact string}

Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the ACTIVE or REVOKED state.

locations-datasets-consentStores-consents-revoke$ clj

(locations-datasets-consentStores-consents-revoke$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/consents/revoke

Required parameters: name

Optional parameters: none

Body:

{:consentArtifact string}

Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified Consent is in the REVOKED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in DRAFT or REJECTED state.

locations-datasets-consentStores-create$ clj

(locations-datasets-consentStores-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/create

Required parameters: parent

Optional parameters: consentStoreId

Body:

{:enableConsentCreateOnUpdate boolean, :defaultConsentTtl string, :name string, :labels {}}

Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

locations-datasets-consentStores-delete$ clj

(locations-datasets-consentStores-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/delete

Required parameters: name

Optional parameters: none

Deletes the specified consent store and removes all the consent store's data.

locations-datasets-consentStores-evaluateUserConsents$ clj

(locations-datasets-consentStores-evaluateUserConsents$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/evaluateUserConsents

Required parameters: consentStore

Optional parameters: none

Body:

{:pageSize integer, :userId string, :responseView string, :consentList {:consents [string]}, :requestAttributes {}, :pageToken string, :resourceAttributes {}}

Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

locations-datasets-consentStores-get$ clj

(locations-datasets-consentStores-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/get

Required parameters: name

Optional parameters: none

Gets the specified consent store.

locations-datasets-consentStores-getIamPolicy$ clj

(locations-datasets-consentStores-getIamPolicy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-datasets-consentStores-list$ clj

(locations-datasets-consentStores-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/list

Required parameters: parent

Optional parameters: filter, pageSize, pageToken

Lists the consent stores in the specified dataset.

locations-datasets-consentStores-patch$ clj

(locations-datasets-consentStores-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:enableConsentCreateOnUpdate boolean, :defaultConsentTtl string, :name string, :labels {}}

Updates the specified consent store.

locations-datasets-consentStores-queryAccessibleData$ clj

(locations-datasets-consentStores-queryAccessibleData$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/queryAccessibleData

Required parameters: consentStore

Optional parameters: none

Body:

{:gcsDestination {:uriPrefix string}, :requestAttributes {}, :resourceAttributes {}}

Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). For example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent store projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP"

locations-datasets-consentStores-setIamPolicy$ clj

(locations-datasets-consentStores-setIamPolicy$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:auditConfigs [AuditConfig], :etag string, :version integer, :bindings [Binding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-datasets-consentStores-testIamPermissions$ clj

(locations-datasets-consentStores-testIamPermissions$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-datasets-consentStores-userDataMappings-archive$ clj

(locations-datasets-consentStores-userDataMappings-archive$ auth
                                                            parameters
                                                            body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/archive

Required parameters: name

Optional parameters: none

Body:

{}

Archives the specified User data mapping.

locations-datasets-consentStores-userDataMappings-create$ clj

(locations-datasets-consentStores-userDataMappings-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :archiveTime string, :resourceAttributes [{:attributeDefinitionId string, :values [string]}], :dataId string, :userId string, :archived boolean}

Creates a new User data mapping in the parent consent store.

locations-datasets-consentStores-userDataMappings-delete$ clj

(locations-datasets-consentStores-userDataMappings-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/delete

Required parameters: name

Optional parameters: none

Deletes the specified User data mapping.

locations-datasets-consentStores-userDataMappings-get$ clj

(locations-datasets-consentStores-userDataMappings-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/get

Required parameters: name

Optional parameters: none

Gets the specified User data mapping.

locations-datasets-consentStores-userDataMappings-list$ clj

(locations-datasets-consentStores-userDataMappings-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/list

Required parameters: parent

Optional parameters: pageToken, filter, pageSize

Lists the User data mappings in the specified consent store.

locations-datasets-consentStores-userDataMappings-patch$ clj

(locations-datasets-consentStores-userDataMappings-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/consentStores/userDataMappings/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :archiveTime string, :resourceAttributes [{:attributeDefinitionId string, :values [string]}], :dataId string, :userId string, :archived boolean}

Updates the specified User data mapping.

locations-datasets-create$ clj

(locations-datasets-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/create

Required parameters: parent

Optional parameters: datasetId

Body:

{:timeZone string, :name string}

Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is OperationMetadata.

locations-datasets-deidentify$ clj

(locations-datasets-deidentify$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/deidentify

Required parameters: sourceDataset

Optional parameters: none

Body:

{:config {:image ImageConfig, :fhir FhirConfig, :dicom DicomConfig, :text TextConfig}, :destinationDataset string}

Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.

locations-datasets-delete$ clj

(locations-datasets-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/delete

Required parameters: name

Optional parameters: none

Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

locations-datasets-dicomStores-create$ clj

(locations-datasets-dicomStores-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/create

Required parameters: parent

Optional parameters: dicomStoreId

Body:

{:notificationConfig {:pubsubTopic string}, :name string, :labels {}}

Creates a new DICOM store within the parent dataset.

locations-datasets-dicomStores-deidentify$ clj

(locations-datasets-dicomStores-deidentify$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/deidentify

Required parameters: sourceStore

Optional parameters: none

Body:

{:config {:image ImageConfig, :fhir FhirConfig, :dicom DicomConfig, :text TextConfig}, :filterConfig {:resourcePathsGcsUri string}, :destinationStore string}

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

locations-datasets-dicomStores-delete$ clj

(locations-datasets-dicomStores-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/delete

Required parameters: name

Optional parameters: none

Deletes the specified DICOM store and removes all images that are contained within it.

locations-datasets-dicomStores-export$ clj

(locations-datasets-dicomStores-export$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/export

Required parameters: name

Optional parameters: none

Body:

{:bigqueryDestination {:force boolean, :tableUri string}, :gcsDestination {:uriPrefix string, :mimeType string}}

Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

locations-datasets-dicomStores-get$ clj

(locations-datasets-dicomStores-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/get

Required parameters: name

Optional parameters: none

Gets the specified DICOM store.

locations-datasets-dicomStores-getIamPolicy$ clj

(locations-datasets-dicomStores-getIamPolicy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-datasets-dicomStores-import$ clj

(locations-datasets-dicomStores-import$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/import

Required parameters: name

Optional parameters: none

Body:

{:gcsSource {:uri string}}

Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

locations-datasets-dicomStores-list$ clj

(locations-datasets-dicomStores-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/list

Required parameters: parent

Optional parameters: pageToken, filter, pageSize

Lists the DICOM stores in the given dataset.

locations-datasets-dicomStores-patch$ clj

(locations-datasets-dicomStores-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:notificationConfig {:pubsubTopic string}, :name string, :labels {}}

Updates the specified DICOM store.

locations-datasets-dicomStores-searchForInstances$ clj

(locations-datasets-dicomStores-searchForInstances$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/searchForInstances

Required parameters: parent, dicomWebPath

Optional parameters: none

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-searchForSeries$ clj

(locations-datasets-dicomStores-searchForSeries$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/searchForSeries

Required parameters: dicomWebPath, parent

Optional parameters: none

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-searchForStudies$ clj

(locations-datasets-dicomStores-searchForStudies$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/searchForStudies

Required parameters: dicomWebPath, parent

Optional parameters: none

SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-setIamPolicy$ clj

(locations-datasets-dicomStores-setIamPolicy$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:auditConfigs [AuditConfig], :etag string, :version integer, :bindings [Binding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-datasets-dicomStores-storeInstances$ clj

(locations-datasets-dicomStores-storeInstances$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/storeInstances

Required parameters: dicomWebPath, parent

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data.

locations-datasets-dicomStores-studies-delete$ clj

(locations-datasets-dicomStores-studies-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/delete

Required parameters: parent, dicomWebPath

Optional parameters: none

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Deleting a study, series, or instance.

locations-datasets-dicomStores-studies-retrieveMetadata$ clj

(locations-datasets-dicomStores-studies-retrieveMetadata$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/retrieveMetadata

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieving metadata.

locations-datasets-dicomStores-studies-retrieveStudy$ clj

(locations-datasets-dicomStores-studies-retrieveStudy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/retrieveStudy

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieving DICOM data.

locations-datasets-dicomStores-studies-searchForInstances$ clj

(locations-datasets-dicomStores-studies-searchForInstances$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/searchForInstances

Required parameters: parent, dicomWebPath

Optional parameters: none

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-studies-searchForSeries$ clj

(locations-datasets-dicomStores-studies-searchForSeries$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/searchForSeries

Required parameters: parent, dicomWebPath

Optional parameters: none

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-studies-series-delete$ clj

(locations-datasets-dicomStores-studies-series-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/delete

Required parameters: parent, dicomWebPath

Optional parameters: none

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Deleting a study, series, or instance.

locations-datasets-dicomStores-studies-series-instances-delete$ clj

(locations-datasets-dicomStores-studies-series-instances-delete$ auth
                                                                 parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/delete

Required parameters: parent, dicomWebPath

Optional parameters: none

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Deleting a study, series, or instance.

locations-datasets-dicomStores-studies-series-instances-frames-retrieveFrames$ clj

(locations-datasets-dicomStores-studies-series-instances-frames-retrieveFrames$
  auth
  parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/frames/retrieveFrames

Required parameters: dicomWebPath, parent

Optional parameters: none

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieving DICOM data.

locations-datasets-dicomStores-studies-series-instances-frames-retrieveRendered$ clj

(locations-datasets-dicomStores-studies-series-instances-frames-retrieveRendered$
  auth
  parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/frames/retrieveRendered

Required parameters: dicomWebPath, parent

Optional parameters: none

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieving consumer image formats.

locations-datasets-dicomStores-studies-series-instances-retrieveInstance$ clj

(locations-datasets-dicomStores-studies-series-instances-retrieveInstance$
  auth
  parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/retrieveInstance

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieving an instance.

locations-datasets-dicomStores-studies-series-instances-retrieveMetadata$ clj

(locations-datasets-dicomStores-studies-series-instances-retrieveMetadata$
  auth
  parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/retrieveMetadata

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieving metadata.

locations-datasets-dicomStores-studies-series-instances-retrieveRendered$ clj

(locations-datasets-dicomStores-studies-series-instances-retrieveRendered$
  auth
  parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/instances/retrieveRendered

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieving consumer image formats.

locations-datasets-dicomStores-studies-series-retrieveMetadata$ clj

(locations-datasets-dicomStores-studies-series-retrieveMetadata$ auth
                                                                 parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/retrieveMetadata

Required parameters: parent, dicomWebPath

Optional parameters: none

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieving metadata.

locations-datasets-dicomStores-studies-series-retrieveSeries$ clj

(locations-datasets-dicomStores-studies-series-retrieveSeries$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/retrieveSeries

Required parameters: dicomWebPath, parent

Optional parameters: none

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieving DICOM data.

locations-datasets-dicomStores-studies-series-searchForInstances$ clj

(locations-datasets-dicomStores-studies-series-searchForInstances$ auth
                                                                   parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/series/searchForInstances

Required parameters: dicomWebPath, parent

Optional parameters: none

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames.

locations-datasets-dicomStores-studies-storeInstances$ clj

(locations-datasets-dicomStores-studies-storeInstances$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/studies/storeInstances

Required parameters: dicomWebPath, parent

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data.

locations-datasets-dicomStores-testIamPermissions$ clj

(locations-datasets-dicomStores-testIamPermissions$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/dicomStores/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-datasets-fhirStores-create$ clj

(locations-datasets-fhirStores-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/create

Required parameters: parent

Optional parameters: fhirStoreId

Body:

{:labels {}, :streamConfigs [{:resourceTypes [string], :bigqueryDestination GoogleCloudHealthcareV1FhirBigQueryDestination}], :name string, :enableUpdateCreate boolean, :notificationConfig {:pubsubTopic string}, :defaultSearchHandlingStrict boolean, :disableResourceVersioning boolean, :disableReferentialIntegrity boolean, :version string}

Creates a new FHIR store within the parent dataset.

locations-datasets-fhirStores-deidentify$ clj

(locations-datasets-fhirStores-deidentify$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/deidentify

Required parameters: sourceStore

Optional parameters: none

Body:

{:config {:image ImageConfig, :fhir FhirConfig, :dicom DicomConfig, :text TextConfig}, :destinationStore string, :resourceFilter {:resources Resources}}

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

locations-datasets-fhirStores-delete$ clj

(locations-datasets-fhirStores-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/delete

Required parameters: name

Optional parameters: none

Deletes the specified FHIR store and removes all resources within it.

locations-datasets-fhirStores-export$ clj

(locations-datasets-fhirStores-export$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/export

Required parameters: name

Optional parameters: none

Body:

{:bigqueryDestination {:writeDisposition string, :schemaConfig SchemaConfig, :datasetUri string, :force boolean}, :gcsDestination {:uriPrefix string}}

Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

locations-datasets-fhirStores-fhir-capabilities$ clj

(locations-datasets-fhirStores-fhir-capabilities$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/capabilities

Required parameters: name

Optional parameters: none

Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a CapabilityStatement resource.

locations-datasets-fhirStores-fhir-create$ clj

(locations-datasets-fhirStores-fhir-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/create

Required parameters: type, parent

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. 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. For samples that show how to call create, see Creating a FHIR resource.

locations-datasets-fhirStores-fhir-delete$ clj

(locations-datasets-fhirStores-fhir-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/delete

Required parameters: name

Optional parameters: none

Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2, STU3, R4). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call delete, see Deleting a FHIR resource.

locations-datasets-fhirStores-fhir-executeBundle$ clj

(locations-datasets-fhirStores-fhir-executeBundle$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/executeBundle

Required parameters: parent

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4). Supports all interactions within a bundle, except search. This method accepts Bundles of type batch and transaction, processing them according to the batch processing rules (DSTU2, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). The request body must contain a JSON-encoded FHIR Bundle resource, and the request headers must contain Content-Type: application/fhir+json. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a Bundle resource of type batch-response or transaction-response containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will 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. For samples that show how to call executeBundle, see Managing FHIR resources using FHIR bundles.

locations-datasets-fhirStores-fhir-history$ clj

(locations-datasets-fhirStores-fhir-history$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/history

Required parameters: name

Optional parameters: _page_token, _since, _count, _at

Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle resource of type history, containing the version history sorted from most recent to oldest versions. 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. For samples that show how to call history, see Listing FHIR resource versions.

locations-datasets-fhirStores-fhir-patch$ clj

(locations-datasets-fhirStores-fhir-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/patch

Required parameters: name

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

Updates part of an existing resource by applying the operations specified in a JSON Patch document. Implements the FHIR standard patch interaction (STU3, R4). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain Content-Type: application/json-patch+json. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. 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. For samples that show how to call patch, see Patching a FHIR resource.

locations-datasets-fhirStores-fhir-Patient-everything$ clj

(locations-datasets-fhirStores-fhir-Patient-everything$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/Patient-everything

Required parameters: name

Optional parameters: _type, end, _count, start, _page_token, _since

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, 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 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, STU3, R4), 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.

locations-datasets-fhirStores-fhir-read$ clj

(locations-datasets-fhirStores-fhir-read$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/read

Required parameters: name

Optional parameters: none

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) specified by supplying an If-Modified-Since header with a date/time value or an If-None-Match header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. 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. For samples that show how to call read, see Getting a FHIR resource.

locations-datasets-fhirStores-fhir-Resource-purge$ clj

(locations-datasets-fhirStores-fhir-Resource-purge$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/Resource-purge

Required parameters: name

Optional parameters: none

Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call Resource-purge, see Deleting historical versions of a FHIR resource.

locations-datasets-fhirStores-fhir-search$ clj

(locations-datasets-fhirStores-fhir-search$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/search

Required parameters: parent

Optional parameters: none

Body:

{:resourceType string}

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four methods of search defined by the specification: * GET [base]?[parameters] to search across all resources. * GET [base]/[type]?[parameters] to search resources of a specified type. * POST [base]/_search?[parameters] as an alternate form having the same semantics as the GET method across all resources. * POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method for the specified type. The GET and POST methods do not support compartment searches. The POST method does not support application/x-www-form-urlencoded search parameters. On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the search. 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 server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below, :[type], :not, and :recurse. Supported search result parameters: _sort, _count, _include, _revinclude, _summary=text, _summary=data, and _elements. The maximum number of search results returned defaults to 100, which can be overridden by the _count parameter up to a maximum limit of 1000. If there are additional results, the returned Bundle contains a link of relation "next", which has a _page_token parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.

locations-datasets-fhirStores-fhir-search-type$ clj

(locations-datasets-fhirStores-fhir-search-type$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/search-type

Required parameters: parent, resourceType

Optional parameters: none

Body:

{:resourceType string}

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four methods of search defined by the specification: * GET [base]?[parameters] to search across all resources. * GET [base]/[type]?[parameters] to search resources of a specified type. * POST [base]/_search?[parameters] as an alternate form having the same semantics as the GET method across all resources. * POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method for the specified type. The GET and POST methods do not support compartment searches. The POST method does not support application/x-www-form-urlencoded search parameters. On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the search. 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 server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below, :[type], :not, and :recurse. Supported search result parameters: _sort, _count, _include, _revinclude, _summary=text, _summary=data, and _elements. The maximum number of search results returned defaults to 100, which can be overridden by the _count parameter up to a maximum limit of 1000. If there are additional results, the returned Bundle contains a link of relation "next", which has a _page_token parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.

locations-datasets-fhirStores-fhir-update$ clj

(locations-datasets-fhirStores-fhir-update$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/update

Required parameters: name

Optional parameters: none

Body:

{:extensions [{}], :data string, :contentType string}

Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). 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. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The resource must contain an id element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. 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. For samples that show how to call update, see Updating a FHIR resource.

locations-datasets-fhirStores-fhir-vread$ clj

(locations-datasets-fhirStores-fhir-vread$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/fhir/vread

Required parameters: name

Optional parameters: none

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of the resource. 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. For samples that show how to call vread, see Retrieving a FHIR resource version.

locations-datasets-fhirStores-get$ clj

(locations-datasets-fhirStores-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/get

Required parameters: name

Optional parameters: none

Gets the configuration of the specified FHIR store.

locations-datasets-fhirStores-getIamPolicy$ clj

(locations-datasets-fhirStores-getIamPolicy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-datasets-fhirStores-import$ clj

(locations-datasets-fhirStores-import$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/import

Required parameters: name

Optional parameters: none

Body:

{:gcsSource {:uri string}, :contentStructure string}

Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. 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 Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the BUNDLE format. When using the BUNDLE format this method ignores the Bundle.type field, except that history bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in Bundle.entry.resource, ignoring Bundle.entry.request. As an example, this allows the import of searchset bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

locations-datasets-fhirStores-list$ clj

(locations-datasets-fhirStores-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/list

Required parameters: parent

Optional parameters: pageToken, filter, pageSize

Lists the FHIR stores in the given dataset.

locations-datasets-fhirStores-patch$ clj

(locations-datasets-fhirStores-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:labels {}, :streamConfigs [{:resourceTypes [string], :bigqueryDestination GoogleCloudHealthcareV1FhirBigQueryDestination}], :name string, :enableUpdateCreate boolean, :notificationConfig {:pubsubTopic string}, :defaultSearchHandlingStrict boolean, :disableResourceVersioning boolean, :disableReferentialIntegrity boolean, :version string}

Updates the configuration of the specified FHIR store.

locations-datasets-fhirStores-setIamPolicy$ clj

(locations-datasets-fhirStores-setIamPolicy$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:auditConfigs [AuditConfig], :etag string, :version integer, :bindings [Binding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-datasets-fhirStores-testIamPermissions$ clj

(locations-datasets-fhirStores-testIamPermissions$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/fhirStores/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-datasets-get$ clj

(locations-datasets-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/get

Required parameters: name

Optional parameters: none

Gets any metadata associated with a dataset.

locations-datasets-getIamPolicy$ clj

(locations-datasets-getIamPolicy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-datasets-hl7V2Stores-create$ clj

(locations-datasets-hl7V2Stores-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/create

Required parameters: parent

Optional parameters: hl7V2StoreId

Body:

{:name string, :labels {}, :parserConfig {:version string, :schema SchemaPackage, :allowNullHeader boolean, :segmentTerminator string}, :rejectDuplicateMessage boolean, :notificationConfigs [{:filter string, :pubsubTopic string}]}

Creates a new HL7v2 store within the parent dataset.

locations-datasets-hl7V2Stores-delete$ clj

(locations-datasets-hl7V2Stores-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/delete

Required parameters: name

Optional parameters: none

Deletes the specified HL7v2 store and removes all messages that it contains.

locations-datasets-hl7V2Stores-get$ clj

(locations-datasets-hl7V2Stores-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/get

Required parameters: name

Optional parameters: none

Gets the specified HL7v2 store.

locations-datasets-hl7V2Stores-getIamPolicy$ clj

(locations-datasets-hl7V2Stores-getIamPolicy$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

locations-datasets-hl7V2Stores-list$ clj

(locations-datasets-hl7V2Stores-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/list

Required parameters: parent

Optional parameters: filter, pageToken, pageSize

Lists the HL7v2 stores in the given dataset.

locations-datasets-hl7V2Stores-messages-create$ clj

(locations-datasets-hl7V2Stores-messages-create$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/create

Required parameters: parent

Optional parameters: none

Body:

{:message {:labels {}, :messageType string, :sendTime string, :name string, :createTime string, :parsedData ParsedData, :sendFacility string, :patientIds [PatientId], :schematizedData SchematizedData, :data string}}

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.

locations-datasets-hl7V2Stores-messages-delete$ clj

(locations-datasets-hl7V2Stores-messages-delete$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/delete

Required parameters: name

Optional parameters: none

Deletes an HL7v2 message.

locations-datasets-hl7V2Stores-messages-get$ clj

(locations-datasets-hl7V2Stores-messages-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/get

Required parameters: name

Optional parameters: view

Gets an HL7v2 message.

locations-datasets-hl7V2Stores-messages-ingest$ clj

(locations-datasets-hl7V2Stores-messages-ingest$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/ingest

Required parameters: parent

Optional parameters: none

Body:

{:message {:labels {}, :messageType string, :sendTime string, :name string, :createTime string, :parsedData ParsedData, :sendFacility string, :patientIds [PatientId], :schematizedData SchematizedData, :data string}}

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (ACK) message. If the method encounters an error, it returns a negative acknowledgment (NACK) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.

locations-datasets-hl7V2Stores-messages-list$ clj

(locations-datasets-hl7V2Stores-messages-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/list

Required parameters: parent

Optional parameters: orderBy, pageToken, pageSize, view, filter

Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.

locations-datasets-hl7V2Stores-messages-patch$ clj

(locations-datasets-hl7V2Stores-messages-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/messages/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:labels {}, :messageType string, :sendTime string, :name string, :createTime string, :parsedData {:segments [Segment]}, :sendFacility string, :patientIds [{:type string, :value string}], :schematizedData {:error string, :data string}, :data string}

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

locations-datasets-hl7V2Stores-patch$ clj

(locations-datasets-hl7V2Stores-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :labels {}, :parserConfig {:version string, :schema SchemaPackage, :allowNullHeader boolean, :segmentTerminator string}, :rejectDuplicateMessage boolean, :notificationConfigs [{:filter string, :pubsubTopic string}]}

Updates the HL7v2 store.

locations-datasets-hl7V2Stores-setIamPolicy$ clj

(locations-datasets-hl7V2Stores-setIamPolicy$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:auditConfigs [AuditConfig], :etag string, :version integer, :bindings [Binding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-datasets-hl7V2Stores-testIamPermissions$ clj

(locations-datasets-hl7V2Stores-testIamPermissions$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/hl7V2Stores/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-datasets-list$ clj

(locations-datasets-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists the health datasets in the current project.

locations-datasets-operations-cancel$ clj

(locations-datasets-operations-cancel$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/operations/cancel

Required parameters: name

Optional parameters: none

Body:

{}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

locations-datasets-operations-get$ clj

(locations-datasets-operations-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

locations-datasets-operations-list$ clj

(locations-datasets-operations-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/operations/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

locations-datasets-patch$ clj

(locations-datasets-patch$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:timeZone string, :name string}

Updates dataset metadata.

locations-datasets-setIamPolicy$ clj

(locations-datasets-setIamPolicy$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:auditConfigs [AuditConfig], :etag string, :version integer, :bindings [Binding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

locations-datasets-testIamPermissions$ clj

(locations-datasets-testIamPermissions$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/datasets/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

locations-get$ clj

(locations-get$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

locations-list$ clj

(locations-list$ auth parameters)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

Lists information about the supported locations for this service.

locations-services-nlp-analyzeEntities$ clj

(locations-services-nlp-analyzeEntities$ auth parameters body)

https://cloud.google.com/healthcareapi/reference/rest/v1/projects/locations/services/nlp/analyzeEntities

Required parameters: nlpService

Optional parameters: none

Body:

{:documentContent string, :licensedVocabularies [string]}

Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.