Family History

Family history stores which conditions the patient's family members have.

The family history model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the family history.

  • Name
    object
    Type
    string
    Description

    Always 'family_history'.

  • Name
    patient
    Type
    string
    Description

    Patient this family history is for.

  • Name
    relationship
    Type
    string
    Description

    Patient's relationship to the family member in SNOMED CT code. Options are:

    • "72705000" for Mother
    • "66839005" for Father
    • "27733009" for Sister
    • "70924004" for Brother
    • "394859001" for Maternal Grandmother
    • "394857004" for Maternal Grandfather
    • "394858009" for Paternal Grandmother
    • "394856008" for Paternal Grandfather
    • "66089001" for Daughter
    • "65616008" for Son
    • "74964007" for Other
  • Name
    diagnoses
    Type
    array of strings
    Description

    List of ICD codes of the conditions the family member has.

  • Name
    comment
    Type
    string
    Description

    Any comments associated with the family history.

  • Name
    created_by
    Type
    string
    Description

    Creator of the family history.

  • Name
    created_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the family history was created.

  • Name
    last_updated_at
    Type
    date-time
    Description

    Timestamp (in ISO 8601 format) of when the family history was last updated.

Response

{
    "id": "fhst_2UxtAULYUrX7GVsTKePy",
    "object": "family_history",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "relationship": "72705000",
    "diagnoses": ["E11.9", "I10"],
    "comment": "Mother has diabetes and hypertension.",

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}
POST/v2/family_histories

Create a family history entry

Creates a new family history entry.

Required attributes

  • Name
    patient
    Type
    string
    Description

    Patient this family history entry is for.

Optional attributes

  • Name
    relationship
    Type
    string
    Description

    Patient's relationship to the family member in SNOMED CT code. Options are:

    • "72705000" for Mother
    • "66839005" for Father
    • "27733009" for Sister
    • "70924004" for Brother
    • "394859001" for Maternal Grandmother
    • "394857004" for Maternal Grandfather
    • "394858009" for Paternal Grandmother
    • "394856008" for Paternal Grandfather
    • "66089001" for Daughter
    • "65616008" for Son
    • "74964007" for Other
  • Name
    diagnoses
    Type
    array of strings
    Description

    List of ICD codes of the conditions the family member has.

  • Name
    comment
    Type
    string
    Description

    Any comments associated with the family history entry.

Response

{
    "id": "fhst_2UxtAULYUrX7GVsTKePy",
    "object": "family_history",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "relationship": "72705000",
    "diagnoses": ["E11.9", "I10"],
    "comment": "Mother has diabetes and hypertension.",

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}
GET/v2/family_histories/:id

Retrieve a family history entry

Retrieves the specified family history entry.

Response

{
   "id": "fhst_2UxtAULYUrX7GVsTKePy",
   "object": "family_history",
   "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

   "relationship": "72705000",
   "diagnoses": ["E11.9", "I10"],
   "comment": "Mother has diabetes and hypertension.",

   "created_by": "user_xeDpGyt67wTor93qKtS7",
   "created_at": "2024-07-07T00:52:02.504Z",
   "last_updated_at": "2024-07-07T00:52:02.504Z"
}
POST/v2/family_histories/:id

Update a family history entry

Updates the specified family history object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

    Optional attributes

    • Name
      relationship
      Type
      string
      Description

      Patient's relationship to the family member in SNOMED CT code. Options are:

      • "72705000" for Mother
      • "66839005" for Father
      • "27733009" for Sister
      • "70924004" for Brother
      • "394859001" for Maternal Grandmother
      • "394857004" for Maternal Grandfather
      • "394858009" for Paternal Grandmother
      • "394856008" for Paternal Grandfather
      • "66089001" for Daughter
      • "65616008" for Son
      • "74964007" for Other
    • Name
      diagnoses
      Type
      array of strings
      Description

      List of ICD codes of the conditions the family member has.

    • Name
      comment
      Type
      string
      Description

      Any comments associated with the family history.

    Response

    {
    "id": "fhst_2UxtAULYUrX7GVsTKePy",
    "object": "family_history",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "relationship": "72705000",
    "diagnoses": ["E11.9", "I10"],
    "comment": "Mother has diabetes and hypertension.",

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}
    GET/v2/family_histories

    List all family history entries

    Returns a list of all family history entries.

    Optional query parameters

    • Name
      patient
      Type
      string
      Description

      Patient ID to filter by.

    Request

    GET
    /v2/family_histories
    curl https://{{base_subdomain}}.avonhealth.com/v2/family_histories?patient=user_Z1zXZKvqrpwxbznuW6lJ \
  -H "Authorization: Bearer {{token}}" \
  -H "x-jwt: {{jwt}}"

    Response

    {
  "object": "list",
  "data": [
    {
        "id": "fhst_2UxtAULYUrX7GVsTKePy",
        "object": "family_history",
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

        "relationship": "72705000",
        "diagnoses": ["E11.9", "I10"],
        "comment": "Mother has diabetes and hypertension.",

        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": "2024-07-07T00:52:02.504Z",
        "last_updated_at": "2024-07-07T00:52:02.504Z"
    },
  ]
}
    DELETE/v2/family_histories/:id

    Delete a family history

    Deletes the specified family history.

    Required attributes

      Optional attributes

        Response

        {
    "id": "fhst_2UxtAULYUrX7GVsTKePy",
    "object": "family_history",
    "delete": true
}