FamilyMemberHistory REST Endpoints

Sort by

Task Path Method

Description

FamilyMemberHistory

This topic describes information for the FamilyMemberHistory resource.

Overview

Note:

The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

The FamilyMemberHistory resource represents a patient's family health history. It may describe conditions associated with a family member, the absence of a condition, or that relevant family history is unknown or unavailable.

Family history is a snapshot in time. Retrieve it again when current information is needed rather than treating a previous response as a permanent record.

Profile Support

US Core 6.1.0 does not define a standalone FamilyMemberHistory profile. This API uses the base FHIR R4 FamilyMemberHistory resource.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
FamilyMemberHistory	DomainResource
FamilyMemberHistory.id	id
FamilyMemberHistory.status	code
FamilyMemberHistory.dataAbsentReason	CodeableConcept
FamilyMemberHistory.text	Narrative
FamilyMemberHistory.patient	Reference(Patient)
FamilyMemberHistory.date	dateTime
FamilyMemberHistory.name	string
FamilyMemberHistory.relationship	CodeableConcept
FamilyMemberHistory.sex	CodeableConcept
FamilyMemberHistory.born[x]	Period date string
FamilyMemberHistory.age[x]	Age string
FamilyMemberHistory.estimatedAge	boolean
FamilyMemberHistory.deceasedBoolean	boolean
FamilyMemberHistory.condition	BackboneElement
FamilyMemberHistory.condition.code	CodeableConcept
FamilyMemberHistory.condition.onset[x]	Age string
FamilyMemberHistory.condition.note	Annotation

Terminology Bindings

Element	Description	Details
FamilyMemberHistory.status	The status of the family history record.	FamilyHistoryStatus
FamilyMemberHistory.dataAbsentReason	Why family history information is absent.	FamilyHistoryAbsentReason
FamilyMemberHistory.relationship	The family member's relationship to the patient.	Family Member
FamilyMemberHistory.sex	The family member's administrative sex.	Administrative Gender
FamilyMemberHistory.condition.code	The condition affecting the family member.	Condition/Problem/Diagnosis Codes

Extensions

ID	Value Type	Description
condition-course	CodeableConcept	The condition's progress since diagnosis.
condition-lifecycle-status	CodeableConcept	Whether the condition is active, inactive, resolved, and so on.
condition-result	CodeableConcept	Whether the condition is present or absent.
familymemberhistory-severity	CodeableConcept	The seriousness or health impact of the condition.
precision	CodeableConcept	The precision of a reported onset age.

FamilyMemberHistory

The operations from the FamilyMemberHistory category.

Get a family member history by ID

Method: get

Path: /FamilyMemberHistory/{id}

Get a list of family member histories

Method: get

Path: /FamilyMemberHistory