NAV Navbar
shell
  • Introduction
  • Authentication
  • Appointment types
  • Appointments
  • Availabilities
  • Billable Items
  • Business
  • Contacts
  • Invoices
  • Patients
  • Payments
  • Practitioners
  • Products
  • Tasks
  • Taxes
  • Treatment notes
  • Errors
  • Appendix
  • Introduction

    Welcome to the OwnerHealth API!

    We follow JSON-API standard for all endpoints. Please check list of client implementations for your language.

    Notes:

    Authentication

    curl "api_endpoint_here" \
      -H "X-API-KEY: YOUR_API_KEY"
    

    Make sure to replace YOUR_API_KEY with your API key.

    We expects for the API key to be included in all API requests to the server in a header that looks like the following:

    X-API-KEY: YOUR_API_KEY

    Appointment types

    Get all appointment types

    curl "https://owner.health/api/v1/appointment_types"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":[
        {
          "id":"1",
          "type":"appointment_types",
          "attributes":{
            "name":"Initial consultation",
            "description":"The first home visit consultation",
            "duration":60,
            "reminder_enable":true,
            "deleted_at":null,
            "updated_at":"2017-07-05T10:27:27.582Z",
            "created_at":"2017-07-05T10:27:27.582Z",
            "availability_type":"HOME_VISIT"
          }
        },
        {
          "id":"2",
          "type":"appointment_types",
          "attributes":{
            "name":"Telehealth 60 minutes",
            "description":"",
            "duration":60,
            "reminder_enable":false,
            "deleted_at":"2017-11-22T08:05:49.730Z",
            "updated_at":"2017-11-22T08:03:09.406Z",
            "created_at":"2017-11-22T08:03:09.406Z",
            "availability_type":"TELEHEALTH"
          }
        },
        {
          "id":"3",
          "type":"appointment_types",
          "attributes":{
            "name":"Facility appointment",
            "description":"",
            "duration":120,
            "reminder_enable":false,
            "deleted_at":null,
            "updated_at":"2017-10-07T08:25:56.015Z",
            "created_at":"2017-10-07T08:25:56.015Z",
            "availability_type":"FACILITY"
          }
        }
      ],
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 3
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves all appointment types.

    HTTP Request

    GET https://owner.health/api/v1/appointment_types

    Query Parameters

    To be updated ...

    Get an appointment type

    curl "https://owner.health/api/v1/appointment_types/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id":"1",
        "type":"appointment_types",
        "attributes":{
          "name":"Initial consultation",
          "description":"The first home visit consultation",
          "duration":60,
          "reminder_enable":true,
          "deleted_at":null,
          "updated_at":"2017-07-05T10:27:27.582Z",
          "created_at":"2017-07-05T10:27:27.582Z",
          "availability_type":"HOME_VISIT"
        }
      },
      "links": {
        "self": "https://owner.health/api/v1/appointment_types",
        "first": "https://owner.health/api/v1/appointment_types",
        "last": "https://owner.health/api/v1/appointment_types"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 3
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves a specific appointment type.

    HTTP Request

    GET https://owner.health/api/v1/appointment_types/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the appointment type to retrieve

    Appointments

    Get all Appointments

    curl "https://owner.health/api/v1/appointments"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "4",
          "type": "appointments",
          "attributes": {
            "start_time": "2017-11-22T00:00:00.000Z",
            "end_time": "2017-11-22T05:00:00.000Z",
            "booked_online": false,
            "status": "completed",
            "break_times": 5,
            "notes": "",
            "cancelled_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T11:35:57.807Z",
            "created_at": "2017-11-22T11:35:57.807Z"
          },
          "relationships": {
            "patient": {
              "data": {
                "type": "patients",
                "id": "1"
              }
            },
            "appointment_type": {
              "data": {
                "type": "appointment_types",
                "id": "2"
              }
            },
            "availability": {
              "data": {
                "type": "availabilities",
                "id": "2"
              }
            },
            "practitioner": {
              "data": {
                "type": "practitioners",
                "id": "2"
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/appointments/4"
          }
        },
        {
          "id": "5",
          "type": "appointments",
          "attributes": {
            "start_time": "2017-11-22T22:00:00.000Z",
            "end_time": "2017-11-23T02:30:00.000Z",
            "booked_online": false,
            "status": "completed",
            "notes": "",
            "cancelled_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-23T03:26:06.646Z",
            "created_at": "2017-11-23T03:26:06.646Z"
          },
          "relationships": {
            "patient": {
              "data": {
                "type": "patients",
                "id": "1"
              }
            },
            "appointment_type": {
              "data": {
                "type": "appointment_types",
                "id": "2"
              }
            },
            "availability": {
              "data": {
                "type": "availabilities",
                "id": "3"
              }
            },
            "practitioner": {
              "data": {
                "type": "practitioners",
                "id": "2"
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/appointments/5"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/appointments",
        "first": "https://owner.health/api/v1/appointments",
        "last": "https://owner.health/api/v1/appointments"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 3
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all appointments.

    HTTP Request

    GET https://owner.health/api/v1/appointments

    Query Parameters

    To be updated ...

    Get an Appointment

    curl "https://owner.health/api/v1/appointments/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "4",
        "type": "appointments",
        "attributes": {
          "start_time": "2017-11-22T00:00:00.000Z",
          "end_time": "2017-11-22T05:00:00.000Z",
          "booked_online": false,
          "status": "completed",
          "break_times": 5,
          "notes": "",
          "cancelled_at": null,
          "deleted_at": null,
          "updated_at": "2017-11-22T11:35:57.807Z",
          "created_at": "2017-11-22T11:35:57.807Z"
        },
        "relationships": {
          "patient": {
            "data": {
              "type": "patients",
              "id": "1"
            }
          },
          "appointment_type": {
            "data": {
              "type": "appointment_types",
              "id": "2"
            }
          },
          "availability": {
            "data": {
              "type": "availabilities",
              "id": "2"
            }
          },
          "practitioner": {
            "data": {
              "type": "practitioners",
              "id": "2"
            }
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/appointments/4"
        }
      },
      "included": [
        {
          "id": "1",
          "type": "patients",
          "attributes": {
            "attributes": {
              "first_name": "Austin",
              "last_name": "Bosco",
              "full_name": "Austin Bosco",
              "dob": "1985-05-10",
              "email": "harold@example.org",
              "gender": "Male",
              "phone": "(08) 2411 8661",
              "mobile": "0578 731 003",
              "fax": "(08) 2411 8661",
              "address1": "20 Beatrice Tce",
              "address2": "",
              "city": "Ascot",
              "state": "QLD",
              "postcode": "4007",
              "country": "AU",
              "reminder_enable": true,
              "next_of_kin": "",
              "general_info": "",
              "medicare_card_number": null,
              "medicare_card_irn": null,
              "medicare_referrer_name": null,
              "medicare_referrer_provider_number": null,
              "medicare_referral_date": null,
              "dva_file_number": null,
              "dva_card_type": null,
              "dva_referrer_name": null,
              "dva_referrer_provider_number": null,
              "dva_referral_date": null,
              "archived_at": null,
              "deleted_at": null,
              "updated_at": "2017-11-22T10:22:27.376Z",
              "created_at": "2017-11-22T09:02:47.949Z"
            },
            "links": {
              "self": "https://owner.health/api/v1/patients/1"
            }
          }
        },
        {
          "id": "2",
          "type": "appointment_types",
          "attributes": {
            "name": "Subsequent consultation",
            "description": "A subsequent home visit consultation",
            "duration": 45,
            "reminder_enable": true,
            "deleted_at": null,
            "updated_at": "2017-11-22T09:02:47.667Z",
            "created_at": "2017-11-22T09:02:47.667Z",
            "availability_type": "HOME_VISIT"
          },
          "links": {
            "self": "https://owner.health/api/v1/appointment_types/2"
          }
        },
        {
          "id": "2",
          "type": "availabilities",
          "attributes": {
            "start_time": "2017-11-22T00:00:00.000Z",
            "end_time": "2017-11-22T05:00:00.000Z",
            "address1": "22-23 Liverpool St",
            "address2": null,
            "city": "London",
            "state": "England",
            "postcode": "EC2M 7PD",
            "country": "GB",
            "max_appointment": 5,
            "service_radius": 10,
            "latitude": 51.5172821,
            "longitude": -0.0823386,
            "allow_online_bookings": true,
            "appointments_count": 1,
            "updated_at": "2017-11-22T11:35:48.868Z",
            "created_at": "2017-11-22T11:35:48.868Z",
            "availability_type": "HOME_VISIT"
          },
          "relationships": {
            "appointments": {
              "meta": {
                "included": false
              }
            },
            "contact": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/availabilities/2"
          }
        },
        {
          "id": "2",
          "type": "practitioners",
          "attributes": {
            "first_name": "Brady",
            "last_name": "Leuschke",
            "active": true,
            "education": "",
            "profession": "",
            "ahpra": "",
            "medicare": "",
            "phone": "",
            "mobile": "",
            "address1": "27 Liverpool St",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "",
            "country": "GB",
            "summary": "",
            "clinic_name": "",
            "clinic_website": "",
            "updated_at": "2017-11-23T15:30:57.210Z",
            "created_at": "2017-11-22T11:12:48.724Z",
            "avatar": "",
            "driver_license": null,
            "ahpra_registration": null,
            "email": "nilda_kessler@example.com",
            "medicare_provider_documentation": null,
            "police_check": null,
            "insurance_document": null,
            "signature": null
          },
          "links": {
            "self": "https://owner.health/api/v1/practitioners/2"
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific appointment.

    HTTP Request

    GET https://owner.health/api/v1/appointments/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the patient to retrieve

    Availabilities

    Get all Availabilities

    curl "https://owner.health/api/v1/availabilities"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "4",
          "type": "availabilities",
          "attributes": {
            "start_time": "2017-11-25T01:00:00.000Z",
            "end_time": "2017-11-25T07:00:00.000Z",
            "address1": "27 Liverpool St",
            "address2": null,
            "city": "London",
            "state": "England",
            "postcode": "EC2M",
            "country": "GB",
            "max_appointment": 5,
            "service_radius": 10,
            "latitude": 51.517237,
            "longitude": -0.0830592,
            "allow_online_bookings": true,
            "updated_at": "2017-11-23T15:19:55.087Z",
            "created_at": "2017-11-23T15:19:55.087Z",
            "availability_type": "HOME_VISIT"
          },
          "relationships": {
            "appointments": {
              "meta": {
                "included": false
              }
            },
            "contact": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/availabilities/4"
          },
          "meta": {
            "appointments_count": 1
          }
        },
        {
          "id": "3",
          "type": "availabilities",
          "attributes": {
            "start_time": "2017-11-22T22:00:00.000Z",
            "end_time": "2017-11-23T02:30:00.000Z",
            "address1": "1 Liverpool St",
            "address2": null,
            "city": "London",
            "state": "England",
            "postcode": "EC2M 7AY",
            "country": "GB",
            "max_appointment": 5,
            "service_radius": 10,
            "latitude": 51.517566,
            "longitude": -0.0841687,
            "allow_online_bookings": true,
            "updated_at": "2017-11-23T03:25:55.738Z",
            "created_at": "2017-11-23T03:25:55.738Z",
            "availability_type": "HOME_VISIT"
          },
          "relationships": {
            "appointments": {
              "meta": {
                "included": false
              }
            },
            "contact": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/availabilities/3"
          },
          "meta": {
            "appointments_count": 1
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/availabilities",
        "first": "https://owner.health/api/v1/availabilities",
        "last": "https://owner.health/api/v1/availabilities",
        "next": "https://owner.health/api/v1/availabilities?page[number]=2"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 2,
        "total_entries": 3
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all availabilities.

    HTTP Request

    GET https://owner.health/api/v1/availabilities

    Query Parameters

    To be updated ...

    Get an Availability

    curl "https://owner.health/api/v1/availabilities/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "4",
        "type": "availabilities",
        "attributes": {
          "start_time": "2017-11-25T01:00:00.000Z",
          "end_time": "2017-11-25T07:00:00.000Z",
          "address1": "27 Liverpool St",
          "address2": null,
          "city": "London",
          "state": "England",
          "postcode": "EC2M",
          "country": "GB",
          "max_appointment": 5,
          "service_radius": 10,
          "latitude": 51.517237,
          "longitude": -0.0830592,
          "allow_online_bookings": true,
          "updated_at": "2017-11-23T15:19:55.087Z",
          "created_at": "2017-11-23T15:19:55.087Z",
          "availability_type": "HOME_VISIT"
        },
        "relationships": {
          "appointments": {
            "data": [
              {
                "type": "appointments",
                "id": "6"
              }
            ]
          },
          "contact": {
            "data": null
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/availabilities/4"
        },
        "meta": {
          "appointments_count": 1
        }
      },
      "included": [
        {
          "id": "6",
          "type": "appointments",
          "attributes": {
            "start_time": "2017-11-25T01:00:00.000Z",
            "end_time": "2017-11-25T07:00:00.000Z",
            "booked_online": false,
            "status": "completed",
            "notes": "",
            "cancelled_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-23T15:20:06.891Z",
            "created_at": "2017-11-23T15:20:06.891Z"
          },
          "relationships": {
            "patient": {
              "meta": {
                "included": false
              }
            },
            "appointment_type": {
              "meta": {
                "included": false
              }
            },
            "availability": {
              "meta": {
                "included": false
              }
            },
            "practitioner": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/appointments/6"
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific availability.

    HTTP Request

    GET https://owner.health/api/v1/availabilities/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the patient to retrieve

    Billable Items

    Get all Billable Items

    curl "https://owner.health/api/v1/billable_items"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "1",
          "type": "billable_items",
          "attributes": {
            "name": "Initial consultation",
            "description": "The first home visit consultation",
            "item_number": "500",
            "price": "130.0",
            "health_insurance_rebate": true,
            "created_at": "2017-11-22T09:02:47.515Z"
          },
          "relationships": {
            "tax": {
              "meta": {
                "included": false
              }
            }
          }
        },
        {
          "id": "2",
          "type": "billable_items",
          "attributes": {
            "name": "Subsequent consultation",
            "description": "A subsequent home visit consultation",
            "item_number": "505",
            "price": "100.0",
            "health_insurance_rebate": true,
            "created_at": "2017-11-22T09:02:47.525Z"
          },
          "relationships": {
            "tax": {
              "meta": {
                "included": false
              }
            }
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/billable_items",
        "first": "https://owner.health/api/v1/billable_items",
        "last": "https://owner.health/api/v1/billable_items"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 2
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all billable items.

    HTTP Request

    GET https://owner.health/api/v1/billable_items

    Query Parameters

    To be updated ...

    Get a Billable Item

    curl "https://owner.health/api/v1/billable_items/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "billable_items",
        "attributes": {
          "name": "Initial consultation",
          "description": "The first home visit consultation",
          "item_number": "500",
          "price": "130.0",
          "health_insurance_rebate": true,
          "created_at": "2017-11-22T09:02:47.515Z"
        },
        "relationships": {
          "tax": {
            "data": {
              "type": "taxes",
              "id": "1"
            }
          }
        }
      },
      "included": [
        {
          "id": "1",
          "type": "taxes",
          "attributes": {
            "name": "GST",
            "rate": 10.0
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific billable item.

    HTTP Request

    GET https://owner.health/api/v1/billable_items/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the billable item to retrieve

    Business

    Get Business Profile

    curl "https://owner.health/api/v1/business"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "businesses",
        "attributes": {
          "name": "Verlie Lemke",
          "phone": "(03) 0761 7909",
          "mobile": "0546 341 712",
          "website": "example.org",
          "fax": "(03) 0761 7909",
          "email": "marnie@example.org",
          "address1": "315 Myriam Freeway",
          "address2": null,
          "city": "Maloriechester",
          "state": "SA",
          "postcode": "2250",
          "country": "AU",
          "bank_name": null,
          "bank_branch_number": "",
          "bank_account_name": "",
          "bank_account_number": "",
          "abn": "",
          "logo": null,
          "abn_document": null
        },
        "links": {
          "self": "https://owner.health/api/v1/business"
        }
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific business.

    HTTP Request

    GET https://owner.health/api/v1/business

    Contacts

    Get all Contacts

    curl "https://owner.health/api/v1/contacts"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "2",
          "type": "contacts",
          "attributes": {
            "business_name": "Leandro Zemlak",
            "title": "Mr",
            "first_name": "Leandro",
            "last_name": "Zemlak",
            "phone": "(07) 2797 1966",
            "mobile": "0498 571 201",
            "fax": "(07) 2797 1966",
            "email": "asley@example.com",
            "address1": "120 Euston Rd",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "NW1 2AL",
            "country": "GB",
            "notes": "",
            "deleted_at": null,
            "updated_at": "2017-11-25T03:55:07.209Z",
            "created_at": "2017-11-25T03:55:07.209Z"
          }
        },
        {
          "id": "1",
          "type": "contacts",
          "attributes": {
            "business_name": "Marketta Crooks",
            "title": "Mr",
            "first_name": "Marketta",
            "last_name": "Crooks",
            "phone": "(03) 4164 7163",
            "mobile": "0458 747 257",
            "fax": "(03) 4164 7163",
            "email": "antonia@example.org",
            "address1": "20 Beatrice Tce",
            "address2": null,
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "notes": "Voluptatibus voluptas tempora et aut rem.",
            "deleted_at": null,
            "updated_at": "2017-11-22T09:02:47.835Z",
            "created_at": "2017-11-22T09:02:47.835Z"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/contacts",
        "first": "https://owner.health/api/v1/contacts",
        "last": "https://owner.health/api/v1/contacts"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 5
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all contacts.

    HTTP Request

    GET https://owner.health/api/v1/contacts

    Query Parameters

    To be updated ...

    Create a Contact

    curl "https://owner.health/api/v1/contacts"
      -H "X-API-KEY: YOUR_API_KEY"
      -H "Content-Type: application/json"
      -X POST
      -d 
      '{
        "data":{
          "type":"contacts",
          "attributes":{
            "business_name": "Marketta Crooks",
            "title": "Mr",
            "first_name": "Marketta",
            "last_name": "Crooks",
            "phone": "(03) 4164 7163",
            "mobile": "0458 747 257",
            "fax": "(03) 4164 7163",
            "email": "antonia@example.org",
            "address1": "20 Beatrice Tce",
            "address2": null,
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "notes": "Voluptatibus voluptas tempora et aut rem.",
            "metadata": {
              "tall": "175cm",
              "weight": "45kg",
              "ref_num": "X0206"
            }
          }
        }
      }'
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id":"1",
        "type":"contacts",
        "attributes":{
          "business_name": "Marketta Crooks",
          "title": "Mr",
          "first_name": "Marketta",
          "last_name": "Crooks",
          "phone": "(03) 4164 7163",
          "mobile": "0458 747 257",
          "fax": "(03) 4164 7163",
          "email": "antonia@example.org",
          "address1": "20 Beatrice Tce",
          "address2": null,
          "city": "Ascot",
          "state": "QLD",
          "postcode": "4007",
          "country": "AU",
          "notes": "Voluptatibus voluptas tempora et aut rem.",
          "metadata": {
            "tall": "175cm",
            "weight": "45kg",
            "ref_num": "X0206"
          }
        }
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint create a contact.

    HTTP Request

    POST https://owner.health/api/v1/contacts

    Get a Contact

    curl "https://owner.health/api/v1/contacts/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id":"1",
        "type":"contacts",
        "attributes":{
          "business_name": "Marketta Crooks",
          "title": "Mr",
          "first_name": "Marketta",
          "last_name": "Crooks",
          "phone": "(03) 4164 7163",
          "mobile": "0458 747 257",
          "fax": "(03) 4164 7163",
          "email": "antonia@example.org",
          "address1": "20 Beatrice Tce",
          "address2": null,
          "city": "Ascot",
          "state": "QLD",
          "postcode": "4007",
          "country": "AU",
          "notes": "Voluptatibus voluptas tempora et aut rem.",
          "deleted_at": null,
          "updated_at": "2017-11-22T09:02:47.835Z",
          "created_at": "2017-11-22T09:02:47.835Z"
        }
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves a specific contact.

    HTTP Request

    GET https://owner.health/api/v1/contacts/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the contact to retrieve

    Update a Contact

    curl "https://owner.health/api/v1/contacts/1"
      -H "X-API-KEY: YOUR_API_KEY"
      -H "Content-Type: application/json"
      -X PATCH
      -d 
      '{
        "data":{
          "id":"1",
          "type":"contacts",
          "attributes":{
            "business_name": "Marketta Crooks",
            "title": "Mr",
            "first_name": "Marketta",
            "last_name": "Crooks",
            "phone": "(03) 4164 7163",
            "mobile": "0458 747 257",
            "fax": "(03) 4164 7163",
            "email": "antonia@example.org",
            "address1": "20 Beatrice Tce",
            "address2": null,
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "notes": "Quisque velit nisi, pretium ut lacinia in, elementum id enim.",
            "metadata": {
              "tall": "180cm",
              "weight": "80kg"
            }
          }
        }
      }'
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id":"1",
        "type":"contacts",
        "attributes":{
          "business_name": "Marketta Crooks",
          "title": "Mr",
          "first_name": "Marketta",
          "last_name": "Crooks",
          "phone": "(03) 4164 7163",
          "mobile": "0458 747 257",
          "fax": "(03) 4164 7163",
          "email": "antonia@example.org",
          "address1": "20 Beatrice Tce",
          "address2": null,
          "city": "Ascot",
          "state": "QLD",
          "postcode": "4007",
          "country": "AU",
          "notes": "Quisque velit nisi, pretium ut lacinia in, elementum id enim.",
          "deleted_at": null,
          "updated_at": "2017-11-22T09:02:47.835Z",
          "created_at": "2017-11-22T09:02:47.835Z",
          "metadata": {
            "tall": "180cm",
            "weight": "80kg"
          }
        }
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint update a contact.

    HTTP Request

    PATCH https://owner.health/api/v1/contacts/<ID>

    Invoices

    Get all Invoices

    curl "https://owner.health/api/v1/invoices"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "3",
          "type": "invoices",
          "attributes": {
            "invoice_number": "00003",
            "issue_date": "2017-11-22",
            "amount": "100.0",
            "outstanding": "0.0",
            "deleted_at": null,
            "updated_at": "2017-11-23T03:16:41.724Z",
            "created_at": "2017-11-22T11:34:42.407Z"
          },
          "relationships": {
            "patient": {
              "data": {
                "type": "patients",
                "id": "1"
              }
            },
            "items": {
              "data": [
                {
                  "type": "invoice_items",
                  "id": "4"
                }
              ]
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/invoices/3"
          }
        },
        {
          "id": "2",
          "type": "invoices",
          "attributes": {
            "invoice_number": "00002",
            "issue_date": "2017-11-22",
            "amount": "130.0",
            "outstanding": "130.0",
            "deleted_at": null,
            "updated_at": "2017-11-22T11:13:18.083Z",
            "created_at": "2017-11-22T11:13:18.083Z"
          },
          "relationships": {
            "patient": {
              "data": {
                "type": "patients",
                "id": "1"
              }
            },
            "items": {
              "data": [
                {
                  "type": "invoice_items",
                  "id": "3"
                }
              ]
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/invoices/2"
          }
        }
      ],
      "included": [
        {
          "id": "1",
          "type": "patients",
          "attributes": {
            "first_name": "Janna",
            "last_name": "Strosin",
            "full_name": "Janna Strosin",
            "dob": "1989-05-10",
            "email": "keren@example.com",
            "gender": "Male",
            "phone": "(07) 4141 8512",
            "mobile": "0418 948 918",
            "fax": "(07) 4141 8512",
            "address1": "120 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          },
          "links": {
            "self": "https://owner.health/api/v1/patients/1"
          }
        },
        {
          "id": "4",
          "type": "invoice_items",
          "attributes": {
            "name": "Subsequent consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "100.0",
            "description": "Subsequent consultation",
            "item_code": "505",
            "tax_rate": null,
            "amount": "100.0"
          }
        },
        {
          "id": "3",
          "type": "invoice_items",
          "attributes": {
            "name": "Initial consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "130.0",
            "description": "Initial consultation",
            "item_code": "500",
            "tax_rate": null,
            "amount": "130.0"
          }
        },
        {
          "id": "1",
          "type": "invoice_items",
          "attributes": {
            "name": "Initial consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "130.0",
            "description": "Initial consultation",
            "item_code": "500",
            "tax_rate": null,
            "amount": "130.0"
          }
        },
        {
          "id": "2",
          "type": "invoice_items",
          "attributes": {
            "name": "Subsequent consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "100.0",
            "description": "Subsequent consultation",
            "item_code": "505",
            "tax_rate": null,
            "amount": "100.0"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/invoices",
        "first": "https://owner.health/api/v1/invoices",
        "last": "https://owner.health/api/v1/invoices"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 4
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all invoices.

    HTTP Request

    GET https://owner.health/api/v1/invoices

    Query Parameters

    Parameter Default Description
    name blank Search invoices by name

    Get an Invoice

    curl "https://owner.health/api/v1/invoices/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "invoices",
        "attributes": {
          "invoice_number": "00001",
          "issue_date": "2017-11-22",
          "amount": "230.0",
          "outstanding": "218.0",
          "deleted_at": null,
          "updated_at": "2017-11-22T10:15:06.475Z",
          "created_at": "2017-11-22T09:17:10.495Z"
        },
        "relationships": {
          "patient": {
            "data": {
              "type": "patients",
              "id": "1"
            }
          },
          "items": {
            "data": [
              {
                "type": "invoice_items",
                "id": "1"
              },
              {
                "type": "invoice_items",
                "id": "2"
              }
            ]
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/invoices/1"
        }
      },
      "included": [
        {
          "id": "1",
          "type": "patients",
          "attributes": {
            "first_name": "Janna",
            "last_name": "Strosin",
            "full_name": "Janna Strosin",
            "dob": "1989-05-10",
            "email": "keren@example.com",
            "gender": "Male",
            "phone": "(07) 4141 8512",
            "mobile": "0418 948 918",
            "fax": "(07) 4141 8512",
            "address1": "120 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          },
          "links": {
            "self": "https://owner.health/api/v1/patients/1"
          }
        },
        {
          "id": "1",
          "type": "invoice_items",
          "attributes": {
            "name": "Initial consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "130.0",
            "description": "Initial consultation",
            "item_code": "500",
            "tax_rate": null,
            "amount": "130.0"
          }
        },
        {
          "id": "2",
          "type": "invoice_items",
          "attributes": {
            "name": "Subsequent consultation",
            "type": "BillableItem",
            "quantity": 1,
            "unit_price": "100.0",
            "description": "Subsequent consultation",
            "item_code": "505",
            "tax_rate": null,
            "amount": "100.0"
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific invoice.

    HTTP Request

    GET https://owner.health/api/v1/invoices/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the invoice to retrieve

    Patients

    Get all Patients

    curl "https://owner.health/api/v1/patients"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "2",
          "type": "patients",
          "attributes": {
            "first_name": "Austin",
            "last_name": "Bosco",
            "full_name": "Austin Bosco",
            "dob": "1985-05-10",
            "email": "harold@example.org",
            "gender": "Male",
            "phone": "(08) 2411 8661",
            "mobile": "0578 731 003",
            "fax": "(08) 2411 8661",
            "address1": "20 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          }
        },
        {
          "id": "1",
          "type": "patients",
          "attributes": {
            "first_name": "Janna",
            "last_name": "Strosin",
            "full_name": "Janna Strosin",
            "dob": "1989-05-10",
            "email": "keren@example.com",
            "gender": "Male",
            "phone": "(07) 4141 8512",
            "mobile": "0418 948 918",
            "fax": "(07) 4141 8512",
            "address1": "120 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/patients",
        "first": "https://owner.health/api/v1/patients",
        "last": "https://owner.health/api/v1/patients"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 5
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all patients.

    HTTP Request

    GET https://owner.health/api/v1/patients

    Query Parameters

    Available filter fields:

    Field Type Operators
    first_name String eq, cont
    last_name String eq, cont
    full_name String eq, cont
    phone String eq, cont
    mobile String eq, cont
    email String eq, cont
    city String eq
    state String eq
    postcode String eq
    gender String eq, in
    medicare_details String present
    dva_details String present
    created_at Datetime lt, lteq, gt, gteq
    updated_at String lt, lteq, gt, gteq

    Get a Patient

    curl "https://owner.health/api/v1/patients/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id": "1",
        "type": "patients",
        "attributes": {
          "first_name": "Janna",
          "last_name": "Strosin",
          "full_name": "Janna Strosin",
          "dob": "1989-05-10",
          "email": "keren@example.com",
          "gender": "Male",
          "phone": "(07) 4141 8512",
          "mobile": "0418 948 918",
          "fax": "(07) 4141 8512",
          "address1": "120 Beatrice Tce",
          "address2": "",
          "city": "Ascot",
          "state": "QLD",
          "postcode": "4007",
          "country": "AU",
          "reminder_enable": true,
          "next_of_kin": "",
          "general_info": "",
          "medicare_card_number": null,
          "medicare_card_irn": null,
          "medicare_referrer_name": null,
          "medicare_referrer_provider_number": null,
          "medicare_referral_date": null,
          "dva_file_number": null,
          "dva_card_type": null,
          "dva_referrer_name": null,
          "dva_referrer_provider_number": null,
          "dva_referral_date": null,
          "archived_at": null,
          "deleted_at": null,
          "updated_at": "2017-11-22T10:22:27.376Z",
          "created_at": "2017-11-22T09:02:47.949Z"
        }
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves a specific patient.

    HTTP Request

    GET https://owner.health/api/v1/patients/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the patient to retrieve

    Payments

    Get all Payments

    curl "https://owner.health/api/v1/payments"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "2",
          "type": "payments",
          "attributes": {
            "payment_date": "2017-11-23",
            "eftpos": "0.0",
            "hicaps": "0.0",
            "cash": "100.0",
            "medicare": "0.0",
            "workcover": "0.0",
            "dva": "0.0",
            "direct_deposit": "0.0",
            "stripe": "0.0",
            "other": "0.0",
            "created_at": "2017-11-23T03:16:41.692Z",
            "updated_at": "2017-11-23T03:16:41.692Z",
            "deleted_at": null,
            "total_amount": "100.0"
          },
          "relationships": {
            "patient": {
              "meta": {
                "included": false
              }
            },
            "invoice": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/payments/2"
          }
        },
        {
          "id": "1",
          "type": "payments",
          "attributes": {
            "payment_date": "2017-11-22",
            "eftpos": "0.0",
            "hicaps": "0.0",
            "cash": "2.0",
            "medicare": "2.0",
            "workcover": "2.0",
            "dva": "2.0",
            "direct_deposit": "2.0",
            "stripe": "0.0",
            "other": "2.0",
            "created_at": "2017-11-22T10:15:06.469Z",
            "updated_at": "2017-11-22T10:15:06.469Z",
            "deleted_at": null,
            "total_amount": "12.0"
          },
          "relationships": {
            "patient": {
              "meta": {
                "included": false
              }
            },
            "invoice": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/payments/1"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/payments",
        "first": "https://owner.health/api/v1/payments",
        "last": "https://owner.health/api/v1/payments"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 5
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all payments.

    HTTP Request

    GET https://owner.health/api/v1/payments

    Query Parameters

    To be updated ...

    Get a Payment

    curl "https://owner.health/api/v1/payments/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "payments",
        "attributes": {
          "payment_date": "2017-11-22",
          "eftpos": "0.0",
          "hicaps": "0.0",
          "cash": "2.0",
          "medicare": "2.0",
          "workcover": "2.0",
          "dva": "2.0",
          "direct_deposit": "2.0",
          "stripe": "0.0",
          "other": "2.0",
          "created_at": "2017-11-22T10:15:06.469Z",
          "updated_at": "2017-11-22T10:15:06.469Z",
          "deleted_at": null,
          "total_amount": "12.0"
        },
        "relationships": {
          "patient": {
            "data": {
              "type": "patients",
              "id": "1"
            }
          },
          "invoice": {
            "data": {
              "type": "invoices",
              "id": "1"
            }
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/payments/1"
        }
      },
      "included": [
        {
          "id": "1",
          "type": "patients",
          "attributes": {
            "first_name": "Janna",
            "last_name": "Strosin",
            "full_name": "Janna Strosin",
            "dob": "1989-05-10",
            "email": "keren@example.com",
            "gender": "Male",
            "phone": "(07) 4141 8512",
            "mobile": "0418 948 918",
            "fax": "(07) 4141 8512",
            "address1": "120 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          },
          "links": {
            "self": "https://owner.health/api/v1/patients/1"
          }
        },
        {
          "id": "1",
          "type": "invoices",
          "attributes": {
            "invoice_number": "00001",
            "issue_date": "2017-11-22",
            "amount": "230.0",
            "outstanding": "218.0",
            "deleted_at": null,
            "updated_at": "2017-11-22T10:15:06.475Z",
            "created_at": "2017-11-22T09:17:10.495Z"
          },
          "relationships": {
            "patient": {
              "meta": {
                "included": false
              }
            },
            "items": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/invoices/1"
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific payment.

    HTTP Request

    GET https://owner.health/api/v1/payments/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the payment to retrieve

    Practitioners

    Get all Practitioners

    curl "https://owner.health/api/v1/practitioners"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "1",
          "type": "practitioners",
          "attributes": {
            "first_name": "Elodia",
            "last_name": "Carroll",
            "active": true,
            "education": "",
            "profession": "Psychologist",
            "ahpra": "",
            "medicare": "",
            "phone": "(07) 7960 0484",
            "mobile": "0590 476 606",
            "address1": "27 Liverpool St",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "",
            "country": "GB",
            "summary": "",
            "clinic_name": "",
            "clinic_website": "",
            "updated_at": "2017-11-26T09:57:52.157Z",
            "created_at": "2017-11-22T09:02:47.445Z",
            "avatar": null,
            "driver_license": null,
            "ahpra_registration": null,
            "email": "felicitas@example.org",
            "medicare_provider_documentation": null,
            "police_check": null,
            "insurance_document": null,
            "signature": null
          },
          "links": {
            "self": "https://owner.health/api/v1/practitioners/1"
          }
        },
        {
          "id": "2",
          "type": "practitioners",
          "attributes": {
            "first_name": "Shela",
            "last_name": "Schroeder",
            "active": true,
            "education": "",
            "profession": "Physiotherapist",
            "ahpra": "",
            "medicare": "",
            "phone": "(07) 8152 6259",
            "mobile": "0455 423 878",
            "address1": "27 Liverpool St",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "",
            "country": "GB",
            "summary": "",
            "clinic_name": "",
            "clinic_website": "",
            "updated_at": "2017-11-26T09:56:56.757Z",
            "created_at": "2017-11-22T11:12:48.724Z",
            "avatar": null,
            "driver_license": null,
            "ahpra_registration": null,
            "email": "felicitas@example.org",
            "medicare_provider_documentation": null,
            "police_check": null,
            "insurance_document": null,
            "signature": null
          },
          "links": {
            "self": "https://owner.health/api/v1/practitioners/2"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/practitioners",
        "first": "https://owner.health/api/v1/practitioners",
        "last": "https://owner.health/api/v1/practitioners"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 10
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all practitioners.

    HTTP Request

    GET https://owner.health/api/v1/practitioners

    Query Parameters

    To be updated ...

    Create a Practitioner

    curl "https://owner.health/api/v1/practitioners"
      -H "X-API-KEY: YOUR_API_KEY"
      -H "Content-Type: application/json"
      -X POST
      -d 
      '{
        "data":{
          "type":"practitioners",
          "attributes":{
            "first_name": "Elodia",
            "last_name": "Carroll",
            "active": true,
            "education": null
            "profession": "Psychologist",
            "ahpra": null,
            "medicare": null,
            "phone": "(07) 7960 0484",
            "mobile": "0590 476 606",
            "address1": "27 Liverpool St",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "3301",
            "country": "GB",
            "summary": "Donec sollicitudin molestie malesuada",
            "clinic_name": null,
            "clinic_website": null,
            "email": "felicitas@example.org",
            "metadata": {
              "weight": "80kg",
              "height": "180cm"
            }
          }
        }
      }'
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "practitioners",
        "attributes": {
          "first_name": "Elodia",
          "last_name": "Carroll",
          "active": true,
          "education": null,
          "profession": "Psychologist",
          "ahpra": null,
          "medicare": null,
          "phone": "(07) 7960 0484",
          "mobile": "0590 476 606",
          "address1": "27 Liverpool St",
          "address2": "",
          "city": "London",
          "state": "England",
          "postcode": "3301",
          "country": "GB",
          "summary": "Donec sollicitudin molestie malesuada",
          "clinic_name": null,
          "clinic_website": null,
          "updated_at": "2017-11-26T09:57:52.157Z",
          "created_at": "2017-11-22T09:02:47.445Z",
          "avatar": null,
          "driver_license": null,
          "ahpra_registration": null,
          "email": "felicitas@example.org",
          "medicare_provider_documentation": null,
          "police_check": null,
          "insurance_document": null,
          "signature": null,
          "metadata": {
            "weight": "80kg",
            "height": "180cm"
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/practitioners/1"
        }
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint create a practitioner.

    HTTP Request

    POST https://owner.health/api/v1/practitioners

    Get a Practitioner

    curl "https://owner.health/api/v1/practitioners/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "practitioners",
        "attributes": {
          "first_name": "Elodia",
          "last_name": "Carroll",
          "active": true,
          "education": "",
          "profession": "Psychologist",
          "ahpra": "",
          "medicare": "",
          "phone": "(07) 7960 0484",
          "mobile": "0590 476 606",
          "address1": "27 Liverpool St",
          "address2": "",
          "city": "London",
          "state": "England",
          "postcode": "",
          "country": "GB",
          "summary": "",
          "clinic_name": "",
          "clinic_website": "",
          "updated_at": "2017-11-26T09:57:52.157Z",
          "created_at": "2017-11-22T09:02:47.445Z",
          "avatar": null,
          "driver_license": null,
          "ahpra_registration": null,
          "email": "felicitas@example.org",
          "medicare_provider_documentation": null,
          "police_check": null,
          "insurance_document": null,
          "signature": null
        },
        "links": {
          "self": "https://owner.health/api/v1/practitioners/1"
        }
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific practitioner.

    HTTP Request

    GET https://owner.health/api/v1/practitioners/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the practitioner to retrieve

    Update a Practitioner

    curl "https://owner.health/api/v1/practitioners/1"
      -H "X-API-KEY: YOUR_API_KEY"
      -H "Content-Type: application/json"
      -X PATCH
      -d 
      '{
        "data":{
          "id": "1",
          "type":"practitioners",
          "attributes":{
            "first_name": "Elodia",
            "last_name": "Carroll",
            "active": true,
            "education": null
            "profession": "Psychologist",
            "ahpra": null,
            "medicare": null,
            "phone": "(07) 7960 0484",
            "mobile": "0590 476 606",
            "address1": "27 Liverpool St",
            "address2": "",
            "city": "London",
            "state": "England",
            "postcode": "3301",
            "country": "GB",
            "summary": "Donec sollicitudin molestie malesuada",
            "clinic_name": null,
            "clinic_website": null,
            "email": "felicitas@example.org",
            "metadata": {
              "weight": "80kg",
              "height": "180cm",
              "ref_num": "X0206"
            }
          }
        }
      }'
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "practitioners",
        "attributes": {
          "first_name": "Elodia",
          "last_name": "Carroll",
          "active": true,
          "education": "",
          "profession": "Psychologist",
          "ahpra": "",
          "medicare": "",
          "phone": "(07) 7960 0484",
          "mobile": "0590 476 606",
          "address1": "27 Liverpool St",
          "address2": "",
          "city": "London",
          "state": "England",
          "postcode": "",
          "country": "GB",
          "summary": "",
          "clinic_name": "",
          "clinic_website": "",
          "updated_at": "2017-11-26T09:57:52.157Z",
          "created_at": "2017-11-22T09:02:47.445Z",
          "avatar": null,
          "driver_license": null,
          "ahpra_registration": null,
          "email": "felicitas@example.org",
          "medicare_provider_documentation": null,
          "police_check": null,
          "insurance_document": null,
          "signature": null,
          "metadata": {
            "weight": "80kg",
            "height": "180cm",
            "ref_num": "X0206"
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/practitioners/1"
        }
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint update a practitioner.

    HTTP Request

    PATCH https://owner.health/api/v1/practitioners/<ID>

    Products

    Get all Products

    curl "https://owner.health/api/v1/products"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "2",
          "type": "products",
          "attributes": {
            "name": "Stethoscope",
            "price": "12.0",
            "serial_number": "8321556442-5",
            "supplier_name": "Alma Hoeger",
            "supplier_phone": "(02) 1029 6699",
            "supplier_email": "katy@example.org",
            "notes": "Molestiae dicta qui deserunt odit et.",
            "item_number": "N55"
          },
          "relationships": {
            "tax": {
              "meta": {
                "included": false
              }
            }
          }
        },
        {
          "id": "1",
          "type": "products",
          "attributes": {
            "name": "Power Kit",
            "price": "15.0",
            "serial_number": "1437297676-4",
            "supplier_name": "Alma Hoeger",
            "supplier_phone": "(08) 4903 8434",
            "supplier_email": "clora@example.net",
            "notes": "",
            "item_number": "N85"
          },
          "relationships": {
            "tax": {
              "meta": {
                "included": false
              }
            }
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/products",
        "first": "https://owner.health/api/v1/products",
        "last": "https://owner.health/api/v1/products"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 5
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all products.

    HTTP Request

    GET https://owner.health/api/v1/products

    Query Parameters

    To be updated ...

    Get a Product

    curl "https://owner.health/api/v1/products/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id": "1",
        "type": "products",
        "attributes": {
          "name": "Power Kit",
          "price": "15.0",
          "serial_number": "1437297676-4",
          "supplier_name": "Alma Hoeger",
          "supplier_phone": "(08) 4903 8434",
          "supplier_email": "clora@example.net",
          "notes": "",
          "item_number": "N85"
        },
        "relationships": {
          "tax": {
            "data": {
              "type": "taxes",
              "id": "1"
            }
          }
        }
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves a specific product.

    HTTP Request

    GET https://owner.health/api/v1/products/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the product to retrieve

    Tasks

    Get all Tasks

    curl "https://owner.health/api/v1/tasks"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "4",
          "type": "tasks",
          "attributes": {
            "name": "Nulla porttitor accumsan tincidunt.",
            "priority": "High",
            "description": "",
            "due_on": "2017-11-23",
            "status": "Complete",
            "updated_at": "2017-11-23T15:21:08.605Z",
            "created_at": "2017-11-23T06:25:50.343Z"
          },
          "relationships": {
            "assignees": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/tasks/4"
          }
        },
        {
          "id": "5",
          "type": "tasks",
          "attributes": {
            "name": "Nulla porttitor accumsan tincidunt.",
            "priority": "High",
            "description": "",
            "due_on": "2017-11-24",
            "status": "Complete",
            "updated_at": "2017-11-23T15:13:01.492Z",
            "created_at": "2017-11-23T06:34:19.189Z"
          },
          "relationships": {
            "assignees": {
              "meta": {
                "included": false
              }
            }
          },
          "links": {
            "self": "https://owner.health/api/v1/tasks/5"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/tasks",
        "first": "https://owner.health/api/v1/tasks",
        "last": "https://owner.health/api/v1/tasks"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all tasks.

    HTTP Request

    GET https://owner.health/api/v1/tasks

    Query Parameters

    To be updated ...

    Get a Task

    curl "https://owner.health/api/v1/tasks/4"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "4",
        "type": "tasks",
        "attributes": {
          "name": "Nulla porttitor accumsan tincidunt.",
          "priority": "High",
          "description": "",
          "due_on": "2017-11-23",
          "status": "Complete",
          "updated_at": "2017-11-23T15:21:08.605Z",
          "created_at": "2017-11-23T06:25:50.343Z"
        },
        "relationships": {
          "assignees": {
            "data": [
              {
                "type": "users",
                "id": "1"
              },
              {
                "type": "users",
                "id": "2"
              }
            ]
          }
        },
        "links": {
          "self": "https://owner.health/api/v1/tasks/4"
        }
      },
      "included": [
        {
          "id": "1",
          "type": "users",
          "attributes": {
            "first_name": "Isa",
            "last_name": "Block",
            "email": "janett.daniel@example.com",
            "role": "administrator",
            "timezone": "Australia/Brisbane",
            "updated_at": "2017-11-22T09:02:48.651Z",
            "created_at": "2017-11-22T09:02:47.350Z"
          },
          "links": {
            "self": "https://owner.health/api/v1/users/1"
          }
        },
        {
          "id": "2",
          "type": "users",
          "attributes": {
            "first_name": "Kimberlee",
            "last_name": "Mraz",
            "email": "deandre@example.net",
            "role": "practitioner",
            "timezone": "Australia/Brisbane",
            "updated_at": "2017-11-25T02:41:56.033Z",
            "created_at": "2017-11-22T11:12:48.720Z"
          },
          "links": {
            "self": "https://owner.health/api/v1/users/2"
          }
        }
      ],
      "links": {
        "self": "https://owner.health/api/v1/tasks",
        "first": "https://owner.health/api/v1/tasks",
        "last": "https://owner.health/api/v1/tasks"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 5
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific task.

    HTTP Request

    GET https://owner.health/api/v1/tasks/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the task to retrieve

    Taxes

    Get all Taxes

    curl "https://owner.health/api/v1/taxes"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": [
        {
          "id": "1",
          "type": "taxes",
          "attributes": {
            "name": "GST",
            "rate": 10.0
          }
        },
        {
          "id": "1",
          "type": "taxes",
          "attributes": {
            "name": "CPI",
            "rate": 5.0
          }
        }
      ],
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves all taxes.

    HTTP Request

    GET https://owner.health/api/v1/taxes

    Query Parameters

    To be updated ...

    Get a Tax

    curl "https://owner.health/api/v1/taxes/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data": {
        "id": "1",
        "type": "taxes",
        "attributes": {
          "name": "GST",
          "rate": 10.0
        }
      },
      "links": {
        "self": "https://owner.health/api/v1/taxes",
        "first": "https://owner.health/api/v1/taxes",
        "last": "https://owner.health/api/v1/taxes"
      },
      "meta": {
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 1
      },
      "jsonapi": {
        "version": "1.0"
      }
    }
    

    This endpoint retrieves a specific tax.

    HTTP Request

    GET https://owner.health/api/v1/taxes/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the tax to retrieve

    Treatment notes

    Get all Treatment notes

    curl "https://owner.health/api/v1/treatment_notes"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":[
        {
          "id":"1",
          "type":"treatment_notes",
          "attributes":{
            "name":"Subsequent",
            "print_name":"Subsequent",
            "print_address":null,
            "print_birth":null,
            "print_ref_num":false,
            "status":"Final",
            "sections":[
              {
                "name":"Initial treatment",
                "questions":[
                  {
                    "name":"Presenting complaint",
                    "type":"Paragraph",
                    "answer":{
                      "content":"Vivamus suscipit tortor eget felis porttitor volutpat."
                    }
                  },
                  {
                    "name":"Complaint history",
                    "type":"Paragraph",
                    "answer":{
                      "content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                    }
                  },
                  {
                    "name":"Medical history",
                    "type":"Paragraph",
                    "answer":{
                      "content":"Quisque velit nisi, pretium ut lacinia in, elementum id enim"
                    }
                  },
                  {
                    "name":"Assessment",
                    "type":"Paragraph",
                    "answer":{
                      "content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. "
                    }
                  }
                ]
              }
            ],
            "updated_at":"2017-11-26T14:57:18.172Z",
            "created_at":"2017-11-21T05:18:52.512Z"
          },
          "relationships":{
            "patient":{
              "links":{
                "self":"https://owner.health/api/v1/patients/32"
              },
              "data":{
                "type":"patients",
                "id":"32"
              }
            },
            "appointment":{
              "links":{
                "self":"https://owner.health/api/v1/appointments/1173"
              },
              "data":{
                "type":"appointments",
                "id":"1173"
              }
            },
            "author":{
              "links":{
                "self":"https://owner.health/api/v1/users/27"
              },
              "data":{
                "type":"users",
                "id":"27"
              }
            }
          },
          "links":{
            "self":"https://owner.health/api/v1/treatment_notes/2451"
          }
        }
      ],
      "included":[
        {
          "id":"1",
          "type":"patients",
          "attributes":{
            "first_name": "Austin",
            "last_name": "Bosco",
            "full_name": "Austin Bosco",
            "dob": "1985-05-10",
            "email": "harold@example.org",
            "gender": "Male",
            "phone": "(08) 2411 8661",
            "mobile": "0578 731 003",
            "fax": "(08) 2411 8661",
            "address1": "20 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          },
          "links":{
            "self":"https://owner.health/api/v1/patients/1"
          }
        },
        {
          "id":"1",
          "type":"appointments",
          "attributes":{
            "start_time":"2017-11-22T00:00:00.000Z",
            "end_time":"2017-11-22T04:00:00.000Z",
            "booked_online":false,
            "status": "completed",
            "notes":"",
            "cancelled_at":null,
            "deleted_at":null,
            "updated_at":"2017-11-23T02:52:50.133Z",
            "created_at":"2017-11-21T05:07:00.644Z"
          },
          "relationships":{
            "patient":{
              "links":{
                "self":"https://owner.health/api/v1/patients/1"
              }
            },
            "appointment_type":{
              "links":{
                "self":"https://owner.health/api/v1/appointment_types/1"
              }
            },
            "users":{
              "links":{
                "self":"https://owner.health/api/v1/users/1"
              }
            }
          },
          "links":{
            "self":"https://owner.health/api/v1/appointments/1"
          }
        },
        {
          "id":"1",
          "type":"users",
          "attributes":{
            "first_name": "Elodia",
            "last_name": "Carroll",
            "role": "practitioner",
            "updated_at": "2017-11-26T09:57:52.157Z",
            "created_at": "2017-11-22T09:02:47.445Z"
          },
          "links":{
            "self":"https://owner.health/api/v1/users/1"
          }
        }
      ],
      "links":{
        "self":"https://owner.health/api/v1/treatment_notes",
        "first":"https://owner.health/api/v1/treatment_notes",
        "last":"https://owner.health/api/v1/treatment_notes"
      },
      "meta":{
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "total_entries": 1
      },
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves all treatment notes.

    HTTP Request

    GET https://owner.health/api/v1/treatment_notes

    Query Parameters

    Available filter fields:

    Field Type Operators
    name String eq, cont
    status String eq, in
    patient_id Integer eq, in
    author_id Integer eq, in
    created_at String eq, cont
    updated_at String eq, cont
    patient_medicare_details String present
    patient_dva_details String present

    Get a Treatment note

    curl "https://owner.health/api/v1/treatment_notes/1"
      -H "X-API-KEY: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "data":{
        "id":"1",
        "type":"treatment_notes",
        "attributes":{
          "name":"Subsequent",
          "print_name":"Subsequent",
          "print_address":null,
          "print_birth":null,
          "print_ref_num":false,
          "status":"Final",
          "sections":[
            {
              "name":"Initial treatment",
              "questions":[
                {
                  "name":"Presenting complaint",
                  "type":"Paragraph",
                  "answer":{
                    "content":"Vivamus suscipit tortor eget felis porttitor volutpat."
                  }
                },
                {
                  "name":"Complaint history",
                  "type":"Paragraph",
                  "answer":{
                    "content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                  }
                },
                {
                  "name":"Medical history",
                  "type":"Paragraph",
                  "answer":{
                    "content":"Quisque velit nisi, pretium ut lacinia in, elementum id enim"
                  }
                },
                {
                  "name":"Assessment",
                  "type":"Paragraph",
                  "answer":{
                    "content":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. "
                  }
                }
              ]
            }
          ],
          "updated_at":"2017-11-26T14:57:18.172Z",
          "created_at":"2017-11-21T05:18:52.512Z"
        },
        "relationships":{
          "patient":{
            "links":{
              "self":"https://owner.health/api/v1/patients/1"
            },
            "data":{
              "type":"patients",
              "id":"1"
            }
          },
          "appointment":{
            "links":{
              "self":"https://owner.health/api/v1/appointments/1"
            },
            "data":{
              "type":"appointments",
              "id":"1"
            }
          },
          "user":{
            "links":{
              "self":"https://owner.health/api/v1/users/1"
            },
            "data":{
              "type":"users",
              "id":"1"
            }
          }
        },
        "links":{
          "self":"https://owner.health/api/v1/treatment_notes/1"
        }
      },
      "included":[
        {
          "id":"1",
          "type":"patients",
          "attributes":{
            "first_name": "Austin",
            "last_name": "Bosco",
            "full_name": "Austin Bosco",
            "dob": "1985-05-10",
            "email": "harold@example.org",
            "gender": "Male",
            "phone": "(08) 2411 8661",
            "mobile": "0578 731 003",
            "fax": "(08) 2411 8661",
            "address1": "20 Beatrice Tce",
            "address2": "",
            "city": "Ascot",
            "state": "QLD",
            "postcode": "4007",
            "country": "AU",
            "reminder_enable": true,
            "next_of_kin": "",
            "general_info": "",
            "medicare_card_number": null,
            "medicare_card_irn": null,
            "medicare_referrer_name": null,
            "medicare_referrer_provider_number": null,
            "medicare_referral_date": null,
            "dva_file_number": null,
            "dva_card_type": null,
            "dva_referrer_name": null,
            "dva_referrer_provider_number": null,
            "dva_referral_date": null,
            "archived_at": null,
            "deleted_at": null,
            "updated_at": "2017-11-22T10:22:27.376Z",
            "created_at": "2017-11-22T09:02:47.949Z"
          },
          "links":{
            "self":"https://owner.health/api/v1/patients/1"
          }
        },
        {
          "id":"1",
          "type":"appointments",
          "attributes":{
            "start_time":"2017-11-22T00:00:00.000Z",
            "end_time":"2017-11-22T04:00:00.000Z",
            "booked_online":false,
            "status": "completed",
            "notes":"",
            "cancelled_at":null,
            "deleted_at":null,
            "updated_at":"2017-11-23T02:52:50.133Z",
            "created_at":"2017-11-21T05:07:00.644Z"
          },
          "relationships":{
            "patient":{
              "links":{
                "self":"https://owner.health/api/v1/patients/1"
              }
            },
            "appointment_type":{
              "links":{
                "self":"https://owner.health/api/v1/appointment_types/1"
              }
            },
            "user":{
              "links":{
                "self":"https://owner.health/api/v1/users/1"
              }
            }
          },
          "links":{
            "self":"https://owner.health/api/v1/appointments/1"
          }
        },
        {
          "id":"1",
          "type":"users",
          "attributes":{
            "first_name": "Elodia",
            "last_name": "Carroll",
            "role": "practitioner",
            "updated_at": "2017-11-26T09:57:52.157Z",
            "created_at": "2017-11-22T09:02:47.445Z"
          },
          "links":{
            "self":"https://owner.health/api/v1/users/1"
          }
        }
      ],
      "jsonapi":{
        "version":"1.0"
      }
    }
    

    This endpoint retrieves a specific treatment note.

    HTTP Request

    GET https://owner.health/api/v1/treatment_notes/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the treatment note to retrieve

    Errors

    The API uses the following error codes:

    Error Code Meaning
    400 Bad Request -- Your request sucks.
    401 Unauthorized -- Your API key is wrong.
    403 Forbidden -- The request is hidden for administrators only.
    404 Not Found -- The specified resource could not be found.
    405 Method Not Allowed -- You tried to access some resource with an invalid method.
    406 Not Acceptable -- You requested a format that isn't json.
    429 Too Many Requests -- You're sending too many requests! Slow down!
    500 Internal Server Error -- We had a problem with our server. Try again later.
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

    Appendix

    Updating ...