Quickstart using curl or Windows PowerShell

This page shows you how to create a dataset and a DICOM, FHIR, or HL7v2 store using the Cloud Healthcare API with curl and Windows PowerShell.

Before you begin

1. Sign in to your Google Account.

   If you don't already have one, sign up for a new account.

2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to the project selector page

3. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

4. Set up authentication:

   1. In the Cloud Console, go to the Create service account key page.

      Go to the Create Service Account Key page
   2. From the Service account list, select New service account.
   3. In the Service account name field, enter a name.

   4. From the Role list, select Project > Owner.

      Note: The Role field affects which resources your service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. For more information, see Granting, changing, and revoking access to resources.
   5. Click Create. A JSON file that contains your key downloads to your computer.

5. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your service account key. This variable only applies to your current shell session, so if you open a new session, set the variable again.

   Example: Linux or macOS

   Replace [PATH] with the path of the JSON file that contains your service account key.

   export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

   For example:

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Example: Windows

   Replace [PATH] with the path of the JSON file that contains your service account key.

   With PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

   For example:

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"

   With command prompt:

   set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

6. Enable the Cloud Healthcare API.

   Enable the API

7. Install and initialize the Cloud SDK.

Tip: Need a command prompt? You can use the Google Cloud Shell. The Google Cloud Shell is a command line environment that already includes the Google Cloud SDK, so you don't need to install it. (The Google Cloud SDK also comes preinstalled on Google Compute Engine Virtual Machines.)

Create a dataset

Datasets are the basic containers that hold healthcare data in Google Cloud.

curl

To create a dataset, make a POST request, providing the name of the dataset and an access token. The following sample shows a POST request using curl.

When setting the LOCATION variable, use us-central1, us-west2, europe-west2, europe-west4, europe-west6, northamerica-northeast1, southamerica-east1, asia-east2, asia-northeast1, asia-southeast1, australia-southeast1, or us.

curl -X POST \
    --data "" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets?datasetId=DATASET_ID"

If the request is successful, the server returns the response in JSON format. The response contains an identifier for a long-running operation. Long-running operations are returned when method calls might take a substantial amount of time to complete.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID",
}

The response contains an operation name. To track the status of the operation, you can use the Operation get method:

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"

If the request is successful, the server returns a response with the status of the operation in JSON format. You can tell that the operation finished when the response contains "done": true.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.OperationMetadata",
    "apiMethodName": "google.cloud.healthcare.v1.dataset.DatasetService.CreateDataset",
    "createTime": "CREATE_TIME",
    "endTime": "END_TIME",
    "logsUrl": "https://console.cloud.google.com/logs/viewer/CLOUD_LOGGING_URL"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.dataset.Dataset",
    "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"
  }
}

PowerShell

To create a dataset, make a POST request, providing the name of the dataset and an access token. The following sample shows a POST request using Windows PowerShell.

When setting the LOCATION variable, use us-central1, us-west2, europe-west2, europe-west4, europe-west6, northamerica-northeast1, southamerica-east1, asia-east2, asia-northeast1, asia-southeast1, australia-southeast1, or us.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets?datasetId=DATASET_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format. The response contains an identifier for a long-running operation. Long-running operations are returned when method calls might take a substantial amount of time to complete.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID",
}

The response contains an operation name. To track the status of the operation, you can use the Operation get method:

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID" | Select-Object -Expand Content

If the request is successful, the server returns a response with the status of the operation in JSON format. You can tell that the operation finished when the response contains "done": true.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.OperationMetadata",
    "apiMethodName": "google.cloud.healthcare.v1.dataset.DatasetService.CreateDataset",
    "createTime": "CREATE_TIME",
    "endTime": "END_TIME",
    "logsUrl": "https://console.cloud.google.com/logs/viewer/CLOUD_LOGGING_URL"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.dataset.Dataset",
    "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"
  }
}

Get dataset details

You can view details about the dataset and verify that it was created.

curl

To get details about a dataset, make a GET request and provide the name of the dataset and an access token. The following sample shows a GET request using curl.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"
}

PowerShell

To get details about a dataset, make a GET request and provide the name of the dataset and an access token. The following sample shows a GET request using curl.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"
}

Create and manage DICOM, FHIR, and HL7v2 stores

To complete this quickstart, expand the relevant section:

Creating and managing DICOM stores

Create a DICOM store

DICOM stores exist inside datasets and hold DICOM instances. You can create a DICOM store using the projects.locations.datasets.dicomStores.create method.

curl

To create a DICOM store, make a POST request. Provide the following information in the request:

• The name of the parent dataset
• A name for the DICOM store
• An access token

The DICOM store name must be unique in the DICOM store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure an existing Pub/Sub topic to which the Cloud Healthcare API sends notifications of DICOM store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using curl.

curl -X POST \
    --data "" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores?dicomStoreId=DICOM_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID"
}

PowerShell

To create a DICOM store, make a POST request. Provide the following information in the request:

• the name of the parent dataset
• the name of the DICOM store
• An access token

The DICOM store name must be unique in the DICOM store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure an existing Pub/Sub topic to which the Cloud Healthcare API sends notifications of DICOM store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores?dicomStoreId=DICOM_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID"
}

Get DICOM store details

You can view details about the DICOM store and verify that it was created using the projects.locations.datasets.dicomStores.get method.

curl

To get details about a DICOM store, make a GET request. Provide the following information in the request:

• the name of the parent dataset
• the name of the DICOM store
• an access token

The following sample shows a GET request using curl.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID"
}

If you configured any fields in the DicomStore resource, they also appear in the response.

PowerShell

To get details about a DICOM store, make a GET request. Provide the following information in the request:

• The name of the parent dataset
• The name of the DICOM store
• An access token

The following sample shows a GET request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID"
}

If you configured any fields in the DicomStore resource, they also appear in the response.

Update a DICOM store

You can update a DICOM store store using the projects.locations.datasets.dicomStores.patch method.

The following samples show how to update the Pub/Sub topic and labels for the DICOM store.

curl

To edit a DICOM store, make a PATCH request. Provide the following information in the request:

• The name of the parent dataset
• The name of the DICOM store
• The metadata to update. In this sample, the qualified URI to the Pub/Sub topic and the labels to update as a comma-delimited list of key-value pairs.
• An update mask
• An access token

The following sample shows a PATCH request using curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'notificationConfig': {
        'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC'
      },
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID?updateMask=notificationConfig,labels"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID",
  "notificationConfig": {
    "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC"
  },
  "labels": {
    "LABEL1":"VALUE1","LABEL2":"VALUE2"
  }
}

PowerShell

To edit a DICOM store, make a PATCH request. Provide the following information in the request:

• the name of the parent dataset
• the name of the DICOM store
• The metadata to update. In this example, the qualified URI to the Pub/Sub topic and the labels to update as a comma-delimited list of key-value pairs.
• an update mask
• an access token

The following sample shows a PATCH request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'notificationConfig': {
        'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC'
      },
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/dicom_STORE_ID?updateMask=notificationConfig,labels" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/dicomStores/DICOM_STORE_ID",
  "notificationConfig": {
    "pubsubTopic":
      "projects/PROJECT_ID/topics/PUBSUB_TOPIC"
    },
    "labels": {
      "LABEL1":"VALUE1","LABEL2":"VALUE2"
    }
  }

Creating and managing FHIR stores

Create a FHIR store

FHIR stores exist inside datasets and hold FHIR data. You can create a FHIR store using the projects.locations.datasets.fhirStores.create method.

curl

To create a FHIR store, make a POST request. Provide the following information in the request:

• The name of the parent dataset
• A name for the FHIR store
• The FHIR version of the FHIR store: DSTU2, STU3, or R4
• An access token

The FHIR store name must be unique in the FHIR store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure an existing Pub/Sub topic to which the Cloud Healthcare API sends notifications of FHIR store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using curl.

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'version': 'FHIR_STORE_VERSION'
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores?fhirStoreId=FHIR_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "version": "FHIR_STORE_VERSION"
}

PowerShell

To create a FHIR store, make a POST request. Provide the following information in the request:

• The name of the parent dataset
• A name for the FHIR store
• The FHIR version of the FHIR store: DSTU2, STU3, or R4
• An access token

The FHIR store name must be unique in the FHIR store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure an existing Pub/Sub topic to which the Cloud Healthcare API sends notifications of FHIR store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'version': 'FHIR_STORE_VERSION'
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores?fhirStoreId=FHIR_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "version": "FHIR_STORE_VERSION"
}

Get FHIR store details

You can view details about the FHIR store and verify that it was created using the projects.locations.datasets.fhirStores.get method.

curl

To get details about a FHIR store, make a GET request. Provide the following information in the request:

• The name of the parent dataset
• The name of the FHIR store
• An access token

The following sample shows a GET request using curl.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "version": "FHIR_STORE_VERSION"
}

If you configured any fields in the FhirStore resource, they also appear in the response.

PowerShell

To get details about a FHIR store, make a GET request. Provide the following information in the request:

• The name of the parent dataset
• The name of the FHIR store
• An access token

The following sample shows a GET request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "version": "FHIR_STORE_VERSION"
}

If you configured any fields in the FhirStore resource, they also appear in the response.

Update a FHIR store

You can update a FHIR store store using the projects.locations.datasets.fhirStores.patch method.

The following samples show how to update the Pub/Sub topic and labels for the FHIR store.

curl

To edit a FHIR store, make a PATCH request. Provide the following information in the request:

• The name of the parent dataset
• The name of the FHIR store
• The metadata to update. In this sample, the qualified URI to the Pub/Sub topic and the labels to update as a comma-delimited list of key-value pairs.
• An update mask
• An access token

The following sample shows a PATCH request using curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'notificationConfig': {
        'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC'
      },
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=notificationConfig,labels"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "notificationConfig": {
    "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC"
  },
  "labels": {
    "LABEL1":"VALUE1","LABEL2":"VALUE2"
  },
  "version": "FHIR_STORE_VERSION"
}

PowerShell

To edit a FHIR store, make a PATCH request. Provide the following information in the request:

• The name of the parent dataset
• The name of the FHIR store
• The metadata to update. In this example, the qualified URI to the Pub/Sub topic and the labels to update as a comma-delimited list of key-value pairs.
• An update mask
• An access token

The following sample shows a PATCH request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'notificationConfig': {
        'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC'
      },
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/fhir_STORE_ID?updateMask=notificationConfig,labels" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "notificationConfig": {
    "pubsubTopic":
      "projects/PROJECT_ID/topics/PUBSUB_TOPIC"
    },
    "labels": {
      "LABEL1":"VALUE1","LABEL2":"VALUE2"
    },
    "version": FHIR_STORE_VERSION
  }

Creating and managing HL7v2 stores

Create an HL7v2 store

HL7v2 stores exist inside datasets and hold HL7v2 data. You can create an HL7v2 store using the projects.locations.datasets.hl7V2Stores.create method.

curl

To create an HL7v2 store, make a POST request. Provide the following information in the request:

• The name of the parent dataset
• A name for the HL7v2 store
• An access token

The HL7v2 store name must be unique in the HL7v2 store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure one ore more existing Pub/Sub topics and a filter for the topic to which the Cloud Healthcare API sends notifications of HL7v2 store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using curl.

curl -X POST \
    --data "" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores?hl7V2StoreId=HL7V2_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
}

PowerShell

To create an HL7v2 store, make a POST request. Provide the following information in the request:

• The name of the parent dataset
• A name for the HL7v2 store
• An access token

The HL7v2 store name must be unique in the HL7v2 store's parent dataset. The name can be any Unicode string of 1 to 256 characters consisting of numbers, letters, underscores, dashes, and periods.

You can optionally configure one or more existing Pub/Sub topics and a filter for the topic to which the Cloud Healthcare API sends notifications of HL7v2 store changes. When specifying a Pub/Sub topic, enter the qualified URI to the topic, as shown in the following sample:

projects/PROJECT_ID/topics/PUBSUB_TOPIC

The following sample shows a POST request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores?hl7V2StoreId=HL7V2_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
}

Get HL7v2 store details

You can view details about the HL7v2 store and verify that it was created using the projects.locations.datasets.hl7V2Stores.get method.

curl

To get details about an HL7v2 store, make a GET request. Provide the following information in the request:

• The name of the parent dataset
• The name of the HL7v2 store
• An access token

The following sample shows a GET request using curl.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
}

If you configured any fields in the Hl7V2Store resource, they also appear in the response.

PowerShell

To get details about an HL7v2 store, make a GET request. Provide the following information in the request:

• The name of the parent dataset
• The name of the HL7v2 store
• An access token

The following sample shows a GET request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID"
}

If you configured any fields in the Hl7V2Store resource, they also appear in the response.

Update an HL7v2 store

You can update an HL7v2 store using the projects.locations.datasets.hl7V2Stores.patch method.

The following samples show how to update the Pub/Sub topic, filter, and labels for the HL7v2 store.

curl

To edit an HL7v2 store, make a PATCH request. Provide the following information in the request:

• The name of the parent dataset
• The name of the HL7v2 store
• The metadata to update. In this sample, the qualified URI to the Pub/Sub topic, the topic filter, and the labels to update as a comma-delimited list of key-value pairs.
• An update mask
• An access token

The following sample shows a PATCH request using curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'notificationConfigs': [
        {
          'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC',
          'filter': 'FILTER'
        },
      ],
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID?updateMask=notificationConfigs,labels"

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID",
  "notificationConfigs": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC",
      "filter": "FILTER"
    },
  ],
  "labels": {
    "LABEL1":"VALUE1","LABEL2":"VALUE2"
  }
}

PowerShell

To edit an HL7v2 store, make a PATCH request. Provide the following information in the request:

• The name of the parent dataset
• The name of the HL7v2 store
• The metadata to update. In this example, the qualified URI to the Pub/Sub topic, the topic filter, and the labels to update as a comma-delimited list of key-value pairs.
• An update mask
• An access token

The following sample shows a PATCH request using Windows PowerShell.

$cred = gcloud auth print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'notificationConfigs': [
        {
          'pubsubTopic': 'projects/PROJECT_ID/topics/PUBSUB_TOPIC',
          'filter': 'FILTER'
        },
      ],
      'labels': {
        'LABEL1':'VALUE1','LABEL2':'VALUE2'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/hl7v2_STORE_ID?updateMask=notificationConfigs,labels" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/hl7V2Stores/HL7V2_STORE_ID",
  "notificationConfigs": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/PUBSUB_TOPIC",
      "filter": "FILTER"
    },
  ],
  "labels": {
    "LABEL1":"VALUE1","LABEL2":"VALUE2"
  }
}

Clean up

To avoid incurring charges to your Google Cloud account for the resources used in this tutorial, you can clean up the resources you created on Google Cloud. If you created a new project for this tutorial, follow the steps in Delete the project. Otherwise, follow the steps in Delete the dataset.

Delete the project

Caution: Deleting a project has the following effects:

• Everything in the project is deleted. If you used an existing project for this tutorial, when you delete it, you also delete any other work you've done in the project.
• Custom project IDs are lost. When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as an appspot.com URL, delete selected resources inside the project instead of deleting the whole project.

If you plan to explore multiple tutorials and quickstarts, reusing projects can help you avoid exceeding project quota limits.

1. In the Cloud Console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Delete the dataset

If you no longer need the dataset created in this quickstart, you can delete it. Deleting a dataset permanently deletes the dataset and any FHIR, HL7v2, or DICOM stores it contains.

curl

To delete a dataset, make a DELETE request, providing the name of the dataset and an access token. The following sample shows a DELETE request using curl.

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID"

If the request is successful, the server returns the response in JSON format:

{}

PowerShell

To delete a dataset, make a DELETE request, providing the name of the dataset and an access token. The following sample shows a DELETE request using Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Delete `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID" | Select-Object -Expand Content

If the request is successful, the server returns the response in JSON format:

{}

What's next

• Read an overview of Cloud Healthcare API concepts.
• Use Cloud Healthcare API with Cloud Console.
• Learn how to create and manage data stores for the following healthcare modalities:
  • Digital Imaging and Communications in Medicine (DICOM)
  • Fast Healthcare Interoperability Resources (FHIR)
  • Health Level Seven Version 2.x (HL7v2)