Create
POST
/:tenantId/patientsParameters
| Name | Type | Required | Description |
|---|---|---|---|
| first_name | string | yes | The first name of the individual. |
| last_name | string | yes | The last name of the individual. |
| photo | string | no | A base64-encoded string representing the individual's photo. |
| mobile | string | no | The individual's mobile phone number. |
| phone | string | no | The individual's general phone number. |
| nationality | string | no | The nationality of the individual. |
| foreigner_type | string | no | The type of foreigner, if applicable. See Foreigner Types endpoint. |
| identity_number | string | no | The individual's TCKN number, allows passport number. |
| protocol_no | string | no | The protocol number associated with the individual. |
| birth_date | string | no | The birth date of the individual (format: YYYY-MM-DD). |
| birthplace | string | no | The birthplace of the individual. |
| control_date | string | no | The control date associated with the individual (format: YYYY-MM-DD). |
| work_phone | string | no | The individual's work phone number. |
| home_phone | string | no | The individual's home phone number. |
| fax | string | no | The individual's fax number. |
| string | no | The individual's email address. | |
| address | string | no | The individual's residential address. |
| city | string | no | The city of the individual's residence. |
| town | string | no | The town of the individual's residence. |
| district | string | no | The district of the individual's residence. |
| post_code | string | no | The postal code of the individual's residence. |
| country | string | no | The country of the individual's residence. |
| work_address | string | no | The address of the individual's workplace. |
| occupation | string | no | The occupation of the individual. |
| user_id | string | no | Assigned user for the patient. |
| came_from | string | no | The country from where the individual came, for non-Turkish patient. See Countries endpoint. |
| reference | string | no | Reference details for the individual. |
| blood_type | string | no | The blood type of the individual. |
| discount_rate | integer | no | The discount rate applicable to the individual. |
| healthcare_id | string | no | The healthcare ID associated with the individual. |
| insurance_type_id | string | no | The ID of the insurance type associated with the individual. |
| type | string | no | The type of individual or record. |
| gender | integer | no | The gender of the individual. 0: Unspecified (default) 1: Male 2: Female |
| emergency_contact_name | string | no | The name of the emergency contact person. |
| emergency_contact_phone | string | no | The phone number of the emergency contact person. |
| emergency_contact_relationship | string | no | The relationship of the emergency contact person to the individual. |
| group_id | array | no | An array of patient group IDs associated with the individual. |
| source | string | no | The source of the record. |
| external_id | string | no | An external identifier associated with the record. |
Body
json
{
"first_name": "John",
"last_name": "Done",
"photo": "",
"mobile": "",
"phone": "",
"nationality": "",
"foreigner_type": "",
"identity_number": "",
"protocol_no": "",
"birth_date": "",
"birthplace": "",
"control_date": "",
"work_phone": "",
"home_phone": "",
"fax": "",
"email": "",
"address": "",
"city": "",
"town": "",
"district": "",
"post_code": "",
"country": "",
"work_address": "",
"occupation": "",
"user_id": "",
"came_from": "",
"reference": "",
"blood_type": "",
"discount_rate": 15,
"healthcare_id": "",
"insurance_type_id": "1",
"type": "",
"gender": 1,
"emergency_contact_name": "",
"emergency_contact_phone": "",
"emergency_contact_relationship": "",
"group_id": [],
"source": "",
"external_id": ""
}Response
HTTP 201 Created
json
{
"data": {
"id": 1896,
"first_name": "John",
"last_name": "Done",
"name": null,
"mobile": null,
"phone": null,
"identity_number": null,
"protocol_no": null,
"birth_date": null,
"birthplace": null,
"control_date": null,
"work_phone": null,
"home_phone": null,
"fax": null,
"email": null,
"address": null,
"state": null,
"city": null,
"town": null,
"district": null,
"post_code": null,
"country": null,
"work_address": null,
"nationality": null,
"foreigner_type": null,
"occupation": null,
"user_id": null,
"came_from": null,
"reference": null,
"blood_type": null,
"discount_rate": 15,
"healthcare_id": null,
"insurance_type_id": 1,
"type": null,
"gender": 1,
"emergency_contact_name": null,
"emergency_contact_phone": null,
"emergency_contact_relationship": null,
"created_at": "2024-11-29T06:32:25.000000Z",
"notes": [],
"group_id": [],
"user": null,
"photo": null,
"sms_consent": null,
"privacy_consented_at": null,
"can_send_to_uss": false
}
}422 Unprocessable entity
json
{
"message": "The first name field is required. (and 1 more error)",
"errors": {
"first_name": [
"The first name field is required."
],
"last_name": [
"The last name field is required."
],
}
}