Millennium

FamilyMemberHistory

Overview

The FamilyMemberHistory resource represents family history for a given patient. It may provide a list of conditions associated to a patient’s family member or the absence of a condition on a given individual. In other cases, the resource may indicate that there is no relevant family history, no significant history for a given relative, or that the patient’s family history is unknown or unable to obtain.

The resource should be leveraged as a snapshot in time and new data should be consistently retrieved through the API rather than stored within an application. There may be instances where a relative had an associated condition removed from the patient’s chart which would then no longer be exposed on a subsequent transaction. It is crucial that the data be refreshed with every interaction.

It is recommended that an update to FamilyMemberHistory contain all relevant data that previously existed on the resource to ensure that data remains populated in the patient’s chart (e.g., FamilyMemberHistory.sex, FamilyMemberHistory.bornDate, FamilyMemberHistory.condition.onsetDate, etc.). The absence of this optional information may result in the removal of data from the patient’s chart.

The following fields are returned if valued:

Terminology Bindings

FamilyMemberHistory.status
  • Description
    • A code that identifies the status of the family history record.

  • Details: FamilyHistoryStatus
    System: http://hl7.org/fhir/history-status

FamilyMemberHistory.dataAbsentReason
  • Description
    • Codes describing the reason why a family member's history is not available.
  • Note
    • Can be subject-unknown or unable-to-obtain

  • Details: FamilyHistoryAbsentReason
    System: http://terminology.hl7.org/CodeSystem/history-absent-reason

FamilyMemberHistory.relationship
  • Description
    • A relationship between two people characterizing their "familial" relationship

  • Details: V3 Value SetFamilyMember
    System: http://terminology.hl7.org/CodeSystem/v3-RoleCode

FamilyMemberHistory.sex
  • Description
    • The gender of a person used for administrative purposes.

  • Details: AdministrativeGender
    System: http://hl7.org/fhir/administrative-gender

FamilyMemberHistory.deceasedAge.unit
  • Description
    • Code system intended to include all units of measures.

  • Details: Units of Measure
    System: http://unitsofmeasure.org

FamilyMemberHistory.deceasedAge.extension(precision)
  • Description
    • Indication of the precision of a given value.

  • Details: SNOMED CT
    System: http://snomed.info/sct

FamilyMemberHistory.condition.code
  • Description
    • Identification of the condition, problem or diagnosis.

  • Details: SNOMED CT
    System: http://snomed.info/sct

  • Details: Millennium Condition Nomenclature
    System: https://fhir.cerner.com/<EHR source id>/nomenclature

FamilyMemberHistory.condition.onsetAge.unit
  • Description
    • Code system intended to include all units of measures.

  • Details: Units of Measure
    System: http://unitsofmeasure.org

FamilyMemberHistory.condition.onsetAge.extension(precision)
  • Description
    • Indication of the precision of a given value.

  • Details: SNOMED CT
    System: http://snomed.info/sct

FamilyMemberHistory.condition.modifierExension(condition-result)
  • Description
    • Indication of the presence (positive) or absence (negative) of a given condition.

  • Details: SNOMED CT
    System: http://snomed.info/sct

FamilyMemberHistory.condition.modifierExension(condition-lifecycle-status)
  • Description
    • Indication of whether a condition is active, inactive, resolved, etc.

  • Details: Condition Clinical Status Codes
    System: http://terminology.hl7.org/CodeSystem/condition-clinical

  • Details: ConditionVerificationStatus
    System: http://terminology.hl7.org/CodeSystem/condition-ver-status

FamilyMemberHistory.condition.extension(condition-course)
  • Description
    • The progression of a given condition.

  • Details: SNOMED CT
    System: http://snomed.info/sct

FamilyMemberHistory.condition.extension(familymemberhistory-severity)
  • Description
    • The progression of a given condition.

  • Details: SNOMED CT
    System: http://snomed.info/sct

Modifier Extensions

Extensions

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 CodeableConcpet Indication of the presence (positive) or absence (negative) of a given condition.
condition-lifecycle-status CodeableConcpet Indication of whether a condition is active, inactive, resolved, etc.

Extensions

ID Value[x] Type Description
patient-adopted Boolean Indication of whether a patient is adopted. Only returned when true.
precision CodeableConcpet Indication of the precision of a given value.
condition-course CodeableConcpet Indication of a condition’s progress since diagnosis.

Search for FamilyMemberHistories that meet supplied query parameters:

GET /FamilyMemberHistory?:parameters

Implementation Notes

Authorization Types

Provider | Patient | System

Parameters

Name Required? Type Description
_id This or patient token The logical resource id associated with the resource.
patient This or _id reference The identity of a subject to list family member history items for. Example: 12345
status No token The status of the record of the family history of a specific family member.

Implementation Notes

status may only be provided when the patient search parameter is provided

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 FamilyMemberHistory by its id:

GET /FamilyMemberHistory/:id

Implementation Notes

Authorization Types

Provider | Patient | System

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

POST /FamilyMemberHistory

Implementation Notes

Authorization Types

Provider | System

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body Fields

Name Required Type
status Yes code
  • Description
    • A code specifying the status of the record of the family history of a specific family member.
  • Example
    • {
  "status": "partial"
}
dataAbsentReason No CodeableConcept
  • Description
    • Describes why the family member's history is not available.
  • Example
    • {
  "dataAbsentReason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/history-absent-reason",
        "code": "subject-unknown"
      }
    ]
  }
}
patient Yes Reference
  • Description
    • The person who this history concerns.
  • Example
    • {
  "patient": {
    "reference": "Patient/631923",
    "display": "Nilsson, Christine"
  }
}
name No string
  • Description
    • The family member's name.
  • Example
    • {
  "name": "Halpert, Simothy"
}
relationship Yes CodeableConcept
  • Description
    • The type of relationship this person has to the patient (father, mother, brother etc.).
  • Example
    • {
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "BRO"
      }
    ]
  }
}
  • Notes
      • A relationship of FAMMEMB indicates a FamilyMemberHistory that contains information specific to the patient that pertains to all relations of the patient.
sex No CodeableConcept
  • Description
    • The birth sex of the family member.
  • Example
    • {
  "sex": {
    "coding": [
      {
        "code": "male",
        "system": "http://hl7.org/fhir/administrative-gender"
      }
    ]
  }
}
born[x] No date
  • Description
    • The actual or approximate date of birth of the relative.
  • Example
    • {
  "bornDate": "1998-12-07"
}
deceased[x] No Boolean, Quantity
  • Description
    • Deceased flag or the approximate age of the relative at the time of death for the family member history record.
  • Example
    • {
  "deceasedAge": {
    "value": 42,
    "system": "http://unitsofmeasure.org",
    "code": "a",
    "extension": [
      {
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "26175008",
              "system": "http://snomed.info/sct"
            }
          ]
        }
      }
    ]
  }
}
  • Example
    • {
  "deceasedBoolean": true
}
  • Notes
      • When deceased field is not provided, it is defaulted to deceasedBoolean false.
      • When deceasedAge is provided without the precision extension, it is defaulted to 'Age'
deceasedAge.extension(precision) No CodeableConcept
  • Description
    • Indication of the precision of a given value.
  • Example
    • {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
  • Notes
      • When precision is not provided, it is defaulted to 'Age'

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

PUT /FamilyMemberHistory/:id

Implementation Notes

Authorization Types

Provider | System

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body fields

Name Required Type
id Yes id
  • Description
    • The logical id of the resource to update.
  • Example
    • {
  "id": "12504018-12764234"
}
extension(patient-adopted) No Extension
  • Description
    • Indication of whether a patient is adopted.
  • Example
    • {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/patient-adopted",
      "valueBoolean": true
    }
  ]
}
  • Notes
    • Only returned when relationship is FAMMEMB and value is true.
status Yes code
  • Description
    • A code specifying the status of the record of the family history of a specific family member.
  • Example
    • {
  "status": "partial"
}
dataAbsentReason No CodeableConcept
  • Description
    • Describes why the family member's history is not available.
  • Example
    • {
  "dataAbsentReason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/history-absent-reason",
        "code": "subject-unknown"
      }
    ]
  }
}
patient Yes Reference
  • Description
    • The person who this history concerns.
  • Example
    • {
  "patient": {
    "reference": "Patient/631923",
    "display": "Nilsson, Christine"
  }
}
name No string
  • Description
    • The family member's name.
  • Example
    • {
  "name": "Halpert, Simothy"
}
relationship Yes CodeableConcept
  • Description
    • The type of relationship this person has to the patient (father, mother, brother etc.).
  • Example
    • {
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "BRO"
      }
    ]
  }
}
  • Notes
      • A relationship of FAMMEMB indicates a FamilyMemberHistory that contains information specific to the patient that pertains to all relations of the patient.
sex No CodeableConcept
  • Description
    • The birth sex of the family member.
  • Example
    • {
  "sex": {
    "coding": [
      {
        "code": "male",
        "system": "http://hl7.org/fhir/administrative-gender"
      }
    ]
  }
}
born[x] No date
  • Description
    • The actual or approximate date of birth of the relative.
  • Example
    • {
  "bornDate": "1998-12-07"
}
deceased[x] No Boolean, Quantity
  • Description
    • Deceased flag or the approximate age of the relative at the time of death for the family member history record.
  • Example
    • {
  "deceasedAge": {
    "value": 42,
    "system": "http://unitsofmeasure.org",
    "code": "a",
    "extension": [
      {
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "26175008",
              "system": "http://snomed.info/sct"
            }
          ]
        }
      }
    ]
  }
}
  • Example
    • {
  "deceasedBoolean": true
}
  • Notes
      • When deceased field is not provided, it is defaulted to deceasedBoolean false.
      • When deceasedAge is provided without the precision extension, it is defaulted to 'Age'
deceasedAge.extension(precision) No CodeableConcept
  • Description
    • Indication of the precision of a given value.
  • Example
    • {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
  • Notes
      • When precision is not provided, it is defaulted to 'Age'
condition No BackboneElement
  • Description
    • The significant Conditions (or condition) that the family member had.
  • Notes
    • Each item in the list must represent a distinct condition.
condition.id No string
  • Description
    • Unique id for inter-element referencing.
  • Example
    • {
  "id": "111"
}
  • Notes
    • If a condition.id is returned on a read, it must be provided on an update.
condition.code Yes CodeableConcept
  • Description
    • The actual condition specified.
  • Example
    • {
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "57054005"
      }
    ]
  }
}
condition.onset[x] No Quantity
  • Description
    • The age of onset.
  • Example
    • {
  "onsetAge": {
    "value": 42,
    "system": "http://unitsofmeasure.org",
    "code": "a",
    "extension": [
      {
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
        "valueCodeableConcept": {
          "coding": [
            {
              "code": "26175008",
              "system": "http://snomed.info/sct"
            }
          ]
        }
      }
    ]
  }
}
  • Notes
      • When onsetAge is provided without the precision extension, it is defaulted to 'Age'
condition.onsetAge.extension(precision) No CodeableConcept
  • Description
    • Indication of the precision of a given value.
  • Example
    • {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
  • Notes
      • When precision is not provided, it is defaulted to 'Age'
condition.note No Annotation
  • Description
    • An area where general notes can be placed about this specific condition.
  • Example
    • {
  "note": [
    {
      "text": "Comment about condition"
    }
  ],
}
condition.modifierExension(condition-result) Yes CodeableConcept
  • Description
    • Indication of the presence (positive) or absence (negative) of a given condition. Must be provided. The result may indicate the absence of a condition which may lead to different clinical decisions than if the result were positive.
  • Example
    • {
  "modifierExtension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-result",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "10828004"
          }
        ]
      }
    }
  ]
}
condition.modifierExension(condition-lifecycle-status) No CodeableConcept
  • Description
    • Indication of whether a condition is active, inactive, resolved, etc. The lifecycle status indicates the relevance of a given condition. If a condition is resolved or inactivated, it may no longer be clinically relevant. The lifecycle status may not be returned if it is not applicable to the given condition.
  • Example
    • {
  "modifierExtension": [
     {
       "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-lifecycle-status",
       "valueCodeableConcept": {
         "coding": [
           {
             "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
             "code": "active"
           }
         ]
       }
    }
  ]
}
  • Example
    • {
  "modifierExtension": [
     {
       "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-lifecycle-status",
       "valueCodeableConcept": {
         "coding": [
           {
             "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
             "code": "entered-in-error"
           }
         ]
       }
    }
  ]
}
condition.extension(condition-course) No CodeableConcept
  • Description
    • Indication of a condition's progress since diagnosis.
  • Example
    • {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/condition-course",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "58158008"
          }
        ]
      }
    }
  ]
}
condition.extension(familymemberhistory-severity) No CodeableConcept
  • Description
    • A qualification of the seriousness or impact on health of the family member condition.
  • Example
    • {
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "24484000"
          }
        ]
      }
    }
  ]
}

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.