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

Create a family member history

post

/FamilyMemberHistory

Creates a new family member history.

Note:

  • Only the body fields below are supported. Unsupported fields are ignored.
  • You cannot add conditions while creating the family member history.

Request

Supported Media Types
Header Parameters
Body ()
Root 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 : 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

201 Response

**OK**
Headers
  • The identifier for a specific version of a resource. This identifier is formatted as W/"" and used to specify the If-Match header value on subsequent updates.
  • The URL location of the created entity. Example: 
    https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory/642774
  • Oracle troubleshooting identifier.
  • Oracle troubleshooting identifier.

Default Response

This operation supports the following authorization types: Example Request: 
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/FamilyMemberHistory
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