Create a Patient

This endpoint creates a Patient. Patients should be created before a Lab Order is created for them. Not all fields are required, optional fields are marked below.

Endpoint: /v1/patients/create

Method: POST

POST Body

Param	Type	Description
EmrNumber	String	Optional. EMR (Electronic Medical Record) number, unique to the healthcare provider's system.
AccountID	String	Required. Unique identifier for the associated clinic or account.
FirstName	String	Required. Patient's first name.
MiddleInitial	String	Optional. Patient's middle initial.
LastName	String	Required. Patient's last name.
Suffix	String	Optional. Name suffix (e.g., Jr., Sr., III).
DateOfBirth	String (YYYY-MM-DD)	Required. Patient's date of birth in the format YYYY-MM-DD.
Gender	String	Required. Patient's gender (e.g., Male, Female, Other).
MaritalStatus	String	Optional. Patient's marital status (e.g., Single, Married, Divorced, Widowed, Separated, DomesticPartner, Unknown).
SocialSecurityNumber	String	Optional. Patient's social security number.
Ethnicity	String	Optional. Patient's ethnicity.
PreferredLanguage	String	Optional. Language the patient prefers for communication (e.g., English, Spanish, French, etc.).
Allergies	Array of Strings	Optional. List of known allergies.
MedicalConditions	Array of Strings	Optional. List of existing medical conditions.
Partner	Object	Required. Information about the patient's partner.
Partner.FirstName	String	Required. Partner's first name.
Partner.LastName	String	Required. Partner's last name.
Partner.DateOfBirth	String (YYYY-MM-DD)	Required. Partner's date of birth in the format YYYY-MM-DD.
Partner.Gender	String	Required. Partner's gender (e.g., Male, Female, Other).
Partner.Relationship	String	Optional. Partner's relationship to the patient.
Partner.Contact	Object	Required. Partner's contact details.
Partner.Contact.Phone	String	Required. Partner's phone number.
Partner.Contact.Email	String	Required. Partner's email address (if unavailable, use 'N/A').
Contact	Object	Required. Patient's contact details.
Contact.Phone	String	Required. Primary phone number.
Contact.MobilePhone	String	Optional. Mobile phone number.
Contact.Email	String	Required. Primary email address.
Contact.SecondaryEmailAddress	String	Optional. Secondary email address, if available.
Contact.EmergencyContact	Object	Optional. Emergency contact details.
Contact.EmergencyContact.Name	String	Optional. Emergency contact's name.
Contact.EmergencyContact.Relationship	String	Optional. Relationship of the emergency contact to the patient.
Contact.EmergencyContact.Phone	String	Optional. Emergency contact's phone number.
Contact.ContactConsent	Boolean	Required. Indicates whether the patient consents to be contacted.
Address	Object	Required. Patient's address information.
Address.AddressLine1	String	Required. Street address line 1.
Address.AddressLine2	String	Optional. Street address line 2, if applicable.
Address.City	String	Required. City of residence.
Address.State	String	Required. State or region of residence.
Address.Postcode	String	Required. Postal or ZIP code.
Address.Country	String	Optional. Country of residence.
Address.AddressType	String	Optional. Address type (e.g., Home, Work, Billing, etc.).
Insurance	Object	Optional. Patient's insurance information.
Insurance.Provider	String	Optional. Name of the insurance provider.
Insurance.PolicyNumber	String	Optional. Insurance policy number.
Insurance.GroupNumber	String	Optional. Group number associated with the insurance policy.

Request Body (JSON)

{
    "EmrNumber": "", // Optional: EMR (Electronic Medical Record) number, unique to the healthcare provider's system.
    "AccountID": "674a51bf84090f01bec2fda7", // Required: Unique identifier for the associated clinic or account.
    "FirstName": "Eva", // Required: Patient's first name.
    "MiddleInitial": "", // Optional: Patient's middle initial.
    "LastName": "Paul", // Required: Patient's last name.
    "Suffix": "", // Optional: Name suffix (e.g., Jr., Sr., III).
    "DateOfBirth": "1991-01-01", // Required: Patient's date of birth in the format YYYY-MM-DD.
    "Gender": "Female", // Required: Patient's gender (e.g., Male Female Other).
    "MaritalStatus": "Single", // Optional: Patient's marital status (e.g., Single Married Divorced Widowed Separated DomesticPartner Unknown).
    "SocialSecurityNumber": "123-45-6789", // Optional: Patient's social security number.
    "Ethnicity": "Hispanic or Latino", // Optional: Patient's ethnicity.
    "PreferredLanguage": "English", // Optional: Language the patient prefers for communication (e.g., English Spanish French German Chinese Hindi Arabic Portuguese Russian Japanese Korean Italian Dutch Other Unknown)
    "Allergies": [ 
        "Peanuts", 
        "Penicillin"
    ], // Optional: List of known allergies.
    "MedicalConditions": [
        "Diabetes", 
        "Hypertension"
    ], // Optional: List of existing medical conditions.
    "Partner": { // Required: Information about the patient's partner.
        "FirstName": "John", // Required: Partner's first name.
        "LastName": "Doe", // Required: Partner's last name.
        "DateOfBirth": "1991-01-01", // Required: Partner's date of birth in the format YYYY-MM-DD.
        "Gender": "Male", // Required: Partner's gender (e.g., Male Female Other).
        "Relationship": "Spouse", // Optional: Partner's relationship to the patient.
        "Contact": {
            "Phone": "123-456-7890", // Required: Partner's phone number.
            "Email": "[email protected]" // Required: Partner's email address (if unavailable, use 'N/A').
        }
    },
    "Contact": { // Required: Patient's contact details.
        "Phone": "[phone]", // Required: Primary phone number.
        "MobilePhone": "[phone]", // Optional: Mobile phone number.
        "Email": "[email protected]", // Required: Primary email address.
        "SecondaryEmailAddress": "", // Optional: Secondary email address, if available.
        "EmergencyContact": { 
            "Name": "John Doe", // Optional: Emergency contact's name.
            "Relationship": "Father", // Optional: Relationship of the emergency contact to the patient.
            "Phone": "123-456-7890" // Optional: Emergency contact's phone number.
        },
        "ContactConsent": true // Required: Indicates whether the patient consents to be contacted.
    },
    "Address": { // Required: Patient's address information.
        "AddressLine1": "123 main st", // Required: Street address line 1.
        "AddressLine2": "", // Optional: Street address line 2, if applicable.
        "City": "Miami", // Required: City of residence.
        "State": "Florida", // Required: State or region of residence.
        "Postcode": "[phone]", // Required: Postal or ZIP code.
        "Country": "United States", // Optional: Country of residence.
        "AddressType": "Home" // Optional: Address type, (e.g., Home Work Billing Mailing Temporary Other Unknown).
    },
    "Insurance": { // Optional: Patient's insurance information.
        "Provider": "Blue Cross", // Optional: Name of the insurance provider.
        "PolicyNumber": "XYZ123456", // Optional: Insurance policy number.
        "GroupNumber": "A78910" // Optional: Group number associated with the insurance policy.
    }
}

Responses:

Param	Type
Patient	Object
Patient.ID	String
Patient.AccountID	String
Patient.EmrNumber	String
Patient.FirstName	String
Patient.MiddleInitial	String
Patient.LastName	String
Patient.Suffix	String
Patient.DateOfBirth	String (Date)
Patient.Gender	String
Patient.MaritalStatus	String
Patient.SocialSecurityNumber	String
Patient.Ethnicity	String
Patient.PreferredLanguage	String
Patient.Allergies	Array[String]
Patient.MedicalConditions	Array[String]
Patient.Partner	Object
Patient.Partner.FirstName	String
Patient.Partner.LastName	String
Patient.Partner.DateOfBirth	String (Date)
Patient.Partner.Gender	String
Patient.Partner.Relationship	String
Patient.Partner.Contact	Object
Patient.Partner.Contact.Phone	String
Patient.Partner.Contact.Email	String
Patient.Contact	Object
Patient.Contact.Phone	String
Patient.Contact.MobilePhone	String
Patient.Contact.Email	String
Patient.Contact.SecondaryEmailAddress	String
Patient.Contact.ContactConsent	Boolean
Patient.Contact.EmergencyContact	Object
Patient.Contact.EmergencyContact.Name	String
Patient.Contact.EmergencyContact.Relationship	String
Patient.Contact.EmergencyContact.Phone	String
Patient.Contact.EmergencyContact.Email	String
Patient.Address	Object
Patient.Address.AddressLine1	String
Patient.Address.AddressLine2	String
Patient.Address.City	String
Patient.Address.State	String
Patient.Address.Postcode	String
Patient.Address.Country	String
Patient.Address.AddressType	String
Patient.Insurance	Object
Patient.Insurance.Provider	String
Patient.Insurance.PolicyNumber	String
Patient.Insurance.GroupNumber	String
Patient.IsDeleted	Boolean
Patient.SapioDetails	Object
Patient.CreatedBy	String
Patient.UpdatedBy	String
Patient.CreatedAt	String (DateTime)
Patient.UpdatedAt	String (DateTime)
message	String

Success Response (200)

{
    "Patient": {
        "ID": "6758f7984546ae79067f7051",
        "AccountID": "674a51bf84090f01bec2fda7",
        "EmrNumber": "",
        "FirstName": "Eva",
        "MiddleInitial": "",
        "LastName": "Paul",
        "Suffix": "",
        "DateOfBirth": "1991-01-01",
        "Gender": "Female",
        "MaritalStatus": "Single",
        "SocialSecurityNumber": "123-45-6789",
        "Ethnicity": "Hispanic or Latino",
        "PreferredLanguage": "English",
        "Allergies": [
            "Peanuts",
            "Penicillin"
        ],
        "MedicalConditions": [
            "Diabetes",
            "Hypertension"
        ],
        "Partner": {
            "FirstName": "John",
            "LastName": "Doe",
            "DateOfBirth": "1991-01-01",
            "Gender": "Male",
            "Relationship": "Spouse",
            "Contact": {
                "Phone": "123-456-7890",
                "Email": "[email protected]"
            }
        },
        "Contact": {
            "Phone": "[phone]",
            "MobilePhone": "[phone]",
            "Email": "[email protected]",
            "SecondaryEmailAddress": "",
            "ContactConsent": true,
            "EmergencyContact": {
                "Name": "John Doe",
                "Relationship": "Father",
                "Phone": "123-456-7890",
                "Email": ""
            }
        },
        "Address": {
            "AddressLine1": "123 main st",
            "AddressLine2": "",
            "City": "Miami",
            "State": "Florida",
            "Postcode": "[phone]",
            "Country": "United States",
            "AddressType": "Home"
        },
        "Insurance": {
            "Provider": "Blue Cross",
            "PolicyNumber": "XYZ123456",
            "GroupNumber": "A78910"
        },
        "IsDeleted": false,
        "SapioDetails": {},
        "CreatedBy": "674a42b3f1e7347c79d309e3",
        "UpdatedBy": "674a42b3f1e7347c79d309e3",
        "CreatedAt": "2024-12-11T02:23:20.635Z",
        "UpdatedAt": "2024-12-11T02:23:20.635Z"
    },
    "message": "Patient created successfully"
}

Error Response (400)

{
    "error": {
        "AccountID": "AccountID is required",
        "Address.AddressLine1": "Address.AddressLine1 is required",
        "Address.City": "Address.City is required",
        "Address.Postcode": "Address.Postcode is required",
        "Address.State": "Address.State is required",
        "Contact.Email": "Contact.Email is required",
        "Contact.Phone": "Contact.Phone is required",
        "DateOfBirth": "DateOfBirth is required",
        "FirstName": "FirstName is required",
        "Gender": "Gender is required",
        "LastName": "LastName is required",
        "Partner.DateOfBirth": "Partner.DateOfBirth is required",
        "Partner.FirstName": "Partner.FirstName is required",
        "Partner.Gender": "Partner.Gender is required",
        "Partner.LastName": "Partner.LastName is required"
    },
    "message": "Validation error"
}