Provider
Data container to represent provider information in a various places.
Provider data has following elements:
| providerId | (string) | Unique provider id. |
| first | (string) | Provider first name. |
| middle | (string) | Provider middle initial. |
| last | (string) | Provider last name |
| credentials | (string) | Provider credentials. (MD, DO, PA, OD etc). |
| specialty | (string) | Comma separated list of provider specialties. |
| NPI | (string) | National Provider Identifier. |
| abbreviation | (string) | Provider abbreviation/short code. |
| birthdate | (string) | Provider birth date. |
| sex | (string) | Provider gender (F, M). |
| languages | (string) | Comma separated list of languages. (not supported yet) |
| providerType | (string) | internal staff, contract, intern, fellow, referring, partner, etc. |
| address | (object) | Provider address. See Address data structure. |
| contactInfo | (object) | Provider contact information. See ContactInfo data structure. |
| visitTypes | (array) | Provider visit types. See VisitType element. |
| active | (string) | (0/1 or N/Y or false/true). (do not use inactive providers for scheduling) |
| configData | (element) | Set of practice specific properties and configuration values. |
XML Example:
JSON Example:
{
"providerId": "BD1969E4-81EA-470A-9594-063B47051B93",
"last": "Testdoc",
"first": "Suzanne",
"middle": "",
"credentials": "MD",
"specialty": "Ophthalmology",
"NPI": "1234567890",
"abbreviation": "DOC1",
"active": "True",
"birthdate": "1/1/1965",
"sex": "F",
"providerType": "internal",
"address": {
"addr1": "1 Park ave",
"addr2": "Suite 600",
"city": "Sunny City",
"state": "IL",
"zip": "60602"
},
"contactInfo": {
"phone": "(111) 111-1111",
"cell": "(222) 222-2222",
"fax": "(333) 333-3333",
"work": "(111) 111-1111",
"email": "suzanne@doc.net"
},
"visitTypes": [
{
"visitTypeId": "CED07165-961D-4C4E-910D-8EFEBE16F440",
"name": "Lasik Consultation",
"description": "Lasik Consultation",
"duration": "30"
},
{
"visitTypeId": "10B85F7C-A88F-4E86-8559-DB1B39C80793",
"name": "Cataract Evaluation",
"description": "Cataract Evaluation",
"duration": "30"
},
{
"visitTypeId": "67794326-8378-40CB-B49F-83DEFB1C6692",
"name": "Corneal Evaluation",
"description": "Corneal Evaluation",
"duration": "30"
}
],
"configData": {
"minAge": "18",
"maxAge": "55"
}
}
Note
Use getProviders function to retrieve a list of practice providers.
See also:
API Functions,
API Data,
Address structure,
ContactInfo structure,
VisitType structure,
GetProviders function