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.



3685
3686
3687
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3685

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:



3631
3632
3633
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3631

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:



3639
3640
3641
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3639

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:



3646
3647
3648
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3646

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:



3653
3654
3655
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3653

def date_shift_field
  @date_shift_field
end

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

Keep field unchanged. Corresponds to the JSON property keepField

Returns:



3658
3659
3660
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3658

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>) 


3678
3679
3680
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3678

def paths
  @paths
end

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

Remove field. Corresponds to the JSON property removeField

Returns:



3683
3684
3685
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3683

def remove_field
  @remove_field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3690
3691
3692
3693
3694
3695
3696
3697
3698
 
# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 3690

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