Relationship

archived_at	string or null <date-time>
created_at	string <date-time>
id	string <int64>
	object
	object
	object
relation	integer or null Enum: 10 20 30 40 50 60 70
relation_description	string or null Enum: "Parent" "Child" "Sibling" "Spouse" "Partner" "Relative" "Other"
updated_at	string <date-time>

{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/relationships/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"related_patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"relation": 10,
"relation_description": "Parent",
"updated_at": "2019-08-24T14:15:22Z"
}

List relationships

get/relationships

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
created_at	date-time
id	int64
patient_id	int64
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"relationships": [{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/relationships/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"related_patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"relation": 10,
"relation_description": "Parent",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/relationships?page=2",
"previous": "https://api.au1.cliniko.com/v1/relationships?page=1",
"next": "https://api.au1.cliniko.com/v1/relationships?page=3"
}
}

Create relationship

post/relationships

SecuritybasicAuth

Request

Request Body schema: application/json

patient_id

string <int64>

patient id

related_patient_id

string <int64>

patient id

relation

integer

Enum Value	Description
10	Parent
20	Child
30	Sibling
40	Spouse
50	Partner
60	Relative
70	Other

Enum: 10 20 30 40 50 60 70

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"patient_id": "1",
"related_patient_id": "1",
"relation": 10
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/relationships/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"related_patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"relation": 10,
"relation_description": "Parent",
"updated_at": "2019-08-24T14:15:22Z"
}

Get relationship

get/relationships/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/relationships/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"related_patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"relation": 10,
"relation_description": "Parent",
"updated_at": "2019-08-24T14:15:22Z"
}

Update relationship

patch/relationships/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

patient_id

string <int64>

patient id

related_patient_id

string <int64>

patient id

relation

integer

Enum Value	Description
10	Parent
20	Child
30	Sibling
40	Spouse
50	Partner
60	Relative
70	Other

Enum: 10 20 30 40 50 60 70

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"patient_id": "1",
"related_patient_id": "1",
"relation": 10
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/relationships/1"
},
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"related_patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"relation": 10,
"relation_description": "Parent",
"updated_at": "2019-08-24T14:15:22Z"
}

Archive relationship

post/relationships/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby