FamilyMemberHistory $write

post/FamilyMemberHistory/$write

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. One resource contains details for one individual, not a patient’s entire family.

You can receive, retrieve, or save family history details for a related person.

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.

$write

This operation allows you to save new or updated clinical condition details for a person related to a patient that you’re interacting with or treating.

Request parameters and payload

Select example

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/FamilyMemberHistory/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxFamilyMemberHistoryMessageBundleExample",
8
  "type": "message",
9
  "timestamp": "2021-12-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventCoding": {
20
          "system": "urn:redox:event-type",
21
          "code": "FamilyMemberHistory-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "Patient",
28
        "id": "RedoxPatientExampleTimothyMinimal",
29
        "identifier": [
30
          {
31
            "value": "0000000001",
32
            "system": "urn:redox:health-one:MR"
33
          },
34
          {
35
            "value": "101-01-0001",
36
            "system": "http://hl7.org/fhir/sid/us-ssn"
37
          }
38
        ],
39
        "name": [
40
          {
41
            "given": [
42
              "Timothy",
43
              "Paul"
44
            ],
45
            "family": "Bixby"
46
          }
47
        ],
48
        "gender": "male",
49
        "birthDate": "2008-01-06"
50
      },
51
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=M23462346|urn:redox:MRN"
52
    },
53
    {
54
      "resource": {
55
        "resourceType": "FamilyMemberHistory",
56
        "id": "RedoxFamilyMemberHistoryExample",
57
        "identifier": [
58
          {
59
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.9",
60
            "value": "1381262345"
61
          }
62
        ],
63
        "status": "completed",
64
        "patient": {
65
          "reference": "Patient/RedoxPatientExampleTimothy"
66
        },
67
        "relationship": {
68
          "text": "Father",
69
          "coding": [
70
            {
71
              "code": "FTH",
72
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
73
              "display": "Father"
74
            }
75
          ]
76
        },
77
        "sex": {
78
          "text": "male",
79
          "coding": [
80
            {
81
              "code": "male",
82
              "system": "http://hl7.org/fhir/administrative-gender",
83
              "display": "Male"
84
            }
85
          ]
86
        },
87
        "bornDate": "1912-01-01",
88
        "deceasedBoolean": true,
89
        "condition": [
90
          {
91
            "code": {
92
              "text": "Myocardial infarction",
93
              "coding": [
94
                {
95
                  "code": "22298006",
96
                  "system": "http://snomed.info/sct",
97
                  "display": "Myocardial infarction"
98
                }
99
              ]
100
            },
101
            "onsetAge": {
102
              "value": 57
103
            },
104
            "contributedToDeath": true
105
          },
106
          {
107
            "code": {
108
              "text": "Diabetes mellitus type 1",
109
              "coding": [
110
                {
111
                  "code": "46635009",
112
                  "system": "http://snomed.info/sct",
113
                  "display": "Diabetes mellitus type 1"
114
                }
115
              ]
116
            },
117
            "onsetAge": {
118
              "value": 40
119
            }
120
          }
121
        ]
122
      },
123
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/FamilyMemberHistory?identifier=1381262345|urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.9"
124
    }
125
  ]
126
}'

Request Body Schema

resourceType
required, string
Identifies the type of the resource
Value: Bundle
type
required, string
Identifies this bundle as a message
Value: message
entry
required, Array of MessageHeader, Patient, FamilyMemberHistory or Other
An array of FHIR resources. At a minimum, a Family Member History should include the following entries:
- Patient - the patient
- FamilyMemberHistory - the family member history as it relates to the patient
timestamp
string
The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

1
"Operation Response"

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