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.



3609
3610
3611
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3609

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

Instance Attribute Details

#character_mask_field ⇒ Google::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

Returns:



3555
3556
3557
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3555

def character_mask_field
  @character_mask_field
end

#clean_text_field ⇒ Google::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

Returns:



3563
3564
3565
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3563

def clean_text_field
  @clean_text_field
end

#crypto_hash_field ⇒ Google::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

Returns:



3570
3571
3572
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3570

def crypto_hash_field
  @crypto_hash_field
end

#date_shift_field ⇒ Google::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

Returns:



3577
3578
3579
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3577

def date_shift_field
  @date_shift_field
end

#keep_field ⇒ Google::Apis::HealthcareV1beta1::KeepField

Keep field unchanged. Corresponds to the JSON property keepField

Returns:



3582
3583
3584
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3582

def keep_field
  @keep_field
end

#paths ⇒ Array<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>) 


3602
3603
3604
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3602

def paths
  @paths
end

#remove_field ⇒ Google::Apis::HealthcareV1beta1::RemoveField

Remove field. Corresponds to the JSON property removeField

Returns:



3607
3608
3609
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3607

def remove_field
  @remove_field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3614
3615
3616
3617
3618
3619
3620
3621
3622
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3614

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