getCustomLocation

JSON Schema for getCustomLocation response from Ribbon Health H1 API

HealthcareProvider DirectoryInsuranceClinical DataCare NavigationEligibilityPrice TransparencyProvider SearchHealth PlansDigital Health

Properties

Name	Type	Description
uuid	string	A UUID uniquely identifying this location
name	string
address	string
address_details	object
latitude	number
longitude	number
google_maps_link	string
phone_numbers	array
faxes	array	Fax numbers associated with this location. This property only appears for customers purchasing fax data. If you would like this property and are not receiving it, please reach out to support.
confidence	integer	Each location contains a confidence score. This score indicates the probability of the given provider practicing at said location with the included contact information This field will only be populate
insurances	array	List of insurances the accepted at this location
tins	string	Comma separated list of standard 9-digit identification code(s) used by the IRS for business entities and used for contracting and paying provider/facility claims.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "getCustomLocation",
  "description": "JSON Schema for getCustomLocation response from Ribbon Health H1 API",
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string",
      "description": "A UUID uniquely identifying this location",
      "format": "uuid",
      "example": "f38b9fd5-1e28-4f6e-953c-1e1493b68e21"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "address": {
      "type": "string",
      "example": "185 Berry St # 130, San Francisco, CA 94107, US"
    },
    "address_details": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "example": "185 Berry St # 130"
        },
        "address_line_1": {
          "type": "string",
          "example": "185 Berry St"
        },
        "address_line_2": {
          "type": "string",
          "nullable": true,
          "example": "# 130"
        },
        "city": {
          "type": "string",
          "example": "San Francisco"
        },
        "state": {
          "type": "string",
          "example": "CA"
        },
        "zip": {
          "type": "string",
          "example": "94107"
        }
      }
    },
    "latitude": {
      "type": "number",
      "example": 37.7765973
    },
    "longitude": {
      "type": "number",
      "example": -122.3919488
    },
    "google_maps_link": {
      "type": "string",
      "example": "https://www.google.com/maps/@37.7765973-122.3919488?q=185%20Berry%20St%20%23%20130%2C%20SF%2C%20CA%2094107%2C%20US"
    },
    "phone_numbers": {
      "type": "array",
      "description": "",
      "items": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "example": "4155146410"
          },
          "details": {
            "type": "string",
            "example": "primary"
          }
        }
      }
    },
    "faxes": {
      "type": "array",
      "description": "Fax numbers associated with this location.\n\nThis property only appears for customers purchasing fax data. If you would like this property and are not receiving it, please reach out to support.",
      "items": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "example": "2121234567"
          },
          "details": {
            "type": "string",
            "example": "secondary"
          },
          "confidence": {
            "type": "integer",
            "format": "int32",
            "example": 3
          }
        }
      }
    },
    "confidence": {
      "type": "integer",
      "description": "Each location contains a confidence score. This score indicates the probability of the given provider practicing at said location with the included contact information\n\nThis field will only be populated for Ribbon-provided locations. Locations you create yourself will have a confidence score of `null`.",
      "format": "int32",
      "nullable": true,
      "example": 2
    },
    "insurances": {
      "type": "array",
      "description": "List of insurances the accepted at this location",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "A UUID uniquely identifying this insurance",
            "format": "uuid",
            "example": "d8addf29-1054-4ccb-b179-dda65f7fefdd"
          },
          "carrier_association": {
            "type": "string",
            "nullable": true,
            "example": "Aetna"
          },
          "carrier_brand": {
            "type": "string",
            "nullable": true,
            "example": "Aetna"
          },
          "carrier_name": {
            "type": "string",
            "nullable": true,
            "example": "Aetna"
          },
          "state": {
            "type": "string",
            "nullable": true,
            "example": "NY"
          },
          "plan_name": {
            "type": "string",
            "nullable": true,
            "example": "Aetna HealthFund Open Choice"
          },
          "plan_type": {
            "type": "string",
            "nullable": true,
            "example": "PPO"
          },
          "metal_level": {
            "type": "string",
            "nullable": true
          },
          "display_name": {
            "type": "string",
            "example": "Aetna - HealthFund Open Choice - PPO"
          },
          "network": {
            "type": "string",
            "nullable": true
          },
          "confidence": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "example": 4
          },
          "category": {
            "type": "string",
            "nullable": true
          },
          "codes": {
            "type": "array",
            "description": "",
            "items": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              ]
            }
          }
        }
      }
    },
    "tins": {
      "type": "string",
      "description": "Comma separated list of standard 9-digit identification code(s) used by the IRS for business entities and used for contracting and paying provider/facility claims."
    }
  }
}