Get started
API Reference
- Patient
- Contact
- Service
- Location
- Practitioner
- Appointment
- Support activity
- Support item
- Invoice
- Payment method
- Waitlist
- Screener
- Patient form
- Case
- Availability
- Payment
- Custom field
Patient
Create a single patient
Create a single patient
Copy
curl --request POST \
--url https://api.splose.com/v1/patients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"firstname": "Harry",
"lastname": "Potter",
"middleName": "James",
"preferredName": "Harry",
"title": "Mr.",
"email": "harry@hogwarts.edu",
"sex": "Male",
"genderIdentity": "Man",
"pronouns": "They/them",
"alert": "He knows magic",
"invoiceRecipientId": 1,
"birthdate": "1996-07-30T00:00:00.000Z",
"timezone": "Australia/Adelaide",
"extraInfo": "Some extra info",
"extraBillingInfo": "Some extra billing info",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"city": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"privacyPolicy": "Accepted",
"ndisNumber": "430123456",
"ndisInfo": {
"diagnosis": "Foot Injury",
"nomineeEmail": "nominee@email.com",
"fundManagement": "Plan-managed",
"nomineeLastName": "Clark",
"nomineeFirstName": "Chris",
"nomineeMobileCode": "+61",
"nomineeMobileNumber": "433555111",
"startDate": "2024-02-09T00:00:00.000Z",
"endDate": "2024-02-18T00:00:00.000Z"
},
"medicareNum": "4444444444",
"irn": "1",
"veteransFileNumber": "",
"emergencyContactNumber": "0412345678",
"emergencyContactName": "Quentin Neely",
"emergencyContactRelationship": "Brother",
"archived": false,
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}'
Copy
{
"firstname": "Harry",
"lastname": "Potter",
"middleName": "James",
"preferredName": "Harry",
"title": "Mr.",
"email": "harry@hogwarts.edu",
"sex": "Male",
"genderIdentity": "Man",
"pronouns": "They/them",
"alert": "He knows magic",
"invoiceRecipientId": 1,
"birthdate": "1996-07-30T00:00:00.000Z",
"timezone": "Australia/Adelaide",
"extraInfo": "Some extra info",
"extraBillingInfo": "Some extra billing info",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"city": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"privacyPolicy": "Accepted",
"ndisNumber": "430123456",
"ndisInfo": {
"diagnosis": "Foot Injury",
"nomineeEmail": "nominee@email.com",
"fundManagement": "Plan-managed",
"nomineeLastName": "Clark",
"nomineeFirstName": "Chris",
"nomineeMobileCode": "+61",
"nomineeMobileNumber": "433555111",
"startDate": "2024-02-09T00:00:00.000Z",
"endDate": "2024-02-18T00:00:00.000Z"
},
"medicareNum": "4444444444",
"irn": "1",
"veteransFileNumber": "",
"emergencyContactNumber": "0412345678",
"emergencyContactName": "Quentin Neely",
"emergencyContactRelationship": "Brother",
"archived": false,
"id": 1,
"patientTags": [
"Self-managed"
],
"customFields": [
{
"name": "<string>",
"value": "<string>"
}
],
"healthFund": {
"name": "AHM",
"membershipNumber": "12345678",
"patientNumber": "1",
"cardIssueNumber": "01"
},
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z",
"deletedAt": "2023-07-30T09:00:00.000Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200 - application/json
Successfully created patient
The response is of type object
.
Copy
curl --request POST \
--url https://api.splose.com/v1/patients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"firstname": "Harry",
"lastname": "Potter",
"middleName": "James",
"preferredName": "Harry",
"title": "Mr.",
"email": "harry@hogwarts.edu",
"sex": "Male",
"genderIdentity": "Man",
"pronouns": "They/them",
"alert": "He knows magic",
"invoiceRecipientId": 1,
"birthdate": "1996-07-30T00:00:00.000Z",
"timezone": "Australia/Adelaide",
"extraInfo": "Some extra info",
"extraBillingInfo": "Some extra billing info",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"city": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"privacyPolicy": "Accepted",
"ndisNumber": "430123456",
"ndisInfo": {
"diagnosis": "Foot Injury",
"nomineeEmail": "nominee@email.com",
"fundManagement": "Plan-managed",
"nomineeLastName": "Clark",
"nomineeFirstName": "Chris",
"nomineeMobileCode": "+61",
"nomineeMobileNumber": "433555111",
"startDate": "2024-02-09T00:00:00.000Z",
"endDate": "2024-02-18T00:00:00.000Z"
},
"medicareNum": "4444444444",
"irn": "1",
"veteransFileNumber": "",
"emergencyContactNumber": "0412345678",
"emergencyContactName": "Quentin Neely",
"emergencyContactRelationship": "Brother",
"archived": false,
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}'
Copy
{
"firstname": "Harry",
"lastname": "Potter",
"middleName": "James",
"preferredName": "Harry",
"title": "Mr.",
"email": "harry@hogwarts.edu",
"sex": "Male",
"genderIdentity": "Man",
"pronouns": "They/them",
"alert": "He knows magic",
"invoiceRecipientId": 1,
"birthdate": "1996-07-30T00:00:00.000Z",
"timezone": "Australia/Adelaide",
"extraInfo": "Some extra info",
"extraBillingInfo": "Some extra billing info",
"addressL1": "123 King William Street",
"addressL2": "",
"addressL3": "",
"city": "Adelaide",
"state": "SA",
"postalCode": "5000",
"country": "Australia",
"phoneNumbers": [
{
"type": "Mobile",
"code": "+61",
"phoneNumber": "401234567"
}
],
"privacyPolicy": "Accepted",
"ndisNumber": "430123456",
"ndisInfo": {
"diagnosis": "Foot Injury",
"nomineeEmail": "nominee@email.com",
"fundManagement": "Plan-managed",
"nomineeLastName": "Clark",
"nomineeFirstName": "Chris",
"nomineeMobileCode": "+61",
"nomineeMobileNumber": "433555111",
"startDate": "2024-02-09T00:00:00.000Z",
"endDate": "2024-02-18T00:00:00.000Z"
},
"medicareNum": "4444444444",
"irn": "1",
"veteransFileNumber": "",
"emergencyContactNumber": "0412345678",
"emergencyContactName": "Quentin Neely",
"emergencyContactRelationship": "Brother",
"archived": false,
"id": 1,
"patientTags": [
"Self-managed"
],
"customFields": [
{
"name": "<string>",
"value": "<string>"
}
],
"healthFund": {
"name": "AHM",
"membershipNumber": "12345678",
"patientNumber": "1",
"cardIssueNumber": "01"
},
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z",
"deletedAt": "2023-07-30T09:00:00.000Z"
}
Assistant
Responses are generated using AI and may contain mistakes.