Skip to main content

Administration

Description

Administration events are used to document and record that a patient has received a specific medication. This information is typically captured in the patient's electronic health record (EHR) or other relevant systems for documentation and tracking purposes.

API endpoints for Medication Administration

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/medications/administration.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Administration​

Administration - Sample Payload
{
   "Meta": {
      "DataModel": "Medications",
      "EventType": "Administration",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "7793a1b0-d035-4ced-b88c-28e286c9476a",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "415f00d5-5d11-49dc-9160-3cbbca36c468",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "eb0ba681-b029-4626-bc87-39d54caf99ad ",
            "AttemptID": ""
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "c45cdbf3-fbb0-4540-a7a9-3ade2c6ce289",
            "IDType": "EHRID"
         },
         {
            "ID": "68d11439-7fc9-4db1-92ba-b476d5694540",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "Ronnie",
         "MiddleName": "Patricks",
         "LastName": "Oliver",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Wallgate Avenue",
            "City": "San Jose",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": []
   },
   "Visit": {
      "VisitDateTime": "2022-08-16T14:21:21.386Z",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null,
         "Bed": null
      },
      "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      }
   },
   "Administrations": [
      {
         "Status": "Complete",
         "Medication": {
            "Order": {
               "ID": "68d11439-7fc9-4db1-92ba-b476d5694540"
            },
            "LotNumber": null,
            "Dose": {
               "Quantity": 4,
               "Units": "mg"
            },
            "Rate": {
               "Quantity": null,
               "Units": null
            },
            "Route": {
               "Code": "C38288",
               "CodeSystem": "2.16.840.1.113883.3.26.1.1",
               "CodeSystemName": "MSI Thesaurus",
               "Name": "Oral",
               "AltCodes": []
            },
            "Components": [],
            "Product": {
               "Code": "104894",
               "CodeSystem": "2.16.840.1.113883.6.88",
               "CodeSystemName": "RxNorm",
               "Name": "Ondanse 4 Mg Po Tbdp",
               "AltCodes": []
            },
            "Indications": []
         },
         "StartDate": "2022-08-16T14:21:20.731Z",
         "EndDate": null,
         "AdministeringProvider": {
            "NPI": "4356789876",
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Paul",
            "LastName": "Adams",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "987 Main St.",
               "City": "San Jose",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "OrderedBy": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Alex",
            "LastName": "Moon",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": " 987 Main St.",
               "City": "San Jose",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "VerifiedBy": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         }
      }
   ]
}