De-identification Batch Job

A job containing a batch of documents to de-identify.

HealthcareFHIRDICOMMedTechIoMTHealth DataHIPAAHITRUSTCloudAzureMicrosoft

Properties

Name Type Description
name string The name of a job.
operation string Operation to perform on the input documents.
sourceLocation object Storage location to perform the operation on.
targetLocation object Target location to store output of operation.
customizations object Customization parameters to override default service behaviors.
status object Current status of a job.
error object Error when job fails in it's entirety.
lastUpdatedAt string Date and time when the job was completed. If the job is canceled, this is the time when the job was canceled. If the job failed, this is the time when the job failed.
createdAt string Date and time when the job was created.
startedAt string Date and time when the job was started.
summary object Summary of a job. Exists only when the job is completed.
View JSON Schema on GitHub

JSON Schema

DeidentificationJob.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/azure-health/json-schema/DeidentificationJob.json",
  "title": "De-identification Batch Job",
  "description": "A job containing a batch of documents to de-identify.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of a job.",
      "minLength": 3,
      "maxLength": 36,
      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$",
      "readOnly": true
    },
    "operation": {
      "type": "string",
      "description": "Operation to perform on the input documents.",
      "default": "Surrogate",
      "enum": [
        "Redact",
        "Surrogate",
        "Tag"
      ],
      "x-ms-enum": {
        "name": "DeidentificationOperationType",
        "modelAsString": true,
        "values": [
          {
            "name": "Redact",
            "value": "Redact",
            "description": "Redact Operation will remove all entities of PHI and replace them with a placeholder value."
          },
          {
            "name": "Surrogate",
            "value": "Surrogate",
            "description": "Surrogation Operation will replace all entities of PHI with a surrogate value."
          },
          {
            "name": "Tag",
            "value": "Tag",
            "description": "Tag Operation will detect all entities of PHI, their type, and return their locations in the document."
          }
        ]
      }
    },
    "sourceLocation": {
      "$ref": "#/definitions/SourceStorageLocation",
      "description": "Storage location to perform the operation on."
    },
    "targetLocation": {
      "$ref": "#/definitions/TargetStorageLocation",
      "description": "Target location to store output of operation."
    },
    "customizations": {
      "$ref": "#/definitions/DeidentificationJobCustomizationOptions",
      "description": "Customization parameters to override default service behaviors."
    },
    "status": {
      "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
      "description": "Current status of a job.",
      "readOnly": true
    },
    "error": {
      "$ref": "#/definitions/Azure.Core.Foundations.Error",
      "description": "Error when job fails in it's entirety.",
      "readOnly": true
    },
    "lastUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the job was completed.\n\nIf the job is canceled, this is the time when the job was canceled.\n\nIf the job failed, this is the time when the job failed.",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the job was created.",
      "readOnly": true
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the job was started.",
      "readOnly": true
    },
    "summary": {
      "$ref": "#/definitions/DeidentificationJobSummary",
      "description": "Summary of a job. Exists only when the job is completed.",
      "readOnly": true
    }
  },
  "required": [
    "name",
    "sourceLocation",
    "targetLocation",
    "status",
    "lastUpdatedAt",
    "createdAt"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/DeidentificationJob"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.