New
Description
A New Medication Order message is used to initiate a request for a medication to be dispensed for a specific patient. This message typically contains information such as the medication name, dosage, route of administration, frequency, and other relevant details.
API endpoints for New
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/medications/new.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for New
New - Sample Payload
{
"Meta": {
"DataModel": "Medications",
"EventType": "New",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "11268030-b63f-465f-9c03-6ff6dc67d555",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "1b17dea0-9c13-4ce5-8ec7-5fde8a19d136",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "e63fe426-9b94-4c62-ba31-908ec99e9b98 ",
"AttemptID": "c03d62f1-8b70-4844-a01d-d70a59f18d8e"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "29db1592-e2ea-4af1-90d7-f32f4bcb4a79",
"IDType": "EHRID"
},
{
"ID": "241e6786-523d-4c4d-9689-5f02b89f4c09",
"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": "+18088698301",
"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": [],
"Allergies": [
{
"Code": "7982",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Penicillin",
"AltCodes": [],
"Substance": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null,
"AltCodes": []
},
"Reaction": [
{
"Code": "28926001",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Rashi",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
},
{
"Code": "247472004",
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Hivese",
"AltCodes": [],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Text": null
}
],
"Severity": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Criticality": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"Status": {
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": null
},
"StartDate": null,
"EndDate": null,
"Comment": null
}
]
},
"Visit": {
"VisitDateTime": "2022-08-16T14:21:21.364Z",
"VisitNumber": "12349",
"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
}
},
"Insurances": []
},
"Order": {
"ID": "241e6786-523d-4c4d-9689-5f02b89f4c09",
"Notes": [],
"Medication": {
"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": "Ondansetron 4 Mg Po Tbdp",
"AltCodes": []
},
"FreeTextSig": null,
"StartDate": "2022-08-16T14:21:20.731Z",
"EndDate": null,
"Frequency": {
"Period": 8,
"Unit": "h"
},
"IsPRN": null,
"Dispense": {
"Amount": null,
"Units": null
},
"NumberOfRefillsRemaining": null
},
"Indications": [],
"Provider": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Alex",
"LastName": "Moon",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "34 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
}
},
"EnteredBy": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Alex",
"LastName": "Moon",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 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
}
},
"Priority": null,
"Pharmacy": {
"Code": "1234567",
"Codeset": "NCPDP",
"Description": "Allstar Pharmacy",
"Address": {
"StreetAddress": "123 Maple Street",
"City": "San Jose"",
"State": "CA",
"ZIP": 53703,
"County": null,
"Country": null
},
"PhoneNumber": {
"Office": null
}
}
}
}