Update one patient

curl --request PUT \
  --url https://api.splose.com/v1/patients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstname": "Harry",
  "lastname": "Potter",
  "email": "harry@hogwarts.edu",
  "sex": "Male",
  "genderIdentity": "Man",
  "alert": "He knows magic",
  "birthdate": "1996-07-30T00:00:00.000Z",
  "timezone": "Australia/Adelaide",
  "city": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ],
  "privacyPolicy": "Accepted",
  "healthFund": {
    "name": "AHM",
    "membershipNumber": "12345678",
    "patientNumber": "1",
    "cardIssueNumber": "01"
  },
  "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",
  "patientTags": [
    "Self-managed"
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Required range: x > 0

Example:

1

Body

application/json

firstname

string

Patient first name

Minimum length: 1

Example:

"Harry"

lastname

string

Patient last name

Minimum length: 1

Example:

"Potter"

string | null

Patient email

Example:

"harry@hogwarts.edu"

sex

string | null

Patient sex

Example:

"Male"

genderIdentity

string | null

Patient gender identity

Example:

"Man"

alert

string | null

Patient alert messages

Example:

"He knows magic"

birthdate

string | null

Patient birthdate in YYYY-MM-DD format

Example:

"1996-07-30T00:00:00.000Z"

timezone

enum<string> | null

Patient timezone

Available options:

Africa/Abidjan,

Africa/Accra,

Africa/Addis_Ababa,

Africa/Algiers,

Africa/Asmera,

Africa/Bamako,

Africa/Bangui,

Africa/Banjul,

Africa/Bissau,

Africa/Blantyre,

Africa/Brazzaville,

Africa/Bujumbura,

Africa/Cairo,

Africa/Casablanca,

Africa/Ceuta,

Africa/Conakry,

Africa/Dakar,

Africa/Dar_es_Salaam,

Africa/Djibouti,

Africa/Douala,

Africa/El_Aaiun,

Africa/Freetown,

Africa/Gaborone,

Africa/Harare,

Africa/Johannesburg,

Africa/Juba,

Africa/Kampala,

Africa/Khartoum,

Africa/Kigali,

Africa/Kinshasa,

Africa/Lagos,

Africa/Libreville,

Africa/Lome,

Africa/Luanda,

Africa/Lubumbashi,

Africa/Lusaka,

Africa/Malabo,

Africa/Maputo,

Africa/Maseru,

Africa/Mbabane,

Africa/Mogadishu,

Africa/Monrovia,

Africa/Nairobi,

Africa/Ndjamena,

Africa/Niamey,

Africa/Nouakchott,

Africa/Ouagadougou,

Africa/Porto-Novo,

Africa/Sao_Tome,

Africa/Tripoli,

Africa/Tunis,

Africa/Windhoek,

America/Adak,

America/Anchorage,

America/Anguilla,

America/Antigua,

America/Araguaina,

America/Argentina/La_Rioja,

America/Argentina/Rio_Gallegos,

America/Argentina/Salta,

America/Argentina/San_Juan,

America/Argentina/San_Luis,

America/Argentina/Tucuman,

America/Argentina/Ushuaia,

America/Aruba,

America/Asuncion,

America/Bahia,

America/Bahia_Banderas,

America/Barbados,

America/Belem,

America/Belize,

America/Blanc-Sablon,

America/Boa_Vista,

America/Bogota,

America/Boise,

America/Buenos_Aires,

America/Cambridge_Bay,

America/Campo_Grande,

America/Cancun,

America/Caracas,

America/Catamarca,

America/Cayenne,

America/Cayman,

America/Chicago,

America/Chihuahua,

America/Ciudad_Juarez,

America/Coral_Harbour,

America/Cordoba,

America/Costa_Rica,

America/Creston,

America/Cuiaba,

America/Curacao,

America/Danmarkshavn,

America/Dawson,

America/Dawson_Creek,

America/Denver,

America/Detroit,

America/Dominica,

America/Edmonton,

America/Eirunepe,

America/El_Salvador,

America/Fort_Nelson,

America/Fortaleza,

America/Glace_Bay,

America/Godthab,

America/Goose_Bay,

America/Grand_Turk,

America/Grenada,

America/Guadeloupe,

America/Guatemala,

America/Guayaquil,

America/Guyana,

America/Halifax,

America/Havana,

America/Hermosillo,

America/Indiana/Knox,

America/Indiana/Marengo,

America/Indiana/Petersburg,

America/Indiana/Tell_City,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Indiana/Winamac,

America/Indianapolis,

America/Inuvik,

America/Iqaluit,

America/Jamaica,

America/Jujuy,

America/Juneau,

America/Kentucky/Monticello,

America/Kralendijk,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Louisville,

America/Lower_Princes,

America/Maceio,

America/Managua,

America/Manaus,

America/Marigot,

America/Martinique,

America/Matamoros,

America/Mazatlan,

America/Mendoza,

America/Menominee,

America/Merida,

America/Metlakatla,

America/Mexico_City,

America/Miquelon,

America/Moncton,

America/Monterrey,

America/Montevideo,

America/Montserrat,

America/Nassau,

America/New_York,

America/Nipigon,

America/Nome,

America/Noronha,

America/North_Dakota/Beulah,

America/North_Dakota/Center,

America/North_Dakota/New_Salem,

America/Ojinaga,

America/Panama,

America/Pangnirtung,

America/Paramaribo,

America/Phoenix,

America/Port-au-Prince,

America/Port_of_Spain,

America/Porto_Velho,

America/Puerto_Rico,

America/Punta_Arenas,

America/Rainy_River,

America/Rankin_Inlet,

America/Recife,

America/Regina,

America/Resolute,

America/Rio_Branco,

America/Santa_Isabel,

America/Santarem,

America/Santiago,

America/Santo_Domingo,

America/Sao_Paulo,

America/Scoresbysund,

America/Sitka,

America/St_Barthelemy,

America/St_Johns,

America/St_Kitts,

America/St_Lucia,

America/St_Thomas,

America/St_Vincent,

America/Swift_Current,

America/Tegucigalpa,

America/Thule,

America/Thunder_Bay,

America/Tijuana,

America/Toronto,

America/Tortola,

America/Vancouver,

America/Whitehorse,

America/Winnipeg,

America/Yakutat,

America/Yellowknife,

Antarctica/Casey,

Antarctica/Davis,

Antarctica/DumontDUrville,

Antarctica/Macquarie,

Antarctica/Mawson,

Antarctica/McMurdo,

Antarctica/Palmer,

Antarctica/Rothera,

Antarctica/Syowa,

Antarctica/Troll,

Antarctica/Vostok,

Arctic/Longyearbyen,

Asia/Aden,

Asia/Almaty,

Asia/Amman,

Asia/Anadyr,

Asia/Aqtau,

Asia/Aqtobe,

Asia/Ashgabat,

Asia/Atyrau,

Asia/Baghdad,

Asia/Bahrain,

Asia/Baku,

Asia/Bangkok,

Asia/Barnaul,

Asia/Beirut,

Asia/Bishkek,

Asia/Brunei,

Asia/Calcutta,

Asia/Chita,

Asia/Choibalsan,

Asia/Colombo,

Asia/Damascus,

Asia/Dhaka,

Asia/Dili,

Asia/Dubai,

Asia/Dushanbe,

Asia/Famagusta,

Asia/Gaza,

Asia/Hebron,

Asia/Hong_Kong,

Asia/Hovd,

Asia/Irkutsk,

Asia/Jakarta,

Asia/Jayapura,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Katmandu,

Asia/Khandyga,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuching,

Asia/Kuwait,

Asia/Macau,

Asia/Magadan,

Asia/Makassar,

Asia/Manila,

Asia/Muscat,

Asia/Nicosia,

Asia/Novokuznetsk,

Asia/Novosibirsk,

Asia/Omsk,

Asia/Oral,

Asia/Phnom_Penh,

Asia/Pontianak,

Asia/Pyongyang,

Asia/Qatar,

Asia/Qostanay,

Asia/Qyzylorda,

Asia/Rangoon,

Asia/Riyadh,

Asia/Saigon,

Asia/Sakhalin,

Asia/Samarkand,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Thimphu,

Asia/Tokyo,

Asia/Tomsk,

Asia/Ulaanbaatar,

Asia/Urumqi,

Asia/Ust-Nera,

Asia/Vientiane,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Bermuda,

Atlantic/Canary,

Atlantic/Cape_Verde,

Atlantic/Faeroe,

Atlantic/Madeira,

Atlantic/Reykjavik,

Atlantic/South_Georgia,

Atlantic/St_Helena,

Atlantic/Stanley,

Australia/Adelaide,

Australia/Brisbane,

Australia/Broken_Hill,

Australia/Currie,

Australia/Darwin,

Australia/Eucla,

Australia/Hobart,

Australia/Lindeman,

Australia/Lord_Howe,

Australia/Melbourne,

Australia/Perth,

Australia/Sydney,

Europe/Amsterdam,

Europe/Andorra,

Europe/Astrakhan,

Europe/Athens,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Busingen,

Europe/Chisinau,

Europe/Copenhagen,

Europe/Dublin,

Europe/Gibraltar,

Europe/Guernsey,

Europe/Helsinki,

Europe/Isle_of_Man,

Europe/Istanbul,

Europe/Jersey,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Kirov,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Luxembourg,

Europe/Madrid,

Europe/Malta,

Europe/Mariehamn,

Europe/Minsk,

Europe/Monaco,

Europe/Moscow,

Europe/Oslo,

Europe/Paris,

Europe/Podgorica,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/San_Marino,

Europe/Sarajevo,

Europe/Saratov,

Europe/Simferopol,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Tirane,

Europe/Ulyanovsk,

Europe/Uzhgorod,

Europe/Vaduz,

Europe/Vatican,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zaporozhye,

Europe/Zurich,

Indian/Antananarivo,

Indian/Chagos,

Indian/Christmas,

Indian/Cocos,

Indian/Comoro,

Indian/Kerguelen,

Indian/Mahe,

Indian/Maldives,

Indian/Mauritius,

Indian/Mayotte,

Indian/Reunion,

Pacific/Apia,

Pacific/Auckland,

Pacific/Bougainville,

Pacific/Chatham,

Pacific/Easter,

Pacific/Efate,

Pacific/Enderbury,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Funafuti,

Pacific/Galapagos,

Pacific/Gambier,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Johnston,

Pacific/Kiritimati,

Pacific/Kosrae,

Pacific/Kwajalein,

Pacific/Majuro,

Pacific/Marquesas,

Pacific/Midway,

Pacific/Nauru,

Pacific/Niue,

Pacific/Norfolk,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Palau,

Pacific/Pitcairn,

Pacific/Ponape,

Pacific/Port_Moresby,

Pacific/Rarotonga,

Pacific/Saipan,

Pacific/Tahiti,

Pacific/Tarawa,

Pacific/Tongatapu,

Pacific/Truk,

Pacific/Wake,

Pacific/Wallis

Example:

"Australia/Adelaide"

city

string | null

Patient city

Example:

"Adelaide"

state

string | null

Patient state

Example:

"SA"

postalCode

string | null

Patient post code

Example:

"5000"

country

string | null

Patient country

Example:

"Australia"

phoneNumbers

object[]

privacyPolicy

enum<string> | null

Patient privacy policy status

Available options:

No response,

Accepted,

Rejected,

Example:

"Accepted"

healthFund

object

ndisNumber

string | null

Patient NDIS number

Example:

"430123456"

ndisInfo

object | null

medicareNum

string | null

Patient Medicare number

Example:

"4444444444"

irn

string | null

Patient Medicare reference number

Example:

"1"

veteransFileNumber

string | null

Patient veterans information

Example:

""

emergencyContactNumber

string | null

Patient emergency contact number

Example:

"0412345678"

emergencyContactName

string | null

Patient emergency contact name

Example:

"Quentin Neely"

emergencyContactRelationship

string | null

Patient emergency contact relationship

Example:

"Brother"

patientTags

string[] | null

Patient tags

Example:

["Self-managed"]

customFields

object[] | null

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

Response

200 - text

Return 1 on success

The response is of type enum<number>.

Available options:

1

Get a single patient Create one file for specific patient

curl --request PUT \
  --url https://api.splose.com/v1/patients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstname": "Harry",
  "lastname": "Potter",
  "email": "harry@hogwarts.edu",
  "sex": "Male",
  "genderIdentity": "Man",
  "alert": "He knows magic",
  "birthdate": "1996-07-30T00:00:00.000Z",
  "timezone": "Australia/Adelaide",
  "city": "Adelaide",
  "state": "SA",
  "postalCode": "5000",
  "country": "Australia",
  "phoneNumbers": [
    {
      "type": "Mobile",
      "code": "+61",
      "phoneNumber": "401234567"
    }
  ],
  "privacyPolicy": "Accepted",
  "healthFund": {
    "name": "AHM",
    "membershipNumber": "12345678",
    "patientNumber": "1",
    "cardIssueNumber": "01"
  },
  "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",
  "patientTags": [
    "Self-managed"
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}'

Get started

API Reference

Authorizations

Path Parameters

Body

Response