View Source GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata (google_api_health_care v0.50.1)

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

Attributes

  • characterMaskField (type: GoogleApi.HealthCare.V1beta1.Model.CharacterMaskField.t, default: nil) - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
  • cleanTextField (type: GoogleApi.HealthCare.V1beta1.Model.CleanTextField.t, default: nil) - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
  • cryptoHashField (type: GoogleApi.HealthCare.V1beta1.Model.CryptoHashField.t, default: nil) - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
  • dateShiftField (type: GoogleApi.HealthCare.V1beta1.Model.DateShiftField.t, default: nil) - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
  • keepField (type: GoogleApi.HealthCare.V1beta1.Model.KeepField.t, default: nil) - Keep the field unchanged.
  • paths (type: list(String.t), default: nil) - 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.
  • removeField (type: GoogleApi.HealthCare.V1beta1.Model.RemoveField.t, default: nil) - Remove the field.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata{
    characterMaskField:
      GoogleApi.HealthCare.V1beta1.Model.CharacterMaskField.t() | nil,
    cleanTextField: GoogleApi.HealthCare.V1beta1.Model.CleanTextField.t() | nil,
    cryptoHashField:
      GoogleApi.HealthCare.V1beta1.Model.CryptoHashField.t() | nil,
    dateShiftField: GoogleApi.HealthCare.V1beta1.Model.DateShiftField.t() | nil,
    keepField: GoogleApi.HealthCare.V1beta1.Model.KeepField.t() | nil,
    paths: [String.t()] | nil,
    removeField: GoogleApi.HealthCare.V1beta1.Model.RemoveField.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.