GET api/v1/{EMRSystem}/FamilyHistories
Returns both active and inactive Family Histories for a patient along with family relationship data.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of FamilyHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| FamilyHistoryId |
Gets or sets the FamilyHistory identifier. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| FamilyHistoryDesc |
Gets or sets the family history description. |
string |
None. |
| FamilyRelationshipType |
Gets or sets the type of the family relationship. |
string |
None. |
| FamilyRelationshipName |
Gets or sets the name of the family relationship. |
string |
None. |
| SNOMED |
Gets or sets the snomed. |
string |
None. |
| AgeOfOnSet |
Gets or sets the age of on set. |
string |
None. |
| AgeOfDeath |
Gets or sets the age of death. |
string |
None. |
| Audits |
Gets or sets the audits. |
Collection of Audit |
None. |
| PertinentNegative |
Gets or sets a value indicating whether [pertinent negative]. |
boolean |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"FamilyHistoryId": "sample string 1",
"PatientId": "sample string 2",
"FamilyHistoryDesc": "sample string 3",
"FamilyRelationshipType": "sample string 4",
"FamilyRelationshipName": "sample string 5",
"SNOMED": "sample string 6",
"AgeOfOnSet": "sample string 7",
"AgeOfDeath": "sample string 8",
"Audits": [
{
"AuditDateTime": "2025-12-12T20:55:16.6669841+00:00",
"User": "sample string 1",
"Action": "sample string 2",
"Status": "sample string 3"
},
{
"AuditDateTime": "2025-12-12T20:55:16.6669841+00:00",
"User": "sample string 1",
"Action": "sample string 2",
"Status": "sample string 3"
}
],
"PertinentNegative": true
},
{
"FamilyHistoryId": "sample string 1",
"PatientId": "sample string 2",
"FamilyHistoryDesc": "sample string 3",
"FamilyRelationshipType": "sample string 4",
"FamilyRelationshipName": "sample string 5",
"SNOMED": "sample string 6",
"AgeOfOnSet": "sample string 7",
"AgeOfDeath": "sample string 8",
"Audits": [
{
"AuditDateTime": "2025-12-12T20:55:16.6669841+00:00",
"User": "sample string 1",
"Action": "sample string 2",
"Status": "sample string 3"
},
{
"AuditDateTime": "2025-12-12T20:55:16.6669841+00:00",
"User": "sample string 1",
"Action": "sample string 2",
"Status": "sample string 3"
}
],
"PertinentNegative": true
}
]