The FHIR R4 FamilyMemberHistory resource captures information about a patient's family health history, including diagnoses, conditions, and other relevant details about family members' health statuses. This resource is useful for understanding hereditary conditions, risk factors, and providing personalized care.
Use Cases
- Retrieve family history of genetic conditions
- Log new family member health details for risk assessment
- Monitor changes to family medical histories
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/FamilyMemberHistory
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/FamilyMemberHistory
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required scopes:
familymemberhistory.readfor GETfamilymemberhistory.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read FamilyMemberHistory | Retrieves a specific FamilyMemberHistory record by its FHIR ID. |
GET | Search FamilyMemberHistory | Searches for FamilyMemberHistory records for a specified patient. |
POST | Create FamilyMemberHistory | Submits a new FamilyMemberHistory record to the Health Gorilla FHIR server. |
PUT | Update FamilyMemberHistory | Updates an existing FamilyMemberHistory record by full resource replacement. |
DELETE | Delete FamilyMemberHistory | Removes an existing FamilyMemberHistory record from the system by full deletion. |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
date | Filters by family member history creation date | ge2024-01-01, le2024-12-31 | date | No |
status | Filters by the current status of the family history record | FamilyMemberHistoryStatus (completed) | token | No |
relationship | Filters by the relationship of the family member | FamilyMemberHistoryRelationship (father) | token | No |
condition | Filters by a condition associated with a family member | Condition/{id} | Reference | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
status | The status of the family member history | completed | CodeableConcept | Yes |
relationship | The relationship of the family member to the patient | father | CodeableConcept | Yes |
condition | Conditions or diseases associated with the family member | Condition/{id} | Reference | No |
date | The date when the family member history was recorded | 2024-02-12T12:34:56Z | dateTime | No |
note | Any additional notes or free-text information | Patient's father had a heart attack at age 50. | string | No |
Webhooks
Clients can subscribe to receive notifications when a family member history record is created or updated. For more information, go to: Webhooks & Polling.
Error Handling
All FamilyMemberHistory operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling.