HealthDataAIServices.DeidServices (stable:2024-11-15)

2025/02/19 • 5 updated methods

DeidentifyText (updated)
Description :  A remote procedure call (RPC) operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeidentifyText",
  "$parameters": {
    "body": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /deid
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Description: Request body for de-identification operation. ,
Required: True ,
}
{
inputText:
{
Description: Input text to de-identify. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response body for de-identification operation. ,
}
{
outputText:
{
Description: Output text after de-identification. Not available for "Tag" operation. ,
Required: False ,
}
string ,
taggerResult:
{
Description: Result of the "Tag" operation. Only available for "Tag" Operation. ,
Required: False ,
}
{
entities:
{
Description: List of entities detected in the input. ,
Required: True ,
}
[
{
category:
{
Description: PHI Category of the entity. ,
Enum:
{
Unknown: Unknown PHI Type. ,
Account: Account Number. ,
Age: Age. ,
BioID: Biological Identifier, such as a fingerprint or retinal scan. ,
City: City. ,
CountryOrRegion: Country or Region. ,
Date: Date. ,
Device: Device ID or serial numbers. ,
Doctor: Doctor's Name. ,
Email: Email Addresses. ,
Fax: Fax Number. ,
HealthPlan: Health Plan ID Numbers. ,
Hospital: Hospital Name. ,
IDNum: Id Number, eg. passport number. ,
IPAddress: IP Address. ,
License: License, eg. Driver's license or medical license. ,
LocationOther: Location Other, eg. Golden Gate Park. ,
MedicalRecord: Medical Record Number. ,
Organization: Organization, eg. Microsoft. ,
Patient: Patient Name. ,
Phone: Phone Number. ,
Profession: Profession. ,
SocialSecurity: Social Security Number. ,
State: State. ,
Street: Street. ,
Url: Web URL. ,
Username: Usernames, eg. a social media handle. ,
Vehicle: Vehicle IDs, eg. license plate or VIN number. ,
Zip: Zip Code. ,
}
,
Required: True ,
}
enum ,
offset:
{
Description: Starting index of the location from within the input text. ,
Required: True ,
}
{
utf8:
{
Description: The offset or length of the substring in UTF-8 encoding ,
Format: int32 ,
Required: True ,
}
integer ,
utf16:
{
Description: The offset or length of the substring in UTF-16 encoding. Primary encoding used by .NET, Java, and JavaScript. ,
Format: int32 ,
Required: True ,
}
integer ,
codePoint:
{
Description: The offset or length of the substring in CodePoint encoding. Primary encoding used by Python. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
length:
{
Description: Length of the input text. ,
Required: True ,
}
{
utf8:
{
Description: The offset or length of the substring in UTF-8 encoding ,
Format: int32 ,
Required: True ,
}
integer ,
utf16:
{
Description: The offset or length of the substring in UTF-16 encoding. Primary encoding used by .NET, Java, and JavaScript. ,
Format: int32 ,
Required: True ,
}
integer ,
codePoint:
{
Description: The offset or length of the substring in CodePoint encoding. Primary encoding used by Python. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
text:
{
Description: Text of the entity. ,
Required: False ,
}
string ,
confidenceScore:
{
Description: Confidence score of the category match. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListJobs (updated)
Description :  Resource list operation template.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListJobs",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "customizations": [
              {
                "#name": "redactionFormat",
                "Description": {
                  "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
                  "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
continuationToken:
{
Description: Token to continue a previous query. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of DeidentificationJob items ,
}
{
value:
{
Description: The DeidentificationJob items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetJob (updated)
Description :  Resource read operation template.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetJob",
  "$responses": {
    "200": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /jobs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A job containing a batch of documents to de-identify. ,
}
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeidentifyDocuments (updated)
Description :  Long-running resource create or replace operation template.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeidentifyDocuments",
  "$parameters": {
    "resource": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /jobs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A job containing a batch of documents to de-identify. ,
}
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A job containing a batch of documents to de-identify. ,
}
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CancelJob (updated)
Description :  Cancels a job that is in progress. The job will be marked as canceled and the service will stop processing the job. The service will not delete any documents that have already been processed. If the job is already complete, this will have no effect.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CancelJob",
  "$responses": {
    "200": {
      "$properties": {
        "customizations": [
          {
            "#name": "redactionFormat",
            "Description": {
              "new": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.",
              "old": "Format of the redacted output. Only valid when Operation is Redact. \nPlease refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /jobs/{name}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: A job containing a batch of documents to de-identify. ,
}
{
name:
{
Description: The name of a job. ,
Required: True ,
}
string ,
operation:
{
Description: Operation to perform on the input documents. ,
Enum:
{
Redact: Redact Operation will remove all entities of PHI and replace them with a placeholder value. ,
Surrogate: Surrogation Operation will replace all entities of PHI with a surrogate value. ,
Tag: Tag Operation will detect all entities of PHI, their type, and return their locations in the document. ,
}
,
Required: False ,
}
enum ,
sourceLocation:
{
Description: Storage location to perform the operation on. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Prefix to filter path by. ,
Required: True ,
}
string ,
extensions:
{
Description: List of extensions to filter path by. ,
Required: False ,
}
[
string ,
]
,
}
,
targetLocation:
{
Description: Target location to store output of operation. ,
Required: True ,
}
{
location:
{
Description: URL to storage location. ,
Format: uri ,
Required: True ,
}
string ,
prefix:
{
Description: Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure. Example: File full path: documents/user/note.txt Input Prefix: "documents/user/" Output Prefix: "output_docs/" Output file: "output_docs/note.txt" ,
Required: True ,
}
string ,
overwrite:
{
Description: When set to true during a job, the service will overwrite the output location if it already exists. ,
Required: False ,
}
boolean ,
}
,
customizations:
{
Description: Customization parameters to override default service behaviors. ,
Required: False ,
}
{
redactionFormat:
{
Description: Format of the redacted output. Only valid when Operation is Redact. Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details. ,
Required: False ,
}
string ,
surrogateLocale:
{
Description: Locale in which the output surrogates are written. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Current status of a job. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error when job fails in it's entirety. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
lastUpdatedAt:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
createdAt:
{
Description: Date and time when the job was created. ,
Format: date-time ,
Required: True ,
}
string ,
startedAt:
{
Description: Date and time when the job was started. ,
Format: date-time ,
Required: False ,
}
string ,
summary:
{
Description: Summary of a job. Exists only when the job is completed. ,
Required: False ,
}
{
successful:
{
Description: Number of documents that have completed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Number of documents that have failed. ,
Format: int32 ,
Required: True ,
}
integer ,
canceled:
{
Description: Number of documents that have been canceled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Number of documents total. ,
Format: int32 ,
Required: True ,
}
integer ,
bytesProcessed:
{
Description: Number of bytes processed. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}