Overview
An overlay occurs when a postIdentity web service update to an existing Source + Native ID includes demographic data that doesn't match the record's current values, as detected by Verato's matching algorithm. An applied overlay occurs when that update is applied to the record and the identity continues through matching right away, while the resulting Applied Overlay task sits in the data stewardship queue for a steward to review.
Quarantined Applied Overlays change this behavior for organizations that need the highest-risk updates fully reviewed before they can affect matching or linking, without treating the source system's update as rejected.
What is a Quarantined Applied Overlay?
A Quarantined Applied Overlay is an enhanced Applied Overlay task where the updated record is quarantined such that although the update is accepted, it is prevented from matching or linking until a data steward resolves the task.
This behavior is available to organizations that enable it through configuration. It does not change how standard Applied Overlay or Rejected Overlay tasks behave for organizations that have not turned it on.
How Quarantined Applied Overlays differ from standard Applied Overlays
Impact on matching: A standard Applied Overlay is applied to the record immediately, and the identity is evaluated by Verato's matching algorithm right away — the Applied Overlay task exists for review, not to block anything. A Quarantined Applied Overlay separates the quarantined record’s data from the identity’s active data, so matching and linking are bypassed entirely with the quarantined record until the task is resolved.
Impact on the source system: In both cases, the source system's update is accepted rather than rejected. The difference is where the data lives in the interim — applied and live for a standard overlay, held in quarantine for a quarantined one.
Further updates to the record: Under a standard Applied Overlay, later updates to the record are processed normally. Under a Quarantined Applied Overlay, any further updates to that record are rejected until the existing task is resolved.
Effect on other records: A standard Applied Overlay can result in Link ID changes as matching runs. A Quarantined Applied Overlay cannot change Link IDs or affect any other record while the quarantine is in place.
What happens while a record is quarantined
The identity's existing Link ID and linked records are unaffected. The quarantined values sit alongside the record without being evaluated for matching.
Any new source updates to that Source + Native ID are rejected outright while the task remains open. There is no queueing or replay — the source system will need to resubmit the update after the quarantine is resolved.
Quarantine does not expire on a timer. It remains in place until a data steward resolves the Quarantined Applied Overlay task.
Resolving a Quarantined Applied Overlay task
From the task detail view, a data steward can review the quarantined demographic values alongside the record's existing values to decide what should be kept.
Quarantined values are shown with an indicator of how they should display relative to the record's existing values (for example, alongside the current value, in place of it, or both), based on when each value was first and last asserted.
A steward can deactivate individual quarantined attributes, or use the bulk action to deactivate or reactivate all quarantined attributes for that Source + Native ID at once.
Resolving the task releases the quarantine: any values the steward kept are applied to the record, and the identity becomes eligible for matching and linking again.
Example:
Updates to API Responses
When a record is quarantined, API users can take a look at the response to see if a record is initially quarantined, especially when a post fails because a record is quarantined.
PostIdentity API Response
{
"success": true,
"message": "The identity has been successfully posted.",
"content": {
"linkId": "6a7cc3ba31465983ab46dcc3",
"domains": [
{
"name": "Patient",
"id": "2"
}
],
"incomingIdentity": {
"sources": [
{
"name": "cerner",
"id": "123456"
}
],
"mergedSourceRecords": [],
"deactivatedSourceRecords": [],
"quarantinedSourceRecords": [
{
"name": "cerner",
"id": "123456"
}
],
"names": [
{
"first": "JOHN",
"last": "SMITH",
"use": "usual"
}
],
"datesOfBirth": [
"02-02-2002"
],
"ssns": [
"923-23-2191"
],
"addresses": [
{
"line1": "1 PARK AVE",
"city": "NEW YORK CITY",
"state": "NY",
"postalCode": "12345",
"country": "USA"
}
],
"genders": [],
"emails": [
"john.smith@gmail.com"
],
"phoneNumbers": [
{
"countryCode": "1",
"areaCode": "123",
"number": "1234567",
"extension": ""
}
],
"unmergeable": []
},
"events": [],
"linkIdentity": {
"linkId": "6a7cc3ba31465983ab46dcc3",
"sources": [
{
"name": "epic",
"id": "123456"
},
{
"name": "cerner",
"id": "123456"
}
],
"mergedSourceRecords": [],
"deactivatedSourceRecords": [],
"quarantinedSourceRecords": [],
"names": [
{
"clusterStatus": "ACTIVE",
"first": "JOHN",
"last": "SMITH",
"use": "usual",
"useDisplay": "Usual"
}
],
"datesOfBirth": [
"2001-01-01",
"2002-02-02"
],
"ssns": [
"564413637",
"923232191"
],
"addresses": [
{
"clusterStatus": "ACTIVE",
"line1": "1 PARK AVE",
"city": "NEW YORK CITY",
"state": "NY",
"postalCode": "12345",
"country": "USA"
}
],
"genders": [
"M"
],
"emails": [
"JOHN.SMITH@GMAIL.COM"
],
"phoneNumbers": [
{
"clusterStatus": "ACTIVE",
"countryCode": "1",
"areaCode": "123",
"number": "1234567"
}
],
"unmergeable": []
}
},
"trackingId": "string",
"retryableError": false,
"auditId": "string"
}Failed Post Due to Quarantine
{
"success": false,
"message": "operation.failed | Requested operation failed with following error : PostIdentityService failure: PostIdentityRequest failed. Cause : IngestionService failure: Error ingesting entity: source+nativeId already in the quarantined state and cannot be updated",
"trackingId": "b11182ea-eff6-41dd-9ce2-6c4ba283dfa5",
"retryableError": false,
"errors": [
"operation.failed | Requested operation failed with following error : PostIdentityService failure: PostIdentityRequest failed. Cause : IngestionService failure: Error ingesting entity: source+nativeId already in the quarantined state and cannot be updated"
],
"auditId": "7e7a29d8-f1b3-476d-bc60-0fbf9ead25c8"
}Query Responses
All query responses now include a quarantinedData object as seen below that captures all the source+nativeIds and their corresponding demographic attributes within the identity that are quarantined.
Example identityIdQuery Response
{
"success": "boolean",
"message": "string",
"content": {
"linkId": "string",
"domains": [
{
"name": "string",
"id": "string"
}
],
"identity": {
"linkId": "string",
"sources": [
{
"name": "string",
"id": "string"
}
],
"mergedSourceRecords": [
{
"name": "string",
"id": "string",
"activeSource": "string",
"activeNativeId": "string",
"timestamp": "date"
}
],
"deactivatedSourceRecords": [
{
"name": "string",
"id": "string"
}
],
"quarantinedSourceRecords": [
{
"name": "test",
"id": "C:87221"
}
],
"names": [
{
"first": "string",
"middle": "string",
"last": "string"
},
{
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string"
}
],
"datesOfBirth": [
"date"
],
"ssns": [],
"addresses": [
{
"line1": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
{
"line1": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
}
],
"genders": [
"string",
"string"
],
"emails": [
"string"
],
"phoneNumbers": [
{
"countryCode": "string",
"areaCode": "string",
"number": "string"
}
],
"unmergeable": []
},
"retiredData": {}
"deletedData": {},
"deactivatedData": {}
"quarantinedData": {
"identityGroupedBySource": [
{
"source": {
"name": "string",
"id": "string"
},
"names": [
{
"firstAsserted": "date",
"lastAsserted": "date",
"name": {
"first": "string",
"middle": "string",
"last": "string"
}
}
],
"datesOfBirth": [
{
"firstAsserted": "date",
"lastAsserted": "date",
"dateOfBirth": "date"
}
],
"ssns": [],
"addresses": [
{
"firstAsserted": "date",
"lastAsserted": "date",
"address": {
"line1": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}
}
],
"addressDetails": [
{
"firstAsserted": "date",
"lastAsserted": "date",
"addressDetails": {
"houseNumber": "string",
"streetName": "string",
"streetType": "string",
"city": "string",
"state": "string",
"zipcode": "string"
}
}
],
"genders": [
{
"firstAsserted": "date",
"lastAsserted": "date",
"gender": "string"
}
],
"emails": [],
"phoneNumbers": []
}
]
},
"requestedLinkId": "string"
},
"trackingId": "string",
"retryableError": "boolean",
"auditId": "string"
}Enabling Quarantined Applied Overlays
Quarantined Applied Overlays are gated behind a configuration flag and are not enabled by default.
Contact your Verato representative to discuss whether this behavior fits your Primary Overlay / Secondary Overlay task configuration.
Comments
0 comments
Article is closed for comments.