FamilyMemberHistory
- Overview
- Terminology Bindings
- Custom Modifier Extensions and Extensions
- Search
- Retrieve by ID
- Create
- Update
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.
The following fields are returned if valued:
- ID
- Status
- Data Absent Reason
- Patient
- Date
- Name
- Relationship
- Sex
- Born
- Age
- Deceased
- Extension
- Condition
Terminology Bindings
FamilyMemberHistory.status |
|
FamilyMemberHistory.dataAbsentReason |
|
FamilyMemberHistory.relationship |
|
FamilyMemberHistory.sex |
|
FamilyMemberHistory.deceasedAge.unit |
|
FamilyMemberHistory.deceasedAge.extension(precision) |
|
FamilyMemberHistory.condition.code |
|
FamilyMemberHistory.condition.onsetAge.unit |
|
FamilyMemberHistory.condition.onsetAge.extension(precision) |
|
FamilyMemberHistory.condition.modifierExension(condition-result) |
|
FamilyMemberHistory.condition.modifierExension(condition-lifecycle-status) |
|
FamilyMemberHistory.condition.extension(condition-course) |
|
FamilyMemberHistory.condition.extension(familymemberhistory-severity) |
|
Custom Modifier Extensions and Extensions
URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{ID}
Modifier 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. |
Extensions
ID | Value[x] Type | Description |
---|---|---|
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. |
Search
Search for the family member histories that meet the supplied query parameters.
GET /FamilyMemberHistory?:parameters
Notes
- Family member histories with the ‘FAMMEMB’ relation are sometimes system generated.
Authorization Types
Parameters
Name | Required | Type | Description |
---|---|---|---|
_id |
Conditionally | token |
The logical resource ID associated with the resource. This parameter is required if patient is not used. |
patient |
Conditionally | reference |
The identity of a subject to list family member history items for. This parameter is required if _id_ is not used. Example: 12345
|
status |
No | token |
The record status for a specific family member. This parameter is only provided when the patient search parameter is used. |
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory?patient=12504018
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory?patient=12504018"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/12504018",
"resource": {
"resourceType": "FamilyMemberHistory",
"id": "12504018",
"status": "partial",
"patient": {
"reference": "Patient/12504018"
},
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "FAMMEMB",
"display": "family member"
}
],
"text": "family member"
}
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/12504018-12764234",
"resource": {
"resourceType": "FamilyMemberHistory",
"id": "12504018-12764234",
"status": "completed",
"patient": {
"reference": "Patient/12504018"
},
"date": "2021-09-03T09:55:51-05:00",
"name": "Smart, Test",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "SIS",
"display": "sister"
}
],
"text": "Sister"
},
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "female",
"display": "Female"
}
],
"text": "Female"
},
"bornDate": "1993-08-08",
"deceasedAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "397669002",
"display": "Age (qualifier value)"
}
],
"text": "Age"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 18,
"unit": "years",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"condition": [
{
"id": "73196409",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58158008",
"display": "Stable (qualifier value)"
}
],
"text": "Stable"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-course"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "6736007",
"display": "Moderate (severity modifier) (qualifier value)"
}
],
"text": "Moderate"
},
"url": "http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity"
}
],
"modifierExtension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10828004",
"display": "Positive (qualifier value)"
}
],
"text": "POSITIVE"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-result"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active",
"display": "Active"
}
],
"text": "Active"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-lifecycle-status"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "363346000",
"display": "Malignant neoplastic disease (disorder)",
"userSelected": false
},
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature",
"code": "7588338",
"display": "Cancer"
}
],
"text": "Cancer"
},
"onsetAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "26175008",
"display": "Approximate (qualifier value)"
}
],
"text": "About"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 15,
"unit": "Years",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/12742069",
"display": "Portal, Portal"
},
"time": "2021-09-17T14:58:35Z",
"text": "Cancer is common in the family"
}
]
}
]
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by ID
List an individual family member history by its ID.
GET /FamilyMemberHistory/:ID
Notes
- FamilyMemberHistories with the ‘FAMMEMB’ relation are sometimes system generated.
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/12504018-12764234
Response
Status: 200 OK
{
"resourceType": "FamilyMemberHistory",
"id": "12504018-12764234",
"status": "completed",
"patient": {
"reference": "Patient/12504018"
},
"date": "2021-09-03T09:55:51-05:00",
"name": "Smart, Test",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "SIS",
"display": "sister"
}
],
"text": "Sister"
},
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "female",
"display": "Female"
}
],
"text": "Female"
},
"bornDate": "1993-08-08",
"deceasedAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "397669002",
"display": "Age (qualifier value)"
}
],
"text": "Age"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 18,
"unit": "years",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"condition": [
{
"id": "73196409",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58158008",
"display": "Stable (qualifier value)"
}
],
"text": "Stable"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-course"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "6736007",
"display": "Moderate (severity modifier) (qualifier value)"
}
],
"text": "Moderate"
},
"url": "http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity"
}
],
"modifierExtension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10828004",
"display": "Positive (qualifier value)"
}
],
"text": "POSITIVE"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-result"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active",
"display": "Active"
}
],
"text": "Active"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-lifecycle-status"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "363346000",
"display": "Malignant neoplastic disease (disorder)",
"userSelected": false
},
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/nomenclature",
"code": "7588338",
"display": "Cancer"
}
],
"text": "Cancer"
},
"onsetAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "26175008",
"display": "Approximate (qualifier value)"
}
],
"text": "About"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 15,
"unit": "Years",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"note": [
{
"authorReference": {
"reference": "Practitioner/12742069",
"display": "Portal, Portal"
},
"time": "2021-09-17T14:58:35Z",
"text": "Cancer is common in the family"
}
]
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Create
Create a new family member history.
POST /FamilyMemberHistory
Notes
- Only the body fields below are supported. Unsupported fields are ignored.
- Conditions cannot be added while creating the family member history.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
status
|
Yes |
code |
|
|
|||
dataAbsentReason
|
No |
CodeableConcept |
|
|
|||
patient
|
Yes |
Reference |
|
|
|||
name
|
No |
string |
|
|
|||
relationship
|
Yes |
CodeableConcept |
|
|
|||
sex
|
No |
CodeableConcept |
|
|
|||
born[x]
|
No |
date |
|
|
|||
deceased[x]
|
No |
Boolean , Quantity |
|
|
|||
deceasedAge.extension(precision)
|
No |
CodeableConcept |
|
|
Example
Request
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory
Body
{
"resourceType": "FamilyMemberHistory",
"id": "12504018-12764234",
"status": "completed",
"patient": {
"reference": "Patient/12504018"
},
"name": "Smart, Test",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "SIS"
}
]
},
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "female"
}
]
},
"bornDate": "1993-08-08",
"deceasedAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "397669002"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 18,
"system": "http://unitsofmeasure.org",
"code": "a"
}
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Wed, 14 Aug 2019 17:23:14 GMT Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/123-456 Last-Modified: Wed, 14 Aug 2019 17:23:14 GMT Vary: Origin X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea91
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Update
Update a family member history.
PUT /FamilyMemberHistory/:ID
Notes
- Conditions can be removed from a family member history if you set the ‘condition-lifecycle-status’ modifierExtension to ‘entered-in-error’ with system ‘http://terminology.hl7.org/CodeSystem/condition-ver-status’. Only existing conditions can be removed and condition ID must be provided.
- An update should only be performed directly after a family member history is retrieved. If a condition ID is returned for the
GET
request, the ID must be provided on the subsequent update and must match the condition ID returned from theGET
.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body fields
Name | Required | Type | |
---|---|---|---|
id
|
Yes |
id |
|
|
|||
extension(patient-adopted)
|
No |
Extension |
|
|
|||
status
|
Yes |
code |
|
|
|||
dataAbsentReason
|
No |
CodeableConcept |
|
|
|||
patient
|
Yes |
Reference |
|
|
|||
name
|
No |
string |
|
|
|||
relationship
|
Yes |
CodeableConcept |
|
|
|||
sex
|
No |
CodeableConcept |
|
|
|||
born[x]
|
No |
date |
|
|
|||
deceased[x]
|
No |
Boolean , Quantity |
|
|
|||
deceasedAge.extension(precision)
|
No |
CodeableConcept |
|
|
|||
condition
|
No |
BackboneElement |
|
|
|||
condition.id
|
No |
string |
|
|
|||
condition.code
|
Yes |
CodeableConcept |
|
|
|||
condition.onset[x]
|
No |
Quantity |
|
|
|||
condition.onsetAge.extension(precision)
|
No |
CodeableConcept |
|
|
|||
condition.note
|
No |
Annotation |
|
|
|||
condition.modifierExension(condition-result)
|
Yes |
CodeableConcept |
|
|
|||
condition.modifierExension(condition-lifecycle-status)
|
No |
CodeableConcept |
|
|
|||
condition.extension(condition-course)
|
No |
CodeableConcept |
|
|
|||
condition.extension(familymemberhistory-severity)
|
No |
CodeableConcept |
|
|
Example
Request
PUT https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/12504018-12764234
Body
{
"resourceType": "FamilyMemberHistory",
"id": "12504018-12764234",
"status": "completed",
"patient": {
"reference": "Patient/12504018"
},
"name": "Smart, Test",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "SIS"
}
]
},
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "female"
}
]
},
"bornDate": "1993-08-08",
"deceasedAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "397669002"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 18,
"system": "http://unitsofmeasure.org",
"code": "a"
},
"condition": [
{
"id": "73196409",
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "58158008"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-course"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "6736007"
}
]
},
"url": "http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity"
}
],
"modifierExtension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10828004"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-result"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-lifecycle-status"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "363346000"
}
]
},
"onsetAge": {
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "26175008"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision"
}
],
"value": 15,
"system": "http://unitsofmeasure.org",
"code": "a"
},
"note": [
{
"text": "Cancer is common in the family"
}
]
}
]
}
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 0 Content-Type: application/fhir+json Date: Sun, 30 Jun 2019 10:40:00 GMT Vary: Origin X-Request-Id: 1638e30e497b93ff4383b2ff0eaeea91
Errors
The common errors and OperationOutcomes may be returned.