{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.tapmedid.com" } ], "info": { "name": "TapMedID Partner API", "_postman_id": "18dcceb1-3ec7-426f-91f1-c9419706e234", "description": "REST API for integration partners to create and manage TapMedID medical profiles, records and bracelets.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Getting started", "description": "\nEndpoints to verify your integration is wired up correctly.", "item": [ { "name": "Ping \/ verify your key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ping", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Confirms your API key works and echoes which partner and environment it is bound to.\nA good first call when setting up \u2014 if this returns `200`, your key and base URL are correct." }, "response": [ { "header": [], "code": 200, "body": "{\"ok\": true, \"environment\": \"sandbox\", \"partner\": {\"id\": 12, \"name\": \"Sunrise Senior Living\"}, \"time\": \"2026-07-23T18:04:00+00:00\"}", "name": "" } ] } ] }, { "name": "Profiles", "description": "\nMedical profiles the partner manages. Every action is scoped to the partner's own profiles,\nso ids outside your tenant return `404`. Creating a profile through the API consents it for\nyour management.", "item": [ { "name": "List profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles", "query": [ { "key": "per_page", "value": "25", "description": "Results per page (max 100). Defaults to 25.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/profiles?per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns your managed profiles, newest first, paginated." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 42, \"full_name\": \"Rosa Diaz\", \"blood_type\": \"O+\", \"devices\": []}], \"links\": {\"first\": \"...\", \"last\": \"...\", \"prev\": null, \"next\": null}, \"meta\": {\"current_page\": 1, \"per_page\": 25, \"total\": 1}}", "name": "" } ] }, { "name": "Create a profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"b\",\"last_name\":\"n\",\"middle_name\":\"g\",\"gender\":\"unspecified\",\"birth_date\":\"2026-07-23T17:26:31\",\"blood_type\":\"O+\",\"organ_donor\":false,\"living_will\":\"z\",\"religion\":\"m\",\"ssn\":\"i\",\"phone\":\"y\",\"alternate_email\":\"justina.gaylord@example.org\",\"address1\":\"i\",\"address2\":\"k\",\"city\":\"h\",\"state\":\"w\",\"zip\":\"aykcmyuwpwlvqwrs\",\"country\":\"it\",\"device\":{\"serial\":\"architecto\",\"pin\":\"architecto\",\"name\":\"n\"}}" }, "description": "Creates a managed medical profile. Optionally assign a bracelet in the same call by\nincluding a `device` object with the serial and PIN of a bracelet allocated to you." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 42, \"full_name\": \"Rosa Diaz\", \"blood_type\": \"O+\", \"devices\": [{\"id\": 7, \"serial\": \"TMID-0001\", \"activated\": true, \"emergency_url\": \"https:\/\/api.tapmedid.com\/p\/abc123\"}]}}", "name": "" } ] }, { "name": "Get a profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the profile." }, { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"id\": 42, \"full_name\": \"Rosa Diaz\", \"blood_type\": \"O+\", \"devices\": []}}", "name": "" } ] }, { "name": "Update a profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the profile." }, { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"b\",\"last_name\":\"n\",\"middle_name\":\"g\",\"gender\":\"unspecified\",\"birth_date\":\"2026-07-23T17:26:31\",\"blood_type\":\"B+\",\"organ_donor\":false,\"living_will\":\"z\",\"religion\":\"m\",\"ssn\":\"i\",\"phone\":\"y\",\"alternate_email\":\"justina.gaylord@example.org\",\"address1\":\"i\",\"address2\":\"k\",\"city\":\"h\",\"state\":\"w\",\"zip\":\"aykcmyuwpwlvqwrs\",\"country\":\"it\"}" }, "description": "Send any subset of the profile fields \u2014 all are optional here." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"id\": 42, \"full_name\": \"Rosa Diaz\", \"blood_type\": \"AB-\", \"address\": {\"city\": \"Madrid\"}}}", "name": "" } ] }, { "name": "Delete a profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the profile." }, { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft-deletes the profile and returns any bracelets linked to it back to your stock so\nthey can be re-issued. Staff can recover a deleted profile if needed." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Bracelets", "description": "\nBracelets linked to your profiles: list, assign (activate a bracelet allocated to you by\nserial + PIN), update (enable\/disable, lost mode, name) and unassign (return to your stock).\nYou can only activate bracelets that were allocated to your organization.", "item": [ { "name": "List a profile's bracelets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/devices", "variable": [ { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": 7, \"serial\": \"TMID-0001\", \"activated\": true, \"enabled\": true, \"is_lost\": false, \"emergency_url\": \"https:\/\/api.tapmedid.com\/p\/abc123\"}]}", "name": "" } ] }, { "name": "Assign a bracelet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/devices", "variable": [ { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"serial\":\"TMID-0001\",\"pin\":\"4821\",\"name\":\"Room 12\"}" }, "description": "Activates a bracelet (matched by serial + PIN) and links it to the profile. The bracelet\nmust be one allocated to your organization and not already linked to another profile." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 7, \"serial\": \"TMID-0001\", \"activated\": true, \"enabled\": true, \"emergency_url\": \"https:\/\/api.tapmedid.com\/p\/abc123\"}}", "name": "" } ] }, { "name": "Update a bracelet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices\/:device", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices\/:device", "variable": [ { "id": "device", "key": "device", "value": 7, "description": "The bracelet id." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"enabled\":true,\"view_medical_profile\":true,\"name\":\"Room 12\",\"is_lost\":false,\"lost_message\":\"Please call the front desk.\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\": {\"id\": 7, \"serial\": \"TMID-0001\", \"enabled\": true, \"is_lost\": false}}", "name": "" } ] }, { "name": "Unassign a bracelet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices\/:device", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices\/:device", "variable": [ { "id": "device", "key": "device", "value": 7, "description": "The bracelet id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deactivates the bracelet and returns it to your stock so it can be re-issued to another\nprofile." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Emergency view", "description": "\nThe at-a-glance emergency view of a profile \u2014 exactly what a first responder sees on the\npublic \/p\/{hash} page: only NON-private records, so the partner can surface the same\ncritical info inside their own app without exposing anything the patient marked private.", "item": [ { "name": "Get a profile's emergency view", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency", "variable": [ { "id": "profile", "key": "profile", "value": 42, "description": "The profile id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the profile header plus its non-private allergies, conditions, medications,\nvaccinations and emergency contacts \u2014 safe to display to first responders." }, "response": [ { "header": [], "code": 200, "body": "{\"profile\": {\"id\": 42, \"full_name\": \"Rosa Diaz\", \"blood_type\": \"O+\", \"organ_donor\": true}, \"allergies\": [{\"name\": \"Penicillin\", \"reaction\": \"Anaphylaxis\"}], \"conditions\": [], \"medications\": [], \"vaccinations\": [], \"emergency_contacts\": [{\"name\": \"Dr. House\", \"mobile\": \"+34600111222\", \"is_doctor\": true}]}", "name": "" } ] } ] }, { "name": "Allergies", "description": "\nA profile's allergies and the reactions they cause. Setting `is_private` to true\nkeeps the allergy out of the public emergency view while still storing it on the record.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/allergies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/allergies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/allergies", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add an allergy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/allergies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/allergies", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Penicillin\",\"reaction\":\"Hives and swelling\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"name\": \"Penicillin\", \"reaction\": \"Hives and swelling\", \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/allergies\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/allergies\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/allergies\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update an allergy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/allergies\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/allergies\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Penicillin\",\"reaction\":\"Hives and swelling\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/allergies\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/allergies\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/allergies\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Conditions", "description": "\nOngoing or past medical conditions and diagnoses for a profile. Setting `is_private`\nto true keeps the condition out of the public emergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/conditions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/conditions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/conditions", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add a condition", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/conditions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/conditions", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Type 2 diabetes\",\"notes\":\"Diagnosed 2019, diet controlled\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"name\": \"Type 2 diabetes\", \"notes\": \"Diagnosed 2019, diet controlled\", \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/conditions\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/conditions\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/conditions\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update a condition", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/conditions\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/conditions\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Type 2 diabetes\",\"notes\":\"Diagnosed 2019, diet controlled\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/conditions\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/conditions\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/conditions\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Medications", "description": "\nMedications a profile takes, with dosage and whether they are taken as needed.\nSetting `is_private` to true keeps the medication out of the public emergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/medications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medications", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add a medication", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medications", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Enalapril\",\"dosage\":\"10mg\",\"year\":2021,\"as_needed\":false,\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"name\": \"Enalapril\", \"dosage\": \"10mg\", \"as_needed\": false, \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/medications\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medications\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medications\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update a medication", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medications\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medications\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Enalapril\",\"dosage\":\"10mg\",\"year\":2021,\"as_needed\":false,\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/medications\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medications\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medications\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Vaccinations", "description": "\nVaccinations a profile has received, with the year and optional notes. Setting\n`is_private` to true keeps the vaccination out of the public emergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/vaccinations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/vaccinations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/vaccinations", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add a vaccination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/vaccinations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/vaccinations", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Tetanus\",\"year\":2022,\"notes\":\"Booster dose\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"name\": \"Tetanus\", \"year\": 2022, \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/vaccinations\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/vaccinations\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/vaccinations\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update a vaccination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/vaccinations\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/vaccinations\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Tetanus\",\"year\":2022,\"notes\":\"Booster dose\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/vaccinations\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/vaccinations\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/vaccinations\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Emergency contacts", "description": "\nPeople to reach in an emergency \u2014 relatives, doctors, or attorneys \u2014 with phone,\nmobile and email details and whether they should be notified. Setting `is_private`\nto true keeps the contact out of the public emergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/emergency-contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency-contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency-contacts", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add an emergency contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency-contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency-contacts", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Dr. House\",\"relation\":\"Primary physician\",\"is_doctor\":true,\"speciality\":\"Cardiology\",\"phone\":\"+34910111222\",\"phone_ext\":\"204\",\"mobile\":\"+34600111222\",\"email\":\"doctor@example.com\",\"is_attorney\":false,\"notify\":true,\"lang\":\"es\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"name\": \"Dr. House\", \"is_doctor\": true, \"mobile\": \"+34600111222\", \"email\": \"doctor@example.com\", \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/emergency-contacts\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update an emergency contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Dr. House\",\"relation\":\"Primary physician\",\"is_doctor\":true,\"speciality\":\"Cardiology\",\"phone\":\"+34910111222\",\"phone_ext\":\"204\",\"mobile\":\"+34600111222\",\"email\":\"doctor@example.com\",\"is_attorney\":false,\"notify\":true,\"lang\":\"es\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/emergency-contacts\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/emergency-contacts\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Insurances", "description": "\nHealth insurance policies held by a profile, including company, policy numbers and\nvalidity dates. Setting `is_private` to true keeps the policy out of the public\nemergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/insurances", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/insurances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/insurances", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add an insurance policy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/insurances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/insurances", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company\":\"Aetna\",\"policy_name\":\"PPO Gold\",\"policy_number\":\"A-12345\",\"medicare\":\"1EG4-TE5-MK73\",\"medicaid\":\"MD-998877\",\"hmo\":\"HMO-4521\",\"agent_name\":\"Sarah Connor\",\"valid_from\":\"2025-01-01\",\"expires_at\":\"2025-12-31\",\"description\":\"Covers dental and vision\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"company\": \"Aetna\", \"policy_number\": \"A-12345\", \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/insurances\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/insurances\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/insurances\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update an insurance policy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/insurances\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/insurances\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company\":\"Aetna\",\"policy_name\":\"PPO Gold\",\"policy_number\":\"A-12345\",\"medicare\":\"1EG4-TE5-MK73\",\"medicaid\":\"MD-998877\",\"hmo\":\"HMO-4521\",\"agent_name\":\"Sarah Connor\",\"valid_from\":\"2025-01-01\",\"expires_at\":\"2025-12-31\",\"description\":\"Covers dental and vision\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/insurances\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/insurances\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/insurances\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Medical history", "description": "\nMedical history entries. One table backs several record kinds via `type`:\ngeneral | test | hospitalization | implanted_device | additional_info.\nGET supports ?type= to filter (e.g. only implanted devices). Setting `is_private`\nto true keeps the entry out of the public emergency view.", "item": [ { "name": "List medical history entries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medical-history", "query": [ { "key": "type", "value": "implanted_device", "description": "Filter by kind: general, test, hospitalization, implanted_device, additional_info.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medical-history?type=implanted_device", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add a medical history entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medical-history", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medical-history", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"hospitalization\",\"name\":\"Appendectomy\",\"description\":\"Laparoscopic appendix removal\",\"test_date\":\"2024-03-15\",\"hospital_from\":\"2024-03-14\",\"hospital_to\":\"2024-03-16\",\"hospital_reason\":\"Acute appendicitis\",\"is_private\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"type\": \"hospitalization\", \"name\": \"Appendectomy\", \"is_private\": false}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/medical-history\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medical-history\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medical-history\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update a medical history entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medical-history\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medical-history\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"hospitalization\",\"name\":\"Appendectomy\",\"description\":\"Laparoscopic appendix removal\",\"test_date\":\"2024-03-15\",\"hospital_from\":\"2024-03-14\",\"hospital_to\":\"2024-03-16\",\"hospital_reason\":\"Acute appendicitis\",\"is_private\":false}" }, "description": "Send any subset of the create fields \u2014 all optional here." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/medical-history\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/medical-history\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/medical-history\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Documents", "description": "\nVault documents. Files are uploaded as multipart (`file`) and stored on the PRIVATE disk;\nthey are never publicly served \u2014 the API exposes a metadata record plus a signed download\nlink generated on read. Documents default to private, and setting `is_private` to true\nkeeps a document out of the public emergency view.", "item": [ { "name": "GET api\/v1\/profiles\/{profile}\/documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/documents", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Upload a document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/documents", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Insurance card", "type": "text", "description": "The document title." }, { "key": "category", "value": "Insurance", "type": "text", "description": "A grouping label." }, { "key": "is_private", "value": "1", "type": "text", "description": "Hide this document from the public emergency view." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Send as `multipart\/form-data`. The file is stored on the private disk and a signed\ndownload URL is returned in the response." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": 1, \"title\": \"Insurance card\", \"category\": \"Insurance\", \"is_private\": true, \"download_url\": \"https:\/\/example.com\/files\/documents\/1\"}}", "name": "" } ] }, { "name": "GET api\/v1\/profiles\/{profile}\/documents\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/documents\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/documents\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update a document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/documents\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/documents\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Insurance card", "type": "text", "description": "The document title." }, { "key": "category", "value": "Insurance", "type": "text", "description": "A grouping label." }, { "key": "is_private", "value": "1", "type": "text", "description": "Hide this document from the public emergency view." }, { "key": "file", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Send as `multipart\/form-data`. Send any subset of the fields \u2014 all optional here.\nInclude `file` only to replace the stored file." }, "response": [] }, { "name": "DELETE api\/v1\/profiles\/{profile}\/documents\/{record}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/profiles\/:profile\/documents\/:record", "query": [], "raw": "{{baseUrl}}\/api\/v1\/profiles\/:profile\/documents\/:record", "variable": [ { "id": "profile", "key": "profile", "value": "architecto", "description": "The profile." }, { "id": "record", "key": "record", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }