addRelationshipService

Web Services
API Documentation
Provider

An important component of Provider Data Management is the ability to understand and define how a given Provider (either an individual practitioner or an organization) relates to other Providers.

With Verato, a user can create direct relationships between Provider entities (mapped from LinkID to LinkID). Verato supplies pre-defined relationship types, sometimes referred to as “verbs”, to define the relationship that exists between two entities. Examples may include is employed by or is affiliated with. Customers can work with Verato customer support representatives to define additional relationship types on an as-needed basis. Relationship domains–for example Organization or Facility–are a way to group common relationship types together.

The addRelationshipService can be used to create a new relationship between Provider entities. The service relies on a valid domain, relationship type (or “verb”), and two target LinkIDs to define the relationship between.

Sample URL

The URL for this request is of the format https://custXXXX-provider.verato-connect.com/provider-link-ws/svc/addRelationshipService, where XXXX is a 4-digit number.

addRelationshipService JSON request

Note
Input values for startDate & endDate have to be specified in one the following formats:
yyyy-MM-dd'T'HH:mm:ss.SSSX
yyyy-MM-dd'T'HH:mm:ss.SSS
EEE, dd MMM yyyy HH:mm:ss zzz
yyyy-MM-dd

The request includes:
- A tracking ID (an optional identifier that the client can supply to track the response)

{ 
  "trackingId": "string", 
  "content": { 
    "relationship": { 
      "domain": "string", 
      "objectVeratoId": "string", 
      "relationshipVerb": "string", 
      "subjectVeratoId": "string", 
      "trustFactor": "string", 
      "startDate": "string", 
      "endDate": "string", 
      "status": "string" 
    } 
  } 
}

addRelationshipService JSON response

The response includes
- An ‘echo’ of the same tracking ID from the request
- Several Boolean and string values with more information about the success/failure of the service

{ 
    "success": boolean, 
    "message": "string", 
    "content": { 
        "relationship": { 
            "id": "string", 
            "subjectVeratoId": "string", 
            "objectVeratoId": "string", 
            "domain": "string", 
            "relationshipVerb": "string", 
            "startDate": "string", 
            "endDate": "string", 
            "status": "string", 
            "trustFactor": "string" 
        } 
    }, 
    "trackingId": "string", 
    "auditId": "string", 
    "retryableError": boolean 
}