Type Members

1.  abstract class BaseFhirDeIdentification extends Transformer with HasFeatures with LightDeIdentificationParams with DeidModelParams with CheckLicense with HasInputCol with HasOutputAnnotationCol with ParamsAndFeaturesWritable
2.  class CdaDeIdentification extends BaseFhirDeIdentification

   A Spark Transformer for de-identifying HL7 CDA (Clinical Document Architecture) documents using javax.xml DOM parsing.

   A Spark Transformer for de-identifying HL7 CDA (Clinical Document Architecture) documents using javax.xml DOM parsing.

   Overview

   Performs field-level and free-text de-identification on CDA R2 XML documents using XPath expressions. Supports both structured field obfuscation and NLP-based free-text de-identification.

   Key Features

   - **XPath-based de-identification**: Target specific CDA elements using dot notation - **Attribute support**: Access XML attributes using @ notation (e.g., "telecom/@value") - **Namespace-aware**: Handles HL7 v3 namespace automatically - **Structured field obfuscation**: Replace names, dates, addresses, phone numbers, IDs - **Free-text de-identification**: Process narrative sections using NLP pipelines

   Path Notation

   Paths support both dot (.) and slash (/) as separators. Attributes can be specified with or without @ prefix. Free-text container paths (e.g. section.text) apply de-identification recursively to all descendant TEXT_NODEs.

   // Element paths (both notations work)
   "recordTarget.patientRole.patient.name.given"
   "recordTarget/patientRole/patient/name/given"
   
   // Attribute paths (all formats work)
   "recordTarget.patientRole.telecom/@value"     // explicit @
   "recordTarget.patientRole.telecom.value"      // auto-detected
   "recordTarget/patientRole/telecom/@value"     // with slashes
   "recordTarget.patientRole.id.extension"       // known attribute
   
   // Nested structures
   "component.structuredBody.component.section.text"
   "component/structuredBody/component/section/text"

   Usage Example

   val deid = new CdaDeIdentification()
     .setInputCol("cda_xml")
     .setOutputCol("deidentified_cda")
     .setMode("obfuscate")
     .setMappingRules(Map(
       "recordTarget.patientRole.patient.name.given" -> "first_name",
       "recordTarget.patientRole.patient.name.family" -> "last_name",
       "recordTarget.patientRole.addr.streetAddressLine" -> "Address",
       "recordTarget.patientRole.telecom/@value" -> "Phone",
       "author.assignedAuthor.assignedPerson.name.given" -> "first_name",
       "custodian.assignedCustodian.representedCustodianOrganization.name" -> "Organization"
     ))
     .setFreeTextPaths(Array(
       "component.structuredBody.component.section.text"
     ))
     .setPipeline(spark, deidPipeline, "deidentified")
   
   val result = deid.deidentify(cdaXmlString)

   See also

   HL7 CDA Standard

   BaseFhirDeIdentification for base de-identification functionality

3.  class FhirDeIdentification extends BaseFhirDeIdentification

   A Spark Transformer for de-identifying FHIR resources according to configurable privacy rules.

   A Spark Transformer for de-identifying FHIR resources according to configurable privacy rules.

   Overview

   Performs field-level obfuscation on FHIR JSON documents using FHIR Path expressions. Supports R4, R5, and DSTU3 FHIR versions with type-aware de-identification strategies. Additionally, supports different parser types (JSON, XML) for FHIR resources.

   Example:

   1. Basic Pipeline Usage

      val deid = new FhirDeIdentification()
        .setInputCol("raw_fhir")
        .setOutputCol("deidentified")
        .setMode("obfuscate")
        .setMappingRules(Map("Patient.birthDate" -> "Date"))
      
      val pipeline = new Pipeline().setStages(Array(deid))

   See also

   FHIR Specification

4.  trait PretrainedReadableCdaDeIdentification extends ParamsAndFeaturesReadable[CdaDeIdentification] with HasPretrained[CdaDeIdentification]
5.  trait PretrainedReadableFhirDeIdentification extends ParamsAndFeaturesReadable[FhirDeIdentification] with HasPretrained[FhirDeIdentification]