×
Create Patient - JSON Structure
Request body for creating a patient and expected response from OpenDental API. Per OpenDental API.
Request (POST /api/patients/create):
{
"FName": "John",
"LName": "Smith",
"Birthdate": "1990-01-15",
"Gender": 0,
"Email": "john.smith@example.com",
"HmPhone": "5551234567",
"WirelessPhone": "5559876543",
"Address": "123 Main St",
"City": "Springfield",
"State": "CA",
"Zip": "12345"
}
Response (201 Created):
{
"PatNum": 48,
"LName": "Smith",
"FName": "Jane",
"MiddleI": "",
"Preferred": "",
"PatStatus": "Patient",
"Gender": "Female",
"Position": "Single",
"Birthdate": "1976-05-24",
"SSN": "",
"Address": "125 Satin Heights",
"Address2": "",
"City": "San Jose",
"State": "CA",
"Zip": "97301",
"HmPhone": "(536)624-5871",
"WkPhone": "(536)987-4822",
"WirelessPhone": "(536)987-4822",
"Guarantor": 48,
"Email": "smithfam@yahoo.com",
"EstBalance": 0.0,
"PriProv": 1,
"priProvAbbr": "DOC",
"SecProv": 0,
"secProvAbbr": "",
"FeeSched": 0,
"BillingType": "Standard Account",
"ImageFolder": "SmithJane48",
"FamFinUrgNote": "CC on file expiring soon",
"ChartNumber": "",
"MedicaidID": "",
"BalTotal": 111.9,
"EmployerNum": 0,
"DateFirstVisit": "2021-12-16",
"ClinicNum": 0,
"clinicAbbr": "",
"Premed": "false",
"Ward": "",
"PreferConfirmMethod": "None",
"PreferContactMethod": "WirelessPh",
"PreferRecallMethod": "TextMessage",
"Language": "spa",
"AdmitDate": "0001-01-01",
"siteDesc": "",
"DateTStamp": "2021-12-08 15:34:34",
"SuperFamily": 0,
"TxtMsgOk": "Unknown",
"SecDateEntry": "2021-12-04"
}
Create Request (Required: LName, FName):
- LName, FName (required); MiddleI, Preferred, PatStatus, Gender, Position
- Birthdate, SSN, Address, Address2, City, State, Zip
- HmPhone, WkPhone, WirelessPhone, Guarantor, Email
- PriProv, SecProv, FeeSched, BillingType, ChartNumber, MedicaidID, EmployerNum
- DateFirstVisit, ClinicNum, Premed, Ward, PreferConfirmMethod, PreferContactMethod, PreferRecallMethod
- Language, SuperFamily, TxtMsgOk
Response: All patient fields (see All Patients modal)