MedicAlert
MedicAlert Data can be queried by phone number or by the member's MedicAlert ID (referred to in API calls as 'maf-id'). More than one profile may be returned when querying by phone number, so to protect the privacy of MedicAlert members, queries by phone number will return a list containing MedicAlert Candidate records. These contain just enough information for a call-taker to uniquely identify the caller - name, gender, and MedicAlert ID. Queries by a valid MedicAlert ID will always return a single MedicAlert Profile record containing a complete profile.
Use Case
When a query for MedicAlert data is made by phone number, the call taker should be presented with the list of returned MedicAlert Candidate records and select the one matching the caller. The MedicAlert ID of the selected candidate should then be used to query for the complete profile, which can then be shown to the call taker.
MedicAlert Data
MedicAlert data returned under the medicalert
key.
IMPORTANT: All requests should be placed at least twice to ensure that there is no data available.
The full response structure is:
medicalert
data
candidates
- list of candidates
profile
- profile data
If no data is returned by the request, the value of data
is set to null
:
* medicalert
* data
*null
Request body for request by MedicAlert ID:
{
"query": "maf-id://999999"
}
Exceptions
MedicAlert currently uses phone numbers +10000000000 through +19999999999 (e.g., 000-000-0000, 111-111-1111, etc.)as placeholders for customers who do not have an active phone number. We recommend when leveraging this API, including exceptions for these "phone numbers" to avoid querying against them and receiving erroneous data.
This functionality should be built into the code developed for a customer using MedicAlert data on production.
If a production number is needed with non-live data please use 15555555557 or maf_id 50673864608 or 79950438355.
Examples
MedicAlert Candidates
{
"medicalert": {
"data": {
"candidates": [{
"gender": "Male",
"age": 71,
"maf-id": "5555",
"first_name": "Johnny",
"last_name": "Appleseed"
},
{
"gender": "Female",
"age": 82,
"maf-id": "1234",
"first_name": "Jane",
"last_name": "Appleseed"
}
}
]
}
}
MedicAlert Profile
{
"medicalert": {
"data": {
"profile": {
"first_name": "Johnny",
"last_name": "Appleseed",
"gender": "Male",
"age": 69,
"maf-id": "5881",
"phone": [{
"type_name": "HomePhone",
"number": "(555) 555-1234"
}, {
"type_name": "MobilePhone",
"number": "(555) 555-1235"
}
],
"dob": -631152000000,
"modified": 1514764800000,
"engraving": [{
"text": " ALLERGIES TO PEANUTS 5555",
"modified": 1514764800000
}
]
}
}
}
}
MedicAlert - No Data Returned
{
"medicalert": {
"data": null
}
}