Home
API reference
FHIR® API
FHIR® resources
FamilyMemberHistory
_search

FamilyMemberHistory _search

post/FamilyMemberHistory/_search
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.

_search

Query for clinical condition details about a person related to a patient you're interacting with or treating.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/FamilyMemberHistory/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string'

Request Body Schema

  • patient
    Array of string

    The patient this history is about

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "FamilyMemberHistory",
9
        "id": "RedoxFamilyMemberHistoryExample",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.9",
13
            "value": "1381262345"
14
          }
15
        ],
16
        "status": "completed",
17
        "patient": {
18
          "reference": "Patient/RedoxPatientExampleTimothy"
19
        },
20
        "relationship": {
21
          "text": "Father",
22
          "coding": [
23
            {
24
              "code": "FTH",
25
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
26
              "display": "Father"
27
            }
28
          ]
29
        },
30
        "sex": {
31
          "text": "male",
32
          "coding": [
33
            {
34
              "code": "male",
35
              "system": "http://hl7.org/fhir/administrative-gender",
36
              "display": "Male"
37
            }
38
          ]
39
        },
40
        "bornDate": "1912-01-01",
41
        "deceasedBoolean": true,
42
        "condition": [
43
          {
44
            "code": {
45
              "text": "Myocardial infarction",
46
              "coding": [
47
                {
48
                  "code": "22298006",
49
                  "system": "http://snomed.info/sct",
50
                  "display": "Myocardial infarction"
51
                }
52
              ]
53
            },
54
            "onsetAge": {
55
              "value": 57
56
            },
57
            "contributedToDeath": true
58
          },
59
          {
60
            "code": {
61
              "text": "Diabetes mellitus type 1",
62
              "coding": [
63
                {
64
                  "code": "46635009",
65
                  "system": "http://snomed.info/sct",
66
                  "display": "Diabetes mellitus type 1"
67
                }
68
              ]
69
            },
70
            "onsetAge": {
71
              "value": 40
72
            }
73
          }
74
        ]
75
      },
76
      "search": {
77
        "mode": "match"
78
      }
79
    }
80
  ]
81
}

    Response to a Family Member History search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of FamilyMemberHistory or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A record of significant health conditions for a person related to the patient relevant in the context of care for the patient.

      • 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.

          • 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.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the FamilyMemberHistory as matching the search parameters

        Value: match