Insurance

Data container to represent Insurance information.
Insurance data has following elements:
Name Type Desciption
carrierId(string)Insurance Carrier ID
carrierName(string)Insurance Company Name
groupNumber(string)Insurance Group Number. (required)
policyNumber(string)Insurance Policy Number. (required)
insuranceType(string)Insurance Type.
insSeq(string)Insurance Seq.
policyHolder(object)Insurance Policy Holder information. See PolicyHolder for more details. (required)
insuranceCard(object)Insurance Card front and back images. See Image for more details. (not supported in this version)
Notes:
  • carrierId is practice specific value.
  • carrierId and/or carrierName are required depends on a specific practice.
  • insuranceType is a practice specific value. May vary per practice or PM/EMR system.
JSON Example:
{
  "insSeq": "1",
  "carrierId": "8CCC12D6-BB3D-41D0-80B2-A462C7509EE2",
  "carrierName": "BlueCross",
  "policyNumber": "JFF132897239847",
  "groupNumber": "123456",
  "insuranceType": "vision",

  "policyHolder": {
    "sex": "F",
    "relationship": "spouse",
    "contactInfo": {
      "phone": "6125553349",
      "cell": "6125553349",
      "email": "GGG1962@hmail.com",
      "phoneExt": null,
      "home": "6125553359",
      "work": "6125553369",
      "workExt": null,
      "altPhone": null
    },
    "address": {
      "addr1": "1247 Lodgeville Rd",
      "addr2": null,
      "city": "Minitown",
      "state": "MN",
      "zip": "55415",
      "zip4": null,
      "country": "us"
    },
    "last": "Testone",
    "first": "Mary",
    "middle": null,
    "birthdate": "03/08/1965"
  },

  "insuranceCard": {
    "frontImage": {
      "mimeType": "image/png",
      "fileName": "InsuranceCard-front.png",
      "fileSize": -1,
      "description": "Insurance Card front image",
      "content": "EFH7438743.......=="
    },
    "backImage": {
      "mimeType": "image/png",
      "fileName": "InsuranceCard-back.png",
      "fileSize": -1,
      "description": "Insurance Card back image",
      "content": "EFH7438743.......=="
    }
  }
}
XML Example:
See also:
API Functions, API Data