Get Family Member History
GET {{baseUrl}}/api/v2/ReferenceData?resourceType=familymemberhistory&searchString=anxiety
Overview:
This API takes an input parameter resourceType that has value 'familymemberhistory', and returns condition or problem-related data from systems like SNOMED. It provides a paginated response containing detailed information about medical conditions relevant to family history, including SNOMED codes, concept statuses, and usage statistics.
.This is only supported in ELATION.
Example Response:
- SNOMED: Returns information about conditions related to family member history, such as the SNOMED Concept ID (CID), Full-Specified Name (FSN), occurrence, and concept status (e.g.,
Anxiety (finding)
).
Use Cases:
Populating FamilyMemberHistory Resources: This API can be used to retrieve SNOMED codes and details for conditions affecting family members, which can be used to create or update FamilyMemberHistory resources in healthcare systems.
Standardizing Family Health Data: By using SNOMED codes, this API ensures that family member health history is standardized across healthcare systems, making it easier to share and interpret data.
Clinical Documentation and Decision Support: Clinicians or healthcare applications can leverage this API to document relevant family medical history, supporting better clinical decision-making based on familial risk factors
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
resourceType | string | (Required) The type of resource to search for | |
searchString | string | (Required) The search string to use |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source ID to use | |
Authorization | string |
RESPONSES
status: OK
{"context":{"system":"\u003cstring\u003e","category":"\u003cstring\u003e"},"data":{"pagination":{"count":"\u003cinteger\u003e"},"result":[{"UMLS_CUI":"\u003cstring\u003e","SNOMED_CONCEPT_STATUS":"\u003cstring\u003e","SNOMED_FSN":"\u003cstring\u003e","OCCURRENCE":"\u003cstring\u003e","SNOMED_CID":"\u003cstring\u003e","USAGE":"\u003cstring\u003e","FIRST_IN_SUBSET":"\u003cstring\u003e","IS_RETIRED_FROM_SUBSET":"\u003cstring\u003e","LAST_IN_SUBSET":"\u003cstring\u003e","REPLACED_BY_SNOMED_CID":"\u003cstring\u003e"},{"UMLS_CUI":"\u003cstring\u003e","SNOMED_CONCEPT_STATUS":"\u003cstring\u003e","SNOMED_FSN":"\u003cstring\u003e","OCCURRENCE":"\u003cstring\u003e","SNOMED_CID":"\u003cstring\u003e","USAGE":"\u003cstring\u003e","FIRST_IN_SUBSET":"\u003cstring\u003e","IS_RETIRED_FROM_SUBSET":"\u003cstring\u003e","LAST_IN_SUBSET":"\u003cstring\u003e","REPLACED_BY_SNOMED_CID":"\u003cstring\u003e"}]}}