FamilyMemberHistory REST Endpoints

Sort by

Task Path Method

Description

FamilyMemberHistory

This topic describes information for the FamilyMemberHistory resource.

Overview

The FamilyMemberHistory resource represents family history for a given patient. The resource may provide a list of conditions associated with a patient's family member or the absence of a condition on a given individual. In other cases, the resource may indicate that no relevant family history exists, no significant history for a given relative exists, or the patient's family history is unknown or unobtainable.

The resource should be used as a snapshot in time and new information should be consistently retrieved through the API rather than stored in an application. In some instances, a relative could have an associated condition removed from the patient's chart, which would then no longer be exposed on a subsequent transaction. Information must be refreshed with every interaction.

Oracle Cerner recommends that an update to FamilyMemberHistory contains all relevant information that previously existed on the resource to ensure that information remains populated in the patient's chart (for example, FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, and so on). The absence of this optional information may remove the existing information from the patient's chart.

Fields

• ID

• Status

• Data Absent Reason

• Patient

• Date

• Name

• Relationship

• Sex

• Born

• Age

• Deceased

  • Precision Extension

• Extension

  • Patient Adopted

• Condition

  • ID

  • Code

  • Onset

• Precision Extension

  • Note

  • Modifier Extension

• Condition Result

• Condition Lifecycle Status

  • Extension

• Condition Course

• Family Member History Severity

Terminology Bindings

• FamilyMemberHistory.category

  Description: The category of the communication.

  • Details: FamilyMemberHistory Category

    System: http://terminology.hl7.org/CodeSystem/communication-category

  • Details: SNOMED CT

    System: http://snomed.info/sct

• FamilyMemberHistory.email-status

  Description: The status of the email. May be received, in-progress, or completed.

  Details: FamilyMemberHistory Email Status Extension

  System: http://hl7.org/fhir/task-status

Extensions

ID	Value[x} Type	Description
condition-result	CodeableConcept	Indicates the presence (positive) or absence (negative) of a given condition.
condition-lifecycle-status	CodeableConcept	Indicates whether a condition is active, inactive, resolved, and so on.
patient-adopted	Boolean	Indicates whether a patient is adopted. Only returned when true.
precision	CodeableConcept	Indicates the precision of a given value.
condition-course	CodeableConcept	Indicates a condition's progress since diagnosis.
familymemberhistory-severity	CodeableConcept	Indicates the seriousness or health impact of the family member's condition.

FamilyMemberHistory

The operations from the FamilyMemberHistory category.

Create a family member history

Method: post

Path: /FamilyMemberHistory

Get a family member history by ID

Method: get

Path: /FamilyMemberHistory/{ID}

Get a list of family member histories

Method: get

Path: /FamilyMemberHistory

Update a family member history

Method: put

Path: /FamilyMemberHistory/{ID}