Class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/healthcare_v1beta1/classes.rb,
lib/google/apis/healthcare_v1beta1/representations.rb,
lib/google/apis/healthcare_v1beta1/representations.rb

Overview

Specifies the FHIR paths to match and how to handle the de-identification of matching fields.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata

Returns a new instance of GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata.



3882
3883
3884
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3882

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#character_mask_fieldGoogle::Apis::HealthcareV1beta1::CharacterMaskField

Replace field value with masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Corresponds to the JSON property characterMaskField



3828
3829
3830
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3828

def character_mask_field
  @character_mask_field
end

#clean_text_fieldGoogle::Apis::HealthcareV1beta1::CleanTextField

Inspect text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Corresponds to the JSON property cleanTextField



3836
3837
3838
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3836

def clean_text_field
  @clean_text_field
end

#crypto_hash_fieldGoogle::Apis::HealthcareV1beta1::CryptoHashField

Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. Corresponds to the JSON property cryptoHashField



3843
3844
3845
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3843

def crypto_hash_field
  @crypto_hash_field
end

#date_shift_fieldGoogle::Apis::HealthcareV1beta1::DateShiftField

Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime. Corresponds to the JSON property dateShiftField



3850
3851
3852
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3850

def date_shift_field
  @date_shift_field
end

#keep_fieldGoogle::Apis::HealthcareV1beta1::KeepField

Keep field unchanged. Corresponds to the JSON property keepField



3855
3856
3857
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3855

def keep_field
  @keep_field
end

#pathsArray<String>

List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field Patient.Address.city, which uses a string type, can be matched by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with Patient omitted). Partial matching and type matching can be combined, for example Patient.Address.city can be matched by Address.String. For "choice" types (those defined in the FHIR spec with the format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased. Age.unit. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for example HumanName.given, HumanName.family) can be omitted. Corresponds to the JSON property paths

Returns:

  • (Array<String>)


3875
3876
3877
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3875

def paths
  @paths
end

#remove_fieldGoogle::Apis::HealthcareV1beta1::RemoveField

Remove field. Corresponds to the JSON property removeField



3880
3881
3882
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3880

def remove_field
  @remove_field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3887
3888
3889
3890
3891
3892
3893
3894
3895
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3887

def update!(**args)
  @character_mask_field = args[:character_mask_field] if args.key?(:character_mask_field)
  @clean_text_field = args[:clean_text_field] if args.key?(:clean_text_field)
  @crypto_hash_field = args[:crypto_hash_field] if args.key?(:crypto_hash_field)
  @date_shift_field = args[:date_shift_field] if args.key?(:date_shift_field)
  @keep_field = args[:keep_field] if args.key?(:keep_field)
  @paths = args[:paths] if args.key?(:paths)
  @remove_field = args[:remove_field] if args.key?(:remove_field)
end