Skip to main content

@swamp/gcp/healthcare

v2026.04.23.1

Google Cloud healthcare infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudhealthcarecloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/healthcare

@swamp/gcp/healthcare/datasetsv2026.04.23.1datasets.ts

Global Arguments

ArgumentTypeDescription
encryptionSpec?objectRepresents a customer-managed encryption key spec that can be applied to a resource.
name?stringIdentifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
timeZone?stringOptional. The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified.
datasetId?stringRequired. The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a datasets
getGet a datasets
ArgumentTypeDescription
identifierstringThe name of the datasets
updateUpdate datasets attributes
deleteDelete the datasets
ArgumentTypeDescription
identifierstringThe name of the datasets
syncSync datasets state from GCP
deidentifydeidentify
ArgumentTypeDescription
config?any
destinationDataset?any
gcsConfigUri?any

Resources

state(infinite)— A message representing a health dataset. A health dataset represents a collec...
@swamp/gcp/healthcare/datasets-consentstoresv2026.04.23.1datasets_consentstores.ts

Global Arguments

ArgumentTypeDescription
defaultConsentTtl?stringOptional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enableConsentCreateOnUpdate?booleanOptional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`.
labels?recordOptional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}. No more than 64 labels can be associated with a given store
name?stringIdentifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation.
consentStoreId?stringRequired. The ID of the consent store to create. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. Cannot be changed after creation.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a consentStores
getGet a consentStores
ArgumentTypeDescription
identifierstringThe name of the consentStores
updateUpdate consentStores attributes
deleteDelete the consentStores
ArgumentTypeDescription
identifierstringThe name of the consentStores
syncSync consentStores state from GCP
check_data_accesscheck data access
ArgumentTypeDescription
consentList?any
dataId?any
requestAttributes?any
responseView?any
evaluate_user_consentsevaluate user consents
ArgumentTypeDescription
consentList?any
pageSize?any
pageToken?any
requestAttributes?any
resourceAttributes?any
responseView?any
userId?any
query_accessible_dataquery accessible data
ArgumentTypeDescription
gcsDestination?any
requestAttributes?any
resourceAttributes?any

Resources

state(infinite)— Represents a consent store.
@swamp/gcp/healthcare/datasets-consentstores-attributedefinitionsv2026.04.23.1datasets_consentstores_attributedefinitions.ts

Global Arguments

ArgumentTypeDescription
allowedValues?arrayRequired. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation.
category?enumRequired. The category of the attribute. The value of this field cannot be changed after creation.
consentDefaultValues?arrayOptional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value.
dataMappingDefaultValue?stringOptional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`.
description?stringOptional. A description of the attribute.
name?stringIdentifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation.
attributeDefinitionId?stringRequired. The ID of the Attribute definition to create. The string must match the following regex: `_a-zA-Z{0,255}` and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a attributeDefinitions
getGet a attributeDefinitions
ArgumentTypeDescription
identifierstringThe name of the attributeDefinitions
updateUpdate attributeDefinitions attributes
deleteDelete the attributeDefinitions
ArgumentTypeDescription
identifierstringThe name of the attributeDefinitions
syncSync attributeDefinitions state from GCP

Resources

state(infinite)— A client-defined consent attribute.
@swamp/gcp/healthcare/datasets-consentstores-consentartifactsv2026.04.23.1datasets_consentstores_consentartifacts.ts

Global Arguments

ArgumentTypeDescription
consentContentScreenshots?arrayOptional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion?stringOptional. An string indicating the version of the consent information shown to the user.
guardianSignature?objectUser signature.
metadata?recordOptional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
name?stringIdentifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation.
userId?stringRequired. User's UUID provided by the client.
userSignature?objectUser signature.
witnessSignature?objectUser signature.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a consentArtifacts
getGet a consentArtifacts
ArgumentTypeDescription
identifierstringThe name of the consentArtifacts
deleteDelete the consentArtifacts
ArgumentTypeDescription
identifierstringThe name of the consentArtifacts
syncSync consentArtifacts state from GCP

Resources

state(infinite)— Documentation of a user's consent.
@swamp/gcp/healthcare/datasets-consentstores-consentsv2026.04.23.1datasets_consentstores_consents.ts

Global Arguments

ArgumentTypeDescription
consentArtifact?stringRequired. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`.
expireTime?stringTimestamp in UTC of when this Consent is considered expired.
metadata?recordOptional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, und
name?stringIdentifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.
policies?arrayOptional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
state?enumRequired. Indicates the current state of this Consent.
ttl?stringInput only. The time to live for this Consent from when it is created.
userId?stringRequired. User's UUID provided by the client.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a consents
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a consents
ArgumentTypeDescription
identifierstringThe name of the consents
updateUpdate consents attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the consents
ArgumentTypeDescription
identifierstringThe name of the consents
syncSync consents state from GCP
activateactivate
ArgumentTypeDescription
consentArtifact?any
expireTime?any
ttl?any
list_revisionslist revisions
rejectreject
ArgumentTypeDescription
consentArtifact?any
revokerevoke
ArgumentTypeDescription
consentArtifact?any

Resources

state(infinite)— Represents a user's consent.
@swamp/gcp/healthcare/datasets-consentstores-userdatamappingsv2026.04.23.1datasets_consentstores_userdatamappings.ts

Global Arguments

ArgumentTypeDescription
dataId?stringRequired. A unique identifier for the mapped resource.
name?stringResource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
resourceAttributes?arrayAttributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
userId?stringRequired. User's UUID provided by the client.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a userDataMappings
getGet a userDataMappings
ArgumentTypeDescription
identifierstringThe name of the userDataMappings
updateUpdate userDataMappings attributes
deleteDelete the userDataMappings
ArgumentTypeDescription
identifierstringThe name of the userDataMappings
syncSync userDataMappings state from GCP
archivearchive

Resources

state(infinite)— Maps a resource to the associated user and Attributes.
@swamp/gcp/healthcare/datasets-dicomstoresv2026.04.23.1datasets_dicomstores.ts

Global Arguments

ArgumentTypeDescription
labels?recordUser-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store
name?stringIdentifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
notificationConfig?objectSpecifies where to send notifications upon changes to a data store.
notificationConfigs?arrayOptional. Specifies where and whether to send notifications upon changes to a DICOM store.
streamConfigs?arrayOptional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.
dicomStoreId?stringRequired. The ID of the DICOM store that is being created. Any string value up to 256 characters in length.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a dicomStores
getGet a dicomStores
ArgumentTypeDescription
identifierstringThe name of the dicomStores
updateUpdate dicomStores attributes
deleteDelete the dicomStores
ArgumentTypeDescription
identifierstringThe name of the dicomStores
syncSync dicomStores state from GCP
deidentifydeidentify
ArgumentTypeDescription
config?any
destinationStore?any
filterConfig?any
gcsConfigUri?any
exportexport
ArgumentTypeDescription
bigqueryDestination?any
gcsDestination?any
get_dicomstore_metricsget dicomstore metrics
importimport
ArgumentTypeDescription
blobStorageSettings?any
gcsSource?any
search_for_instancessearch for instances
search_for_seriessearch for series
search_for_studiessearch for studies
set_blob_storage_settingsset blob storage settings
ArgumentTypeDescription
blobStorageSettings?any
filterConfig?any
store_instancesstore instances
ArgumentTypeDescription
contentType?any
data?any
extensions?any

Resources

state(infinite)— Represents a DICOM store.
@swamp/gcp/healthcare/datasets-fhirstoresv2026.04.23.1datasets_fhirstores.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
bulkExportGcsDestination?objectThe configuration for exporting to Cloud Storage using the bulk export API.
complexDataTypeReferenceParsing?enumOptional. Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources
consentConfig?objectConfigures whether to enforce consent for the FHIR store and which consent enforcement version is being used.
defaultSearchHandlingStrict?booleanOptional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.
disableReferentialIntegrity?booleanImmutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
disableResourceVersioning?booleanImmutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.
enableUpdateCreate?booleanOptional. Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patien
labels?recordUser-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
notificationConfig?objectSpecifies where to send notifications upon changes to a data store.
notificationConfigs?arrayOptional. Specifies where and whether to send notifications upon changes to a FHIR store.
streamConfigs?arrayOptional. A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.goo
validationConfig?objectContains the configuration for FHIR profiles and validation.
version?enumRequired. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
fhirStoreId?stringRequired. The ID of the FHIR store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a fhirStores
getGet a fhirStores
ArgumentTypeDescription
identifierstringThe name of the fhirStores
updateUpdate fhirStores attributes
deleteDelete the fhirStores
ArgumentTypeDescription
identifierstringThe name of the fhirStores
syncSync fhirStores state from GCP
apply_admin_consentsapply admin consents
ArgumentTypeDescription
newConsentsList?any
validateOnly?any
apply_consentsapply consents
ArgumentTypeDescription
patientScope?any
timeRange?any
validateOnly?any
bulk_export_groupbulk-export-group
bulk_deletebulk delete
ArgumentTypeDescription
gcsDestination?any
type?any
until?any
versionConfig?any
deidentifydeidentify
ArgumentTypeDescription
config?any
destinationStore?any
gcsConfigUri?any
resourceFilter?any
skipModifiedResources?any
explain_data_accessexplain data access
exportexport
ArgumentTypeDescription
_since?any
_type?any
bigqueryDestination?any
gcsDestination?any
get_fhirstore_metricsget fhirstore metrics
importimport
ArgumentTypeDescription
contentStructure?any
gcsSource?any
rollbackrollback
ArgumentTypeDescription
changeType?any
excludeRollbacks?any
filteringFields?any
force?any
inputGcsObject?any
resultGcsBucket?any
rollbackTime?any
type?any

Resources

state(infinite)— Represents a FHIR store.
@swamp/gcp/healthcare/datasets-hl7v2storesv2026.04.23.1datasets_hl7v2stores.ts

Global Arguments

ArgumentTypeDescription
labels?recordUser-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store
name?stringIdentifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.
notificationConfigsarray
parserConfig?objectThe configuration for the parser. It determines how the server parses the messages.
rejectDuplicateMessage?booleanOptional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with
hl7V2StoreId?stringRequired. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a hl7V2Stores
getGet a hl7V2Stores
ArgumentTypeDescription
identifierstringThe name of the hl7V2Stores
updateUpdate hl7V2Stores attributes
deleteDelete the hl7V2Stores
ArgumentTypeDescription
identifierstringThe name of the hl7V2Stores
syncSync hl7V2Stores state from GCP
exportexport
ArgumentTypeDescription
endTime?any
filter?any
gcsDestination?any
pubsubDestination?any
startTime?any
get_hl7v2store_metricsget hl7v2store metrics
importimport
ArgumentTypeDescription
gcsSource?any
rollbackrollback
ArgumentTypeDescription
changeType?any
excludeRollbacks?any
filteringFields?any
force?any
inputGcsObject?any
resultGcsBucket?any
rollbackTime?any

Resources

state(infinite)— Represents an HL7v2 store.
@swamp/gcp/healthcare/datasets-hl7v2stores-messagesv2026.04.23.1datasets_hl7v2stores_messages.ts

Global Arguments

ArgumentTypeDescription
message?objectA complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
createTime?stringOutput only. The datetime when the message was created. Set by the server.
data?stringRequired. Raw message bytes.
labels?recordUser-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given store
messageType?stringOutput only. The message type for this message. MSH-9.1.
name?stringOutput only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
parsedData?objectThe content of a HL7v2 message in a structured format.
patientIds?arrayOutput only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
schematizedData?objectThe content of an HL7v2 message in a structured format as specified by a schema.
sendFacility?stringOutput only. The hospital that this message came from. MSH-4.
sendTime?stringOutput only. The datetime the sending application sent this message. MSH-7.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a messages
getGet a messages
ArgumentTypeDescription
identifierstringThe name of the messages
updateUpdate messages attributes
deleteDelete the messages
ArgumentTypeDescription
identifierstringThe name of the messages
syncSync messages state from GCP
ingestingest
ArgumentTypeDescription
message?any

Resources

state(infinite)— A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl...
@swamp/gcp/healthcare/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.