getRelationshipDefinitionService

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

getRelationshipDefinitionService JSON request

getRelationshipDefinitionService is a simple service that accepts no input parameters and responds with details for all Relationship Definition Types defined within your Provider Data Management instance. You must work with your Verato customer support representatives to create the Relationship Definitions within each Provider Data Management instance configuration.

  • The request includes:

    • A tracking ID (an optional identifier that the client can supply to track the response)
  • { 
      "trackingId": "string", 
      "content": {} 
    } 

getRelationshipDefinitionService 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
    • A list of all relationship domains configured within the Provider Data Management instance. All relation types (verbs) defined within each domain are also returned as an array.
  • { 
        "success": boolean, 
        "message": "string", 
        "content": { 
            "definitions": { 
                "string": [ 
                    "string" 
                ] 
            } 
        }, 
        "trackingId": "string", 
        "auditId": "string", 
        "retryableError": boolean 
    }