En esta página, se muestra cómo crear y administrar almacenes de consentimientos.
La API de Consent Management es una herramienta para registrar los consentimientos de los usuarios, administrar las acciones basadas en esos consentimientos y mantener la documentación y los registros asociados.
La organización que usa la API de Consent Management es responsable de obtener y mantener los consentimientos necesarios para permitir el procesamiento de datos a través de la API de Consent Management.
La API de Consent Management cumple el rol de un punto de decisión de la política. La aplicación de políticas debe implementarse en la aplicación o a través de un proxy. Para obtener más información, consulta Control de acceso basado en atributos.
Configura los permisos
Para usar las funciones de esta guía, debes tener el rol roles/healthcare.consentStoreAdmin
. Sin embargo, para realizar operaciones adicionales útiles con la API de Consent Management, es posible que se necesiten permisos adicionales. Consulta Control de acceso para obtener más información.
Cree un almacén de consentimientos
Los almacenes de consentimientos son los recursos de nivel superior que contienen toda la información relacionada con la configuración y el funcionamiento de la API de Consent Management. Los almacenes de consentimientos pertenecen a un conjunto de datos de la API de Cloud Healthcare, que se asigna a una región cuando se crea. Esta región es la ubicación geográfica en la que opera tu almacén de consentimientos.
Consola
En la consola de Google Cloud, ve a la página Conjuntos de datos.
Selecciona el conjunto de datos en el que deseas crear un almacén de consentimientos.
Haz clic en Crear almacén de datos.
Selecciona Consentir como el tipo de almacén de datos.
En el campo ID, ingresa el nombre que desees, que sea único en tu conjunto de datos. Si el nombre no es único, la creación del almacén fallará.
Haga clic en Next.
En Configura tu almacén de consentimientos, selecciona una de las siguientes opciones para determinar cuándo vencen los consentimientos de tu almacén:
- No hay una hora de vencimiento predeterminada significa que, de forma predeterminada, los consentimientos no vencen.
- Hora de vencimiento predeterminada significa que, de forma predeterminada, los consentimientos vencen después de la cantidad de días definida en el campo Hora de vencimiento.
Para permitir que se creen recursos de consentimientos nuevos con
consentStores.patch
, haz clic en Permitir creación de consentimientos en la actualización.Haz clic en Siguiente.
Haz clic en Agregar etiqueta para definir la clave y el valor opcionales. etiquetas para organizar recursos de Google Cloud.
Haz clic en Crear.
gcloud
Para crear un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores create
.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: Es un identificador para el almacén de consentimientos. El ID del almacén de consentimientos debe tener lo siguiente:
- Un ID único en su conjunto de datos
- Una string de Unicode de 1 a 256 caracteres que consiste en lo siguiente:
- Números
- Letras
- Guiones bajos
- Guiones:
- Puntos
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores create CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores create CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores create CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Deberías recibir una respuesta similar a la que figura a continuación:
Respuesta
Created consentStore [CONSENT_STORE_ID].
REST
Para crear un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.create
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_IDEl ID de tu proyecto de Google Cloud.
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: Es un identificador para el almacén de consentimientos. El ID del almacén de consentimientos debe tener lo siguiente:
- Un ID único en su conjunto de datos
- Una string de Unicode de 1 a 256 caracteres que consiste en lo siguiente:
- Números
- Letras
- Guiones bajos
- Guiones:
- Puntos:
- DEFAULT_CONSENT_EXPIRATION_DURATION: Es un tiempo predeterminado opcional, especificado en segundos, hasta que venzan los consentimientos creados en este almacén. Esta duración debe ser de al menos 24 horas (86,400 segundos) y debe tener el formato
DEFAULT_CONSENT_EXPIRATION_DURATIONs
. - ENABLE_CONSENT_CREATE_ON_UPDATE: Un valor booleano opcional que determina si las solicitudes para aplicar un parche a un recurso de consentimientos inexistente con
consentStores.patch
deben crear ese recurso. El valor predeterminado esFALSE
.
Cuerpo JSON de la solicitud:
{ "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" }
Para enviar tu solicitud, elige una de estas opciones:
curl
Guarda el cuerpo de la solicitud en un archivo llamado request.json
.
Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:
cat > request.json << 'EOF' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } EOF
Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID"
PowerShell
Guarda el cuerpo de la solicitud en un archivo llamado request.json
.
Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:
@' { "defaultConsentTtl": "DEFAULT_CONSENT_EXPIRATION_DURATIONs", "enableConsentCreateOnUpdate": "ENABLE_CONSENT_CREATE_ON_UPDATE" } '@ | Out-File -FilePath request.json -Encoding utf8
Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores?consentStoreId=CONSENT_STORE_ID" | Select-Object -Expand Content
Explorador de API
Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Pega el cuerpo de la solicitud en esta herramienta, completa cualquier otro campo obligatorio y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
Node.js
Python
Cómo editar un almacén de consentimiento
Después de crear un almacén de consentimiento, puedes actualizarlo. Por ejemplo, puedes agregar o quitar etiquetas para organizar los almacenes de consentimientos.
En los siguientes ejemplos, se muestra cómo editar un almacén de consentimientos.
Console
Para editar un almacén de consentimientos, realiza los siguientes pasos:
- En la consola de Google Cloud, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contenga el almacén de consentimientos que deseas editar.
- En la lista Almacenes de datos, haz clic en el almacén de datos que deseas editar.
- Para editar la configuración del almacén de consentimientos, haz clic en el ícono de edición junto a Configuración del almacén de consentimientos.
Para obtener más información sobre las opciones de configuración del almacén de consentimientos, consulta Crea un almacén de consentimientos. - Para agregar una o más etiquetas al almacén, haz clic en Usa etiquetas de recursos. Etiquetas, luego, en Agregar etiqueta e ingresa la etiqueta de par clave-valor. Para obtener más información sobre las etiquetas de recursos, consulta
- Haz clic en Guardar.
gcloud
Para editar un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores update
.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
- KEY: Es la clave en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta
labels
para conocer los requisitos y las limitaciones de las etiquetas. - VALUE: El valor en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta
labels
para conocer los requisitos y las limitaciones de las etiquetas.
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores update CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION \ --update-labels=KEY=VALUE
Windows (PowerShell)
gcloud healthcare consent-stores update CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION ` --update-labels=KEY=VALUE
Windows (cmd.exe)
gcloud healthcare consent-stores update CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION ^ --update-labels=KEY=VALUE
Deberías recibir una respuesta similar a la que figura a continuación:
Respuesta
Updated consentStore [CONSENT_STORE_ID]. labels: KEY: VALUE name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para editar un almacén de consentimiento, usa el método projects.locations.datasets.consentStores.patch
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_IDEl ID de tu proyecto de Google Cloud.
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
- KEY: Es la clave en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta
labels
para conocer los requisitos y las limitaciones de las etiquetas. - VALUE: El valor en un par clave-valor que se usa para organizar los almacenes de consentimientos. Consulta
labels
para conocer los requisitos y las limitaciones de las etiquetas.
Cuerpo JSON de la solicitud:
{ "labels": { "KEY": "VALUE" } }
Para enviar tu solicitud, elige una de estas opciones:
curl
Guarda el cuerpo de la solicitud en un archivo llamado request.json
.
Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:
cat > request.json << 'EOF' { "labels": { "KEY": "VALUE" } } EOF
Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels"
PowerShell
Guarda el cuerpo de la solicitud en un archivo llamado request.json
.
Ejecuta el comando siguiente en la terminal para crear o reemplazar este archivo en el directorio actual:
@' { "labels": { "KEY": "VALUE" } } '@ | Out-File -FilePath request.json -Encoding utf8
Luego, ejecuta el siguiente comando para enviar tu solicitud de REST:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID?updateMask=labels" | Select-Object -Expand Content
Explorador de API
Copia el cuerpo de la solicitud y abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Pega el cuerpo de la solicitud en esta herramienta, completa cualquier otro campo obligatorio y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
Node.js
Python
Obtén detalles del almacén de consentimientos
En los siguientes ejemplos, se muestra cómo obtener detalles sobre un almacén FHIR.
Console
Para ver los detalles de un almacén de consentimiento, debes hacer lo siguiente:
- En la consola de Google Cloud, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contenga el almacén de consentimientos que deseas ver.
- Haz clic en el nombre del almacén de consentimientos.
En la página Detalles de Datastore, se muestran los detalles del almacén de consentimiento seleccionado.
gcloud
Para obtener más detalles sobre un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores describe
.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores describe CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores describe CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores describe CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
ConsentStore
,
también aparecerá en la respuesta.
Respuesta
name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID
REST
Para obtener más detalles sobre un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.get
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_IDEl ID de tu proyecto de Google Cloud.
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el siguiente comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
PowerShell
Ejecuta el siguiente comando:
$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/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content
Explorador de API
Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.
ConsentStore
, también aparecerá en la respuesta.
Node.js
Python
Muestra una lista de los almacenes de consentimientos de un conjunto de datos
En los siguientes ejemplos, se muestra cómo enumerar los almacenes de consentimiento en un conjunto de datos.
Console
Para ver los almacenes de datos en un conjunto de datos, haz lo siguiente:
- En la consola de Google Cloud, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contiene el almacén de datos que deseas ver.
gcloud
Para mostrar una lista de los almacenes de consentimientos en un conjunto de datos, ejecuta el comando gcloud healthcare consent-stores list
.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
- DATASET_ID: El conjunto de datos superior del almacén de consentimientos
- LOCATION: La ubicación del conjunto de datos
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores list --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores list --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores list --dataset=DATASET_ID ^ --location=LOCATION
ConsentStore
,
también aparecerá en la respuesta.
ID LABELS LOCATION CONSENT_STORE_ID LOCATION
REST
Para mostrar una lista de los almacenes de consentimiento en un conjunto de datos, usa el método projects.locations.datasets.consentStores.list
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_IDEl ID de tu proyecto de Google Cloud.
- DATASET_ID: El conjunto de datos superior del almacén de consentimientos
- LOCATION: Es la ubicación del conjunto de datos
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el siguiente comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores"
PowerShell
Ejecuta el siguiente comando:
$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/LOCATION/datasets/DATASET_ID/consentStores" | Select-Object -Expand Content
Explorador de API
Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.
ConsentStore
, también aparecerá en la respuesta.
Node.js
Python
Borra un almacén de consentimientos
En los siguientes ejemplos, se muestra cómo borrar un almacén de consentimiento.
Console
Para borrar un almacén de datos, realiza las siguientes acciones:
- En la consola de Google Cloud, ve a la página Conjuntos de datos.
- Selecciona el conjunto de datos que contiene el almacén de datos que deseas borrar.
- Elige Borrar en la lista desplegable Acciones para el almacén de datos que deseas borrar.
- Para confirmar, escribe el nombre del almacén de datos y, luego, haz clic en Borrar.
gcloud
Para borrar un almacén de consentimientos, ejecuta el comando gcloud healthcare consent-stores delete
.
Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
Ejecuta el siguiente comando:
Linux, macOS o Cloud Shell
gcloud healthcare consent-stores delete CONSENT_STORE_ID \ --dataset=DATASET_ID \ --location=LOCATION
Windows (PowerShell)
gcloud healthcare consent-stores delete CONSENT_STORE_ID ` --dataset=DATASET_ID ` --location=LOCATION
Windows (cmd.exe)
gcloud healthcare consent-stores delete CONSENT_STORE_ID ^ --dataset=DATASET_ID ^ --location=LOCATION
Deleted consentStore [CONSENT_STORE_ID].
REST
Para borrar un almacén de consentimientos, usa el método projects.locations.datasets.consentStores.delete
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
- PROJECT_IDEl ID de tu proyecto de Google Cloud.
- LOCATION: Es la ubicación del conjunto de datos
- DATASET_ID: Es el conjunto de datos superior del almacén de consentimiento.
- CONSENT_STORE_ID: El ID del almacén de consentimientos
Para enviar tu solicitud, elige una de estas opciones:
curl
Ejecuta el siguiente comando:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/consentStores/CONSENT_STORE_ID"
PowerShell
Ejecuta el siguiente comando:
$cred = gcloud auth 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/consentStores/CONSENT_STORE_ID" | Select-Object -Expand Content
Explorador de API
Abre la página de referencia del método. El panel del Explorador de API se abre en la parte derecha de la página. Puedes interactuar con esta herramienta para enviar solicitudes. Completa los campos obligatorios y haz clic en Ejecutar.
Deberías recibir una respuesta JSON similar a la que se muestra a continuación:
Node.js
Python
Registros de auditoría
La API de Consent Management escribe los siguientes tipos de registros de auditoría:
- Actividad del administrador: Registra las operaciones que modifican la configuración o los metadatos de un recurso. No puedes inhabilitar los registros de auditoría de actividad del administrador.
- Acceso a los datos: Contiene llamadas a la API que leen la configuración o los metadatos de los recursos, así como llamadas a la API externas que crean, modifican o leen datos de recursos proporcionados por el cliente. Estos registros deben estar habilitados. Por ejemplo, los registros de auditoría de acceso a los datos se pueden usar para registrar qué servicio realizó una solicitud de determinación de acceso, qué información se proporcionó en esa solicitud y cómo respondió la API a esa solicitud. Para obtener más información sobre los registros de auditoría de acceso a los datos, consulta Configura registros de auditoría de acceso a los datos. Para obtener más información sobre el registro de auditoría en la API de Cloud Healthcare, visita Visualiza los registros de auditoría de Cloud.
Para obtener más información sobre los registros de auditoría de la API de Consent Management, consulta Visualiza los registros de auditoría de Cloud.