Quickstart using the Cloud Console

This page shows you how to use the Cloud Healthcare API with the Google Cloud Console to complete the following tasks:

  1. Create a Cloud Healthcare API dataset.
  2. Create one of the following data stores inside the dataset:
    • Digital Imaging and Communications in Medicine (DICOM) store
    • Fast Healthcare Interoperability Resources (FHIR) store
    • Health Level Seven International Version 2 (HL7v2) store
  3. Store and inspect a particular type of medical data in the DICOM or FHIR store.

Before you begin

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  4. Enable the Cloud Healthcare API.

    Enable the API

Create a dataset

Datasets hold healthcare data in Google Cloud. To use the Cloud Healthcare API, you must create at least one dataset.

To create a dataset, complete the following steps:

  1. In the Cloud Console, go to the Datasets page.

    Go to the Datasets page

  2. Click Create dataset.
  3. In the Name field, enter an identifier for the dataset. The dataset ID must have the following:
    • A unique ID in its location
    • A Unicode string from 1-256 characters consisting of the following:
      • Numbers
      • Letters
      • Underscores
      • Dashes
      • Periods
  4. In the Region field, type or select the location where the dataset permanently resides, and then click Create.

The new dataset appears in the list of datasets.

To complete this quickstart, choose from one of the following sections:

Store and view DICOM instances

This section shows how to complete the following tasks:

  1. Create a DICOM store.
  2. Import a DICOM instance from Cloud Storage into the DICOM store.

The Cloud Healthcare API implements the DICOMweb standard to store and access medical imaging data. The Cloud Console does not support DICOMweb transactions, such as viewing or retrieving instances.

Create a DICOM store

  1. DICOM stores exist inside datasets and hold DICOM instances. To create a DICOM store, complete the following steps:

    1. In the Cloud Console, go to the Datasets page.

      Go to the Datasets page

    2. Open the dataset where you want to create the DICOM store.

    3. Click Create data store. The Create data store page opens.

    4. In the Type menu, select DICOM.

    5. In the ID field, enter an identifier for the DICOM store. The DICOM store ID must have the following:

      • A unique ID in its parent dataset
      • A Unicode string from 1 through 256 characters consisting of the following:
        • Numbers
        • Letters
        • Underscores
        • Dashes
        • Periods
    6. Click Create.

    The new DICOM store appears in the list of data stores inside the dataset.

Import a DICOM instance

  1. Sample DICOM data is available in the gs://gcs-public-data--healthcare-nih-chest-xray Cloud Storage bucket. To import a DICOM instance from the bucket into your DICOM store, complete the following steps:

    1. In the list of data stores in your dataset, find the DICOM store that you created, and then select the Actions menu.
    2. In the Actions drop-down list, select Import.
    3. In the Import to DICOM store page, select the Advanced options menu, and then select Override Cloud Storage path.
    4. In the Location field under the Advanced options menu, enter the following location of the DICOM instance you are importing:

      gs://gcs-public-data--healthcare-nih-chest-xray/dicom/00000001_000.dcm
      
    5. Click Import.

    6. To track the status of the import, click the Operations tab, and then click the operation's ID.

      If you encounter any errors, click Actions, and then click View details in Cloud Logging.

Now that you've stored a DICOM instance in the Cloud Healthcare API, continue to What's next for information on next steps, such as how to search for or retrieve DICOM images.

Store and view FHIR resources

This section shows how to complete the following tasks:

  1. Create a FHIR store.
  2. Import a FHIR resource from Cloud Storage into the FHIR store.
  3. View information about the resource using the FHIR viewer.

The Cloud Healthcare API implements the FHIR specification standard to store and access FHIR data. The Cloud Console does not support certain FHIR API methods, such as creating or deleting FHIR resources, but you can use the FHIR viewer to view the contents of FHIR resources.

Create a FHIR store

  1. FHIR stores exist inside datasets and hold FHIR resources. To create a FHIR store, complete the following steps:

    1. In the Cloud Console, go to the Datasets page.

      Go to the Datasets page

    2. Open the dataset where you want to create the FHIR store.

    3. Click Create data store. The Create data store page opens.

    4. In the Type menu, select FHIR.

    5. In the ID field, enter an identifier for the FHIR store. The FHIR store ID must have the following:

      • A unique ID in its parent dataset
      • A Unicode string from 1 through 256 characters consisting of the following:
        • Numbers
        • Letters
        • Underscores
        • Dashes
        • Periods
    6. In the FHIR store configuration section, select R4.

    7. Click Create.

    The new FHIR store appears in the list of data stores inside the dataset.

Import FHIR resources

  1. Sample FHIR data is available in the gs://gcp-public-data--synthea-fhir-data-10-patients Cloud Storage bucket. The bucket contains a directory, fhir_r4_ndjson/, which contains several types of FHIR resources. To import the FHIR resources from the bucket into your FHIR store, complete the following steps:

    1. In the list of data stores in your dataset, find the FHIR store that you created, and then select the Actions menu.
    2. In the Actions drop-down list, select Import.
    3. In the Import to FHIR store page, select the Advanced options menu, and then select Override Cloud Storage path.
    4. In the Location field under the Advanced options menu, enter the following location of the FHIR resources you are importing:

      gs://gcp-public-data--synthea-fhir-data-10-patients/fhir_r4_ndjson/*.ndjson
      
    5. In the FHIR import settings section, select Resource.

    6. Click Import.

    7. To track the status of the import, click the Operations tab, and then click the operation's ID.

      If you encounter any errors, click Actions, and then click View details in Cloud Logging.

View FHIR resource contents

To view the contents of the Patient resources that you imported from the Cloud Storage bucket, complete the following steps:

  1. In the Cloud Console, go to the FHIR viewer page.

    Go to the FHIR viewer

  2. In the FHIR Store drop-down list, select the dataset containing your FHIR store, and then select the FHIR store.

  3. Click the Resource Type field. In the Properties drop-down list that appears, select Resource Type, and then enter Patient.

  4. Click Patient in the Resource Type list.

  5. Select one of the Patient resources that appears. To view more information about the Patient, click the Elements tab, or click the JSON tab to view the Patient's details in JSON format.

Now that you've stored and viewed a FHIR resource in the Cloud Healthcare API, continue to What's next for information on next steps.

Create an HL7v2 store

This section shows how to create an HL7v2 store. The Cloud Healthcare API HL7v2 implementation in the Cloud Console doesn't currently support working with HL7v2 messages. After creating the HL7v2 store, continue to Creating and managing HL7v2 messages to create or ingest HL7v2 messages.

The HL7v2 implementation in the Cloud Healthcare API aligns with the HL7v2 standard.

HL7v2 stores exist inside datasets and hold HL7v2 messages. To create an HL7v2 store, complete the following steps:

  1. In the Cloud Console, go to the Datasets page.

    Go to the Datasets page

  2. Open the dataset where you want to create the HL7v2 store.

  3. Click Create data store. The Create data store page opens.

  4. In the Type menu, select HL7v2.

  5. In the ID field, enter an identifier for the HL7v2 store. The HL7v2 store ID must have the following:

    • A unique ID in its parent dataset
    • A Unicode string from 1 through 256 characters consisting of the following:
      • Numbers
      • Letters
      • Underscores
      • Dashes
      • Periods
  6. Click Create.

The new HL7v2 store appears in the list of data stores inside the dataset.

Now that you've created an HL7v2 store, continue to What's next for information on next steps, such as how to ingest and view HL7v2 messages.

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 and data store.

Delete the project

  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 and data store

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

To delete a dataset:

  1. In the Cloud Console, go to the Datasets page.

    Go to the Datasets page

  2. Select the dataset to delete.
  3. Click Delete, type the identifier for the dataset to confirm, and then click Delete.

How did it go?

What's next

See the following pages for general information on the Cloud Healthcare API and how to perform tasks using the REST API and the gcloud command-line tool:

DICOM

Continue to the DICOM guide to review the following topics:

See the DICOM conformance statement for information on how the Cloud Healthcare API implements the DICOMweb standard.

FHIR

Continue to the FHIR guide to review the following topics:

See the FHIR conformance statement for information on how the Cloud Healthcare API implements the FHIR standard.

HL7v2

Continue to the HL7v2 guide to review the following topics: