FamilyMemberHistory read

get/FamilyMemberHistory/{id}

Page View

This resource contains health conditions for a person related to a patient that may be relevant to the patient’s care.

The history may be very specific or not, depending on the level of disclosure by the patient. Also, one resource contains details for one individual, not a patient’s entire family.

You can review or retrieve family history details for a related person.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific FamilyMemberHistory resource with clinical conditions for a person related to a patient you're treating.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/FamilyMemberHistory/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
FamilyMemberHistory identifier

Response fields and example

Completed Family Member History

json

1
{}

A profile on the family member history resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: FamilyMemberHistory
status
required, string
A code specifying the status of the record of the family history of a specific family member.
Possible Values: partial, completed, entered-in-error, health-unknown
patient
required, object
The person who this history concerns.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
relationship
required, object
The type of relationship this person has to the patient (father, mother, brother etc.).
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
sex
object
The birth sex of the family member.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
condition
Array of object
The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
- code
  required, object
  The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
- contributedToDeath
  boolean
  This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
- onsetAge
  object
  Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
  value
  number
  The value of the measured amount. The value includes an implicit precision in the presentation of the value.
  unit
  string
  A human-readable form of the unit.
  Value: yr
bornDate
string
The actual or approximate date of birth of the relative.
deceasedBoolean
boolean
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.