1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. FamilyMemberHistory

Update a family member history

put

/FamilyMemberHistory/{ID}

Updates a family member history.

Note:

  • You can remove conditions from a family member history if you set the condition-lifecycle-status modifierExtension to entered-in-error with a system of http://terminology.hl7.org/CodeSystem/condition-ver-status. Only existing conditions can be removed and the condition ID must be provided.
  • Only perform an update 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 the GET.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : FamilyMemberHistoryUpdateBody
Type: object
Show Source
  • condition
    The significant conditions (or condition) that the family member had.
    Note: Each item on the list must represent a distinct condition.
  • condition.code
    The actual condition specified.
    Example: 
    {
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "57054005"
      }
    ]
  }
}
  • condition.extension(condition-course)
    An 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)
    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"
          }
        ]
      }
    }
  ]
}
  • The unique ID for inter-element referencing.
    Note: If a condition.id is returned on a read, it must be provided on an update.
    Example: 
    {
  "id": "111"
}
  • condition.modifierExension(condition-lifecycle-status)
    An indication of whether a condition is active, inactive, resolved, and so on. 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"
           }
         ]
       }
    }
  ]
}

    {
  "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.modifierExension(condition-result)
    An 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.note
    An area where general notes can be placed about this specific condition.
    Example: 
    {
  "note": [
    {
      "text": "Comment about condition"
    }
  ],
}
  • The age of onset.
    Note: When onsetAge is provided without the precision extension, it is defaulted to Age.
    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"
            }
          ]
        }
      }
    ]
  }
}
  • condition.onsetAge.extension(precision)
    The precision of a given value.
    Note: When precision is not provided, it is defaulted to Age.
    Example: 
    {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
  • extension(patient-adopted)
    An indication of whether a patient is adopted.
    Note: Only returned when the relationship is FAMMEMB and the value is true.
    Example: 
    {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/patient-adopted",
      "valueBoolean": true
    }
  ]
}
  • The logical ID of the resource to update.
    Example: { "id": "12504018-12764234" }
Match All
Show Source
Example:
{
  "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"
        }
      ]
    }
  ]
}
Nested Schema : condition
Type: object
The significant conditions (or condition) that the family member had.
Note: Each item on the list must represent a distinct condition.
Nested Schema : condition.code
Type: object
The actual condition specified.
Example: 
{
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "57054005"
      }
    ]
  }
}
Show Source
Nested Schema : condition.extension(condition-course)
Type: object
An 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"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : condition.extension(familymemberhistory-severity)
Type: object
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"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : condition.modifierExension(condition-lifecycle-status)
Type: object
An indication of whether a condition is active, inactive, resolved, and so on. 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"
           }
         ]
       }
    }
  ]
}

{
  "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"
           }
         ]
       }
    }
  ]
}
Show Source
Nested Schema : condition.modifierExension(condition-result)
Type: object
An 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"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : condition.note
Type: object
An area where general notes can be placed about this specific condition.
Example: 
{
  "note": [
    {
      "text": "Comment about condition"
    }
  ],
}
Show Source
Nested Schema : condition.onsetAge.extension(precision)
Type: object
The precision of a given value.
Note: When precision is not provided, it is defaulted to Age.
Example: 
{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : extension(patient-adopted)
Type: object
An indication of whether a patient is adopted.
Note: Only returned when the relationship is FAMMEMB and the value is true.
Example: 
{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/patient-adopted",
      "valueBoolean": true
    }
  ]
}
Show Source
Nested Schema : FamilyMemberHistoryCreateBody
Type: object
Show Source
  • The actual or approximate date of birth of the relative.
    Example: 
    {
  "bornDate": "1998-12-07"
}
  • dataAbsentReason
    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"
      }
    ]
  }
}
  • A deceased flag or the approximate age of the relative at the time of death for the family member history record.
    Note:
    • When the deceased field is not provided, it is defaulted to deceasedBoolean false.
    • When the deceasedAge is provided without the precision extension, it is defaulted to Age.
    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"
            }
          ]
        }
      }
    ]
  }
}

    {
  "deceasedBoolean": true
}
  • deceasedAge.extension(precision)
    The precision of a given value.
    Note: When precision is not provided, it is defaulted to Age. Example: 
    {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
  • The family member's name.
    Example: 
    {
  "name": "Halpert, Simothy"
}
  • patient
    The person whom this history concerns.
    Example: 
    {
  "patient": {
    "reference": "Patient/631923",
    "display": "Nilsson, Christine"
  }
}
  • relationship
    The type of relationship this person has to the patient (father, mother, brother, and so on).
    Note: A relationship of FAMMEMB indicates a family member history that contains information specific to the patient that pertains to all relations of the patient.
    Example: 
    {
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "BRO"
      }
    ]
  }
}
  • sex
    The birth sex of the family member.
    Example: 
    {
  "sex": {
    "coding": [
      {
        "code": "male",
        "system": "http://hl7.org/fhir/administrative-gender"
      }
    ]
  }
}
  • A code specifying the status of the record of the family history of a specific family member.
    Example: 
    {
  "status": "partial"
}
Example:
{
  "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"
  }
}
Nested Schema : FamilyMemberHistoryUpdateBody-allOf[1]
Type: object
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorReference
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dataAbsentReason
Type: object
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"
      }
    ]
  }
}
Show Source
Nested Schema : deceasedAge.extension(precision)
Type: object
The precision of a given value.
Note: When precision is not provided, it is defaulted to Age. Example: 
{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/precision",
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "26175008",
            "system": "http://snomed.info/sct"
          }
        ]
      }
    }
  ]
}
Show Source
Nested Schema : patient
Type: object
The person whom this history concerns.
Example: 
{
  "patient": {
    "reference": "Patient/631923",
    "display": "Nilsson, Christine"
  }
}
Show Source
Nested Schema : relationship
Type: object
The type of relationship this person has to the patient (father, mother, brother, and so on).
Note: A relationship of FAMMEMB indicates a family member history that contains information specific to the patient that pertains to all relations of the patient.
Example: 
{
  "relationship": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
        "code": "BRO"
      }
    ]
  }
}
Show Source
Nested Schema : sex
Type: object
The birth sex of the family member.
Example: 
{
  "sex": {
    "coding": [
      {
        "code": "male",
        "system": "http://hl7.org/fhir/administrative-gender"
      }
    ]
  }
}
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Headers

Default Response

This operation supports the following authorization types: Example Request: 
PUT https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/123
Example Response: 
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Mon, 06 Apr 2020 19:00:43 GMT
  Etag: W/"1"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/17228728
  Last-Modified: Mon, 06 Apr 2020 19:00:43 GMT
  Vary: Origin
  X-Request-Id: 11111111111111111111111111111111
The ETag response header indicates the current If-Match version to use on a subsequent update.
Back to Top