De-Identification, Anonymization, Redaction Toolkit Services, published by HL7 International / Cross Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-darts/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Generate Deidentified data - XML Representation

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="deidentify"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition deidentify</b></p><a name="deidentify"> </a><a name="hcdeidentify"> </a><p>URL: [base]/$deidentify</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>identifiableDataFileUrls</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Urls of the Input Files represented as Parameters, with the type of Resource and the URL to the NDJSON data.</p>
</div></td></tr><tr><td>IN</td><td>identifiableData</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>Bundle containing identifiable data for one or more patients.</p>
</div></td></tr><tr><td>IN</td><td>policy</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Policy Parameter indicating the de-identification method to use.</p>
</div></td></tr><tr><td>OUT</td><td>deidentifiedDataFileUrls</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Upon successful de-identification, the de-identified file Urls is returned back from the service.This output would be returned when the input is a set of NDJSON FileUrls only.</p>
</div></td></tr><tr><td>OUT</td><td>deidentifiedData</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>Upon successful de-identification, the de-identified data is returned back from the service. This output would be returned when the input is a bundle only.</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cgp"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/darts/ImplementationGuide/darts"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/darts/ImplementationGuide/darts"/>
      </extension>
    </valueCode>
  </extension>
  <url value="http://hl7.org/fhir/us/darts/OperationDefinition/deidentify"/>
  <version value="0.1.0"/>
  <name value="DeIdentify"/>
  <title value="Generate Deidentified data"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2026-03-27T21:48:56+10:00"/>
  <publisher value="HL7 International / Cross Group Projects"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
  </contact>
  <description
               value="Generates de-identified  data from identifiable data. The de-identification algorithm to be used is specified using the policy identifier. Errors during the execution of the operation can be returned as OperationOutcome per the FHIR spec as a return parameter."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="deidentify"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="identifiableDataFileUrls"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Urls of the Input Files represented as Parameters, with the type of Resource and the URL to the NDJSON data."/>
    <type value="Parameters"/>
  </parameter>
  <parameter>
    <name value="identifiableData"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Bundle containing identifiable data for one or more patients."/>
    <type value="Bundle"/>
  </parameter>
  <parameter>
    <name value="policy"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Policy Parameter indicating the de-identification method to use."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="deidentifiedDataFileUrls"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Upon successful de-identification, the de-identified file Urls is returned back from the service.This output would be returned when the input is a set of NDJSON FileUrls only."/>
    <type value="Parameters"/>
  </parameter>
  <parameter>
    <name value="deidentifiedData"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Upon successful de-identification, the de-identified data is returned back from the service. This output would be returned when the input is a bundle only."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>