FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.darts
Resource TypeOperationDefinition
IdOperationDefinition-deidentify.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/fhir-darts/OperationDefinition-deidentify.html
URLhttp://hl7.org/fhir/us/darts/OperationDefinition/deidentify
Version0.1.0
Statusdraft
Date2026-03-27T21:48:56+10:00
NameDeIdentify
TitleGenerate Deidentified data
Realmus
Authorityhl7
DescriptionGenerates 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.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
hl7.fhir.us.darts#currentdarts-service-providerDARTS Service Provider CapabilityStatement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition deidentify

URL: [base]/$deidentify

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
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.

INpolicy1..1string

Policy Parameter indicating the de-identification method to use.

OUTdeidentifiedDataFileUrls0..1Parameters

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.

OUTdeidentifiedData0..1Bundle

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.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "deidentify",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cgp"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_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/deidentify",
  "version": "0.1.0",
  "name": "DeIdentify",
  "title": "Generate Deidentified data",
  "status": "draft",
  "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 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": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "code": "deidentify",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "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": "policy",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Policy Parameter indicating the de-identification method to use.",
      "type": "string"
    },
    {
      "name": "deidentifiedDataFileUrls",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "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": "Parameters"
    },
    {
      "name": "deidentifiedData",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "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": "Bundle"
    }
  ]
}