Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 1a16d10

Browse filesBrowse files
engelkeengelke
authored
Regenerated healtcare README.rst files (GoogleCloudPlatform#2132)
1 parent abb1d9a commit 1a16d10
Copy full SHA for 1a16d10

File tree

Expand file treeCollapse file tree

4 files changed

+187
-93
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+187
-93
lines changed

‎healthcare/api-client/datasets/README.rst

Copy file name to clipboardExpand all lines: healthcare/api-client/datasets/README.rst
+25-24Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,6 @@ credentials for applications.
3131
.. _Authentication Getting Started Guide:
3232
https://cloud.google.com/docs/authentication/getting-started
3333

34-
Authentication
35-
++++++++++++++
36-
37-
Authentication for this service is done via an `API Key`_. To obtain an API
38-
Key:
39-
40-
1. Open the `Cloud Platform Console`_
41-
2. Make sure that billing is enabled for your project.
42-
3. From the **Credentials** page, create a new **API Key** or use an existing
43-
one for your project.
44-
45-
.. _API Key:
46-
https://developers.google.com/api-client-library/python/guide/aaa_apikeys
47-
.. _Cloud Console: https://console.cloud.google.com/project?_
48-
4934
Install Dependencies
5035
++++++++++++++++++++
5136

@@ -94,29 +79,42 @@ To run this sample:
9479
9580
$ python datasets.py
9681
97-
usage: datasets.py [-h] --service_account_json SERVICE_ACCOUNT_JSON --api_key
98-
API_KEY --project_id PROJECT_ID --cloud_region CLOUD_REGION
99-
--dataset_id DATASET_ID [--time_zone TIME_ZONE]
82+
usage: datasets.py [-h] [--service_account_json SERVICE_ACCOUNT_JSON]
83+
[--project_id PROJECT_ID] [--cloud_region CLOUD_REGION]
84+
[--dataset_id DATASET_ID] [--time_zone TIME_ZONE]
10085
[--destination_dataset_id DESTINATION_DATASET_ID]
101-
[--whitelist_tags WHITELIST_TAGS]
102-
{create-dataset,delete-dataset,get-dataset,list-datasets,patch-dataset,deidentify-dataset}
86+
[--keeplist_tags KEEPLIST_TAGS] [--member MEMBER]
87+
[--role ROLE]
88+
{create-dataset,delete-dataset,get-dataset,list-datasets,patch-dataset,get_iam_policy,set_iam_policy,deidentify-dataset}
10389
...
10490
10591
positional arguments:
106-
{create-dataset,delete-dataset,get-dataset,list-datasets,patch-dataset,deidentify-dataset}
92+
{create-dataset,delete-dataset,get-dataset,list-datasets,patch-dataset,get_iam_policy,set_iam_policy,deidentify-dataset}
10793
create-dataset Creates a dataset.
10894
delete-dataset Deletes a dataset.
10995
get-dataset Gets any metadata associated with a dataset.
11096
list-datasets Lists the datasets in the project.
11197
patch-dataset Updates dataset metadata.
98+
get_iam_policy Gets the IAM policy for the specified dataset.
99+
set_iam_policy Sets the IAM policy for the specified dataset. A
100+
single member will be assigned a single role. A member
101+
can be any of: - allUsers, that is, anyone -
102+
allAuthenticatedUsers, anyone authenticated with a
103+
Google account - user:email, as in
104+
'user:somebody@example.com' - group:email, as in
105+
'group:admins@example.com' - domain:domainname, as in
106+
'domain:example.com' - serviceAccount:email, as in
107+
'serviceAccount:my-other-
108+
app@appspot.gserviceaccount.com' A role can be any IAM
109+
role, such as 'roles/viewer', 'roles/owner', or
110+
'roles/editor'
112111
deidentify-dataset Creates a new dataset containing de-identified data
113112
from the source dataset.
114113
115114
optional arguments:
116115
-h, --help show this help message and exit
117116
--service_account_json SERVICE_ACCOUNT_JSON
118117
Path to service account JSON file.
119-
--api_key API_KEY Your API key.
120118
--project_id PROJECT_ID
121119
GCP project name
122120
--cloud_region CLOUD_REGION
@@ -128,9 +126,12 @@ To run this sample:
128126
--destination_dataset_id DESTINATION_DATASET_ID
129127
The name of the new dataset where the de-identified
130128
data will be written
131-
--whitelist_tags WHITELIST_TAGS
132-
The data to whitelist, for example "PatientID" or
129+
--keeplist_tags KEEPLIST_TAGS
130+
The data to keeplist, for example "PatientID" or
133131
"StudyInstanceUID"
132+
--member MEMBER Member to add to IAM policy (e.g.
133+
"domain:example.com")
134+
--role ROLE IAM Role to give to member (e.g. "roles/viewer")
134135
135136
136137

‎healthcare/api-client/dicom/README.rst

Copy file name to clipboardExpand all lines: healthcare/api-client/dicom/README.rst
+79-21Lines changed: 79 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,6 @@ credentials for applications.
3131
.. _Authentication Getting Started Guide:
3232
https://cloud.google.com/docs/authentication/getting-started
3333

34-
Authentication
35-
++++++++++++++
36-
37-
Authentication for this service is done via an `API Key`_. To obtain an API
38-
Key:
39-
40-
1. Open the `Cloud Platform Console`_
41-
2. Make sure that billing is enabled for your project.
42-
3. From the **Credentials** page, create a new **API Key** or use an existing
43-
one for your project.
44-
45-
.. _API Key:
46-
https://developers.google.com/api-client-library/python/guide/aaa_apikeys
47-
.. _Cloud Console: https://console.cloud.google.com/project?_
48-
4934
Install Dependencies
5035
++++++++++++++++++++
5136

@@ -95,22 +80,36 @@ To run this sample:
9580
$ python dicom_stores.py
9681
9782
usage: dicom_stores.py [-h] [--service_account_json SERVICE_ACCOUNT_JSON]
98-
[--api_key API_KEY] [--project_id PROJECT_ID]
99-
[--cloud_region CLOUD_REGION] [--dataset_id DATASET_ID]
83+
[--project_id PROJECT_ID] [--cloud_region CLOUD_REGION]
84+
[--dataset_id DATASET_ID]
10085
[--dicom_store_id DICOM_STORE_ID]
10186
[--pubsub_topic PUBSUB_TOPIC] [--uri_prefix URI_PREFIX]
10287
[--content_uri CONTENT_URI]
10388
[--export_format {FORMAT_UNSPECIFIED,DICOM,JSON_BIGQUERY_IMPORT}]
104-
{create-dicom-store,delete-dicom-store,get-dicom-store,list-dicom-stores,patch-dicom-store,export-dicom-store,import-dicom-store}
89+
[--member MEMBER] [--role ROLE]
90+
{create-dicom-store,delete-dicom-store,get-dicom-store,list-dicom-stores,patch-dicom-store,get_iam_policy,set_iam_policy,export-dicom-store,import-dicom-store}
10591
...
10692
10793
positional arguments:
108-
{create-dicom-store,delete-dicom-store,get-dicom-store,list-dicom-stores,patch-dicom-store,export-dicom-store,import-dicom-store}
94+
{create-dicom-store,delete-dicom-store,get-dicom-store,list-dicom-stores,patch-dicom-store,get_iam_policy,set_iam_policy,export-dicom-store,import-dicom-store}
10995
create-dicom-store Creates a new DICOM store within the parent dataset.
11096
delete-dicom-store Deletes the specified DICOM store.
11197
get-dicom-store Gets the specified DICOM store.
11298
list-dicom-stores Lists the DICOM stores in the given dataset.
11399
patch-dicom-store Updates the DICOM store.
100+
get_iam_policy Gets the IAM policy for the specified dicom store.
101+
set_iam_policy Sets the IAM policy for the specified dicom store. A
102+
single member will be assigned a single role. A member
103+
can be any of: - allUsers, that is, anyone -
104+
allAuthenticatedUsers, anyone authenticated with a
105+
Google account - user:email, as in
106+
'user:somebody@example.com' - group:email, as in
107+
'group:admins@example.com' - domain:domainname, as in
108+
'domain:example.com' - serviceAccount:email, as in
109+
'serviceAccount:my-other-
110+
app@appspot.gserviceaccount.com' A role can be any IAM
111+
role, such as 'roles/viewer', 'roles/owner', or
112+
'roles/editor'
114113
export-dicom-store Export data to a Google Cloud Storage bucket by
115114
copying it from the DICOM store.
116115
import-dicom-store Import data into the DICOM store by copying it from
@@ -120,7 +119,6 @@ To run this sample:
120119
-h, --help show this help message and exit
121120
--service_account_json SERVICE_ACCOUNT_JSON
122121
Path to service account JSON file.
123-
--api_key API_KEY Your API key
124122
--project_id PROJECT_ID
125123
GCP project name
126124
--cloud_region CLOUD_REGION
@@ -144,6 +142,66 @@ To run this sample:
144142
Specifies the output format. If the format is
145143
unspecified, thedefault functionality is to export to
146144
DICOM.
145+
--member MEMBER Member to add to IAM policy (e.g.
146+
"domain:example.com")
147+
--role ROLE IAM Role to give to member (e.g. "roles/viewer")
148+
149+
150+
151+
DICOMweb
152+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
153+
154+
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
155+
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=healthcare/api-client/dicom/dicomweb.py,healthcare/api-client/dicom/README.rst
156+
157+
158+
159+
160+
To run this sample:
161+
162+
.. code-block:: bash
163+
164+
$ python dicomweb.py
165+
166+
usage: dicomweb.py [-h] [--service_account_json SERVICE_ACCOUNT_JSON]
167+
[--base_url BASE_URL] [--project_id PROJECT_ID]
168+
[--cloud_region CLOUD_REGION] [--dataset_id DATASET_ID]
169+
[--dicom_store_id DICOM_STORE_ID] [--dcm_file DCM_FILE]
170+
[--study_uid STUDY_UID]
171+
{dicomweb-store-instance,dicomweb-search-instance,dicomweb-retrieve-study,dicomweb-delete-study}
172+
...
173+
174+
positional arguments:
175+
{dicomweb-store-instance,dicomweb-search-instance,dicomweb-retrieve-study,dicomweb-delete-study}
176+
dicomweb-store-instance
177+
Handles the POST requests specified in the DICOMweb
178+
standard.
179+
dicomweb-search-instance
180+
Handles the GET requests specified in DICOMweb
181+
standard.
182+
dicomweb-retrieve-study
183+
Handles the GET requests specified in the DICOMweb
184+
standard.
185+
dicomweb-delete-study
186+
Handles DELETE requests equivalent to the GET requests
187+
specified in the WADO-RS standard.
188+
189+
optional arguments:
190+
-h, --help show this help message and exit
191+
--service_account_json SERVICE_ACCOUNT_JSON
192+
Path to service account JSON file.
193+
--base_url BASE_URL Healthcare API URL
194+
--project_id PROJECT_ID
195+
GCP project name
196+
--cloud_region CLOUD_REGION
197+
GCP region
198+
--dataset_id DATASET_ID
199+
Name of dataset
200+
--dicom_store_id DICOM_STORE_ID
201+
Name of DICOM store
202+
--dcm_file DCM_FILE File name for DCM file to store.
203+
--study_uid STUDY_UID
204+
Unique identifier for a study.
147205
148206
149207
@@ -164,4 +222,4 @@ to `browse the source`_ and `report issues`_.
164222
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
165223

166224

167-
.. _Google Cloud SDK: https://cloud.google.com/sdk/
225+
.. _Google Cloud SDK: https://cloud.google.com/sdk/

‎healthcare/api-client/fhir/README.rst

Copy file name to clipboardExpand all lines: healthcare/api-client/fhir/README.rst
+59-24Lines changed: 59 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,6 @@ credentials for applications.
3131
.. _Authentication Getting Started Guide:
3232
https://cloud.google.com/docs/authentication/getting-started
3333

34-
Authentication
35-
++++++++++++++
36-
37-
Authentication for this service is done via an `API Key`_. To obtain an API
38-
Key:
39-
40-
1. Open the `Cloud Platform Console`_
41-
2. Make sure that billing is enabled for your project.
42-
3. From the **Credentials** page, create a new **API Key** or use an existing
43-
one for your project.
44-
45-
.. _API Key:
46-
https://developers.google.com/api-client-library/python/guide/aaa_apikeys
47-
.. _Cloud Console: https://console.cloud.google.com/project?_
48-
4934
Install Dependencies
5035
++++++++++++++++++++
5136

@@ -95,26 +80,44 @@ To run this sample:
9580
$ python fhir_stores.py
9681
9782
usage: fhir_stores.py [-h] [--service_account_json SERVICE_ACCOUNT_JSON]
98-
[--api_key API_KEY] [--project_id PROJECT_ID]
99-
[--cloud_region CLOUD_REGION] [--dataset_id DATASET_ID]
83+
[--project_id PROJECT_ID] [--cloud_region CLOUD_REGION]
84+
[--dataset_id DATASET_ID]
10085
[--fhir_store_id FHIR_STORE_ID]
101-
[--pubsub_topic PUBSUB_TOPIC]
102-
{create-fhir-store,delete-fhir-store,get-fhir-store,list-fhir-stores,patch-fhir-store}
86+
[--pubsub_topic PUBSUB_TOPIC] [--gcs_uri GCS_URI]
87+
[--member MEMBER] [--role ROLE]
88+
{create-fhir-store,delete-fhir-store,get-fhir-store,list-fhir-stores,patch-fhir-store,import-fhir-store,export-fhir-store-gcs,get_iam_policy,set_iam_policy}
10389
...
10490
10591
positional arguments:
106-
{create-fhir-store,delete-fhir-store,get-fhir-store,list-fhir-stores,patch-fhir-store}
92+
{create-fhir-store,delete-fhir-store,get-fhir-store,list-fhir-stores,patch-fhir-store,import-fhir-store,export-fhir-store-gcs,get_iam_policy,set_iam_policy}
10793
create-fhir-store Creates a new FHIR store within the parent dataset.
10894
delete-fhir-store Deletes the specified FHIR store.
10995
get-fhir-store Gets the specified FHIR store.
11096
list-fhir-stores Lists the FHIR stores in the given dataset.
11197
patch-fhir-store Updates the FHIR store.
98+
import-fhir-store Import resources into the FHIR store by copying them
99+
from the specified source.
100+
export-fhir-store-gcs
101+
Export resources to a Google Cloud Storage bucket by
102+
copying them from the FHIR store.
103+
get_iam_policy Gets the IAM policy for the specified FHIR store.
104+
set_iam_policy Sets the IAM policy for the specified FHIR store. A
105+
single member will be assigned a single role. A member
106+
can be any of: - allUsers, that is, anyone -
107+
allAuthenticatedUsers, anyone authenticated with a
108+
Google account - user:email, as in
109+
'user:somebody@example.com' - group:email, as in
110+
'group:admins@example.com' - domain:domainname, as in
111+
'domain:example.com' - serviceAccount:email, as in
112+
'serviceAccount:my-other-
113+
app@appspot.gserviceaccount.com' A role can be any IAM
114+
role, such as 'roles/viewer', 'roles/owner', or
115+
'roles/editor'
112116
113117
optional arguments:
114118
-h, --help show this help message and exit
115119
--service_account_json SERVICE_ACCOUNT_JSON
116120
Path to service account JSON file.
117-
--api_key API_KEY Your API key.
118121
--project_id PROJECT_ID
119122
GCP cloud project name
120123
--cloud_region CLOUD_REGION
@@ -126,6 +129,13 @@ To run this sample:
126129
--pubsub_topic PUBSUB_TOPIC
127130
The Cloud Pub/Sub topic where notifications of changes
128131
are published
132+
--gcs_uri GCS_URI URI for a Google Cloud Storage directory from which
133+
filesshould be import or to which result filesshould
134+
be written (e.g., "bucket-
135+
id/path/to/destination/dir").
136+
--member MEMBER Member to add to IAM policy (e.g.
137+
"domain:example.com")
138+
--role ROLE IAM Role to give to member (e.g. "roles/viewer")
129139
130140
131141
@@ -150,17 +160,36 @@ To run this sample:
150160
[--dataset_id DATASET_ID]
151161
[--fhir_store_id FHIR_STORE_ID]
152162
[--resource_type RESOURCE_TYPE]
153-
[--resource_id RESOURCE_ID]
154-
{create-resource,delete-resource,get-resource,update-resource,patch-resource,search-resources-get,search-resources-post,get-patient-everything,get-metadata}
163+
[--resource_id RESOURCE_ID] [--bundle BUNDLE]
164+
[--uri_prefix URI_PREFIX] [--version_id VERSION_ID]
165+
{create-resource,delete-resource,conditional-delete-resource,get-resource,list-resource-history,export-resources,execute_bundle,get-resource-history,delete-resource-purge,update-resource,conditional-update-resource,patch-resource,conditional-patch-resource,search-resources-get,search-resources-post,get-patient-everything,get-metadata}
155166
...
156167
157168
positional arguments:
158-
{create-resource,delete-resource,get-resource,update-resource,patch-resource,search-resources-get,search-resources-post,get-patient-everything,get-metadata}
169+
{create-resource,delete-resource,conditional-delete-resource,get-resource,list-resource-history,export-resources,execute_bundle,get-resource-history,delete-resource-purge,update-resource,conditional-update-resource,patch-resource,conditional-patch-resource,search-resources-get,search-resources-post,get-patient-everything,get-metadata}
159170
create-resource Creates a new resource in a FHIR store.
160171
delete-resource Creates a new resource in a FHIR store.
172+
conditional-delete-resource
173+
Deletes an existing resource specified by search
174+
criteria.
161175
get-resource Gets a FHIR resource.
176+
list-resource-history
177+
Gets the history of a resource.
178+
export-resources Exports resources in a FHIR store.
179+
export-resources Exports resources in a FHIR store.
180+
execute_bundle Executes the operations in the given bundle.
181+
get-resource-history
182+
Gets a version resource.
183+
delete-resource-purge
184+
Deletes versions of a resource (excluding current
185+
version).
162186
update-resource Updates an existing resource.
187+
conditional-update-resource
188+
Updates an existing resource specified by search
189+
criteria.
163190
patch-resource Updates part of an existing resource..
191+
conditional-patch-resource
192+
Updates part of an existing resource..
164193
search-resources-get
165194
Searches resources in the given FHIR store using the
166195
searchResources GET method.
@@ -188,6 +217,12 @@ To run this sample:
188217
The type of resource. First letter must be capitalized
189218
--resource_id RESOURCE_ID
190219
Name of a FHIR resource
220+
--bundle BUNDLE Name of file containing bundle of operations to
221+
execute
222+
--uri_prefix URI_PREFIX
223+
Prefix of gs:// URIs for import and export
224+
--version_id VERSION_ID
225+
Version of a FHIR resource
191226
192227
193228

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.