De-Identification, Anonymization, Redaction Toolkit Services
1.0.0-ballot - STU 1 Ballot United States of America flag

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

OperationDefinition: Generate Psuedonymized data

Official URL: http://hl7.org/fhir/us/darts/OperationDefinition/psuedonymize Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: Psuedonymize

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.

All canonical (Official) URLs will be changed in the future and are not available currently on the web.

Introduction

This operation psuedonymizes data containing PHI/PII.

  • The operation takes a key and algorithm to be used for psuedonymization.

  • The operation takes a List of Resource URLs that points to identifiable data in NDJSON format and will return back a set of links to NDJSON files that contains the psuedonymized data.

  • The operation also takes a salt or key to be used for creating the psuedonym

*The algorithm to be used for psuedonymization can be specified by the consumer of the service. Examples of algorithms that can be used are SHA256, RSA384.

URL: [base]/$psuedonymize

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INkey1..1string

A key that can be used for creating the psuedonym.

INalgorithm1..1string

The algorithm to be used for creating the psuedonym such as SHA256.

INidentifiableDataFileUrls0..1Parameters

Urls of the Input Files represented as Parameters, with the type of Resource and the URL to the NDJSON data.

INidentifiableData0..1Bundle

Bundle containing identifiable data for one or more patients.

OUTpsuedonymizedFileUrls0..*Parameters

Upon successful psuedonymization, the psuedonymized file Urls is returned back from the service.

OUTpsuedonymizedData0..1Bundle

Upon successful psuedonymization, the psuedonymized data is returned back from the service. This output would be returned when the input is a bundle only.