Skip to main content
POST
/
v1
/
family-history
Create family member history
curl --request POST \
  --url https://api.clinikapi.com/v1/family-history \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "relationship": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "sex": "<string>",
  "bornDate": "<string>",
  "ageString": "<string>",
  "estimatedAge": true,
  "deceasedBoolean": true,
  "deceasedDate": "<string>",
  "reasonCode": [
    "<string>"
  ],
  "note": "<string>",
  "condition": [
    {
      "code": "<string>",
      "outcome": "<string>",
      "contributedToDeath": true,
      "onsetString": "<string>",
      "note": "<string>"
    }
  ]
}
'
{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "issues": [
    {
      "severity": "<string>",
      "code": "<string>",
      "diagnostics": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
partial,
completed,
health-unknown
patientId
string
required
relationship
string
required

Relationship to patient (mother, father, sibling, etc.)

Maximum string length: 200
date
string<date-time>
name
string

Family member's name

Maximum string length: 200
sex
string
Maximum string length: 50
bornDate
string

Family member's birth date

ageString
string

Approximate age (e.g. "around 50")

Maximum string length: 100
estimatedAge
boolean
deceasedBoolean
boolean
deceasedDate
string
reasonCode
string[]
Maximum array length: 10
Maximum string length: 500
note
string
Maximum string length: 2000
condition
object[]
Maximum array length: 20

Response

Family member history created