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 1.0.0-ballot 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 Psuedonymized data - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "psuedonymize",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition psuedonymize</b></p><a name=\"psuedonymize\"> </a><a name=\"hcpsuedonymize\"> </a><p>URL: [base]/$psuedonymize</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>key</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A key that can be used for creating the psuedonym.</p>\n</div></td></tr><tr><td>IN</td><td>algorithm</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The algorithm to be used for creating the psuedonym such as SHA256.</p>\n</div></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>\n</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>\n</div></td></tr><tr><td>OUT</td><td>psuedonymizedFileUrls</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Upon successful psuedonymization, the psuedonymized file Urls is returned back from the service.</p>\n</div></td></tr><tr><td>OUT</td><td>psuedonymizedData</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 psuedonymization, the psuedonymized data is returned back from the service. This output would be returned when the input is a bundle only.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cgp"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/darts/ImplementationGuide/darts"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/darts/ImplementationGuide/darts"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/darts/OperationDefinition/psuedonymize",
  "version" : "1.0.0-ballot",
  "name" : "Psuedonymize",
  "title" : "Generate Psuedonymized data",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-03-27T21:48:56+10:00",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        }
      ]
    }
  ],
  "description" : "Generates psuedonymized data from identifiable data. The algorithm to be used for psuedonymization is left to the DARTS service provider. Errors during the execution of the operation can be returned as OperationOutcome per the FHIR spec as a return parameter.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "psuedonymize",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "key",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A key that can be used for creating the psuedonym.",
      "type" : "string"
    },
    {
      "name" : "algorithm",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The algorithm to be used for creating the psuedonym such as SHA256.",
      "type" : "string"
    },
    {
      "name" : "identifiableDataFileUrls",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Urls of the Input Files represented as Parameters, with the type of Resource and the URL to the NDJSON data.",
      "type" : "Parameters"
    },
    {
      "name" : "identifiableData",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Bundle containing identifiable data for one or more patients.",
      "type" : "Bundle"
    },
    {
      "name" : "psuedonymizedFileUrls",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Upon successful psuedonymization, the psuedonymized file Urls is returned back from the service.",
      "type" : "Parameters"
    },
    {
      "name" : "psuedonymizedData",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Upon successful psuedonymization, the psuedonymized data is returned back from the service. This output would be returned when the input is a bundle only.",
      "type" : "Bundle"
    }
  ]
}