FamilyMemberHistory - FHIR Resource (stu3)

This FamilyMemberHistory Resource uses the FHIR API standard for access and structure.

Validate an FamilyMemberHistory FHIR Resource (stu3)

FamilyMemberHistory Attributes

AttributeField is listTypeDescription

Description: General note about related person

FHIR Version: stu3

Attribute Type : Annotation

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"note":

Learn more about the (FamilyMemberHistory) note FHIR attribute

Description: "deceasedAge" : { Age },

FHIR Version: stu3

Attribute Type : Age

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"deceasedAge":

Learn more about the (FamilyMemberHistory) deceasedAge FHIR attribute

Description: "deceasedDate" : "<date>",

FHIR Version: stu3

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"deceasedDate":

Learn more about the (FamilyMemberHistory) deceasedDate FHIR attribute

Description: "ageRange" : { Range },

FHIR Version: stu3

Attribute Type : Range

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"ageRange":

Learn more about the (FamilyMemberHistory) ageRange FHIR attribute

Description: "deceasedRange" : { Range },

FHIR Version: stu3

Attribute Type : Range

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"deceasedRange":

Learn more about the (FamilyMemberHistory) deceasedRange FHIR attribute

Description: Why was family member history performed?

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reasonCode":

Learn more about the (FamilyMemberHistory) reasonCode FHIR attribute

Description: "bornDate" : "<date>",

FHIR Version: stu3

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"bornDate":

Learn more about the (FamilyMemberHistory) bornDate FHIR attribute

Description: "bornString" : "<string>",

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"bornString":

Learn more about the (FamilyMemberHistory) bornString FHIR attribute

Description: "deceasedString" : "<string>",

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"deceasedString":

Learn more about the (FamilyMemberHistory) deceasedString FHIR attribute

Description: C? Age is estimated?

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"estimatedAge":

Learn more about the (FamilyMemberHistory) estimatedAge FHIR attribute

Description: "bornPeriod" : { Period },

FHIR Version: stu3

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"bornPeriod":

Learn more about the (FamilyMemberHistory) bornPeriod FHIR attribute

Description: partial | completed | entered-in-error | health-unknown

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "completed"

Learn more about the (FamilyMemberHistory) status FHIR attribute

Description: Patient history is about

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"patient": {
  "display": "Peter Patient",
  "reference": "Patient/example"
}

Learn more about the (FamilyMemberHistory) patient FHIR attribute

Description: Relationship to the subject

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"relationship": {
  "coding": [
    {
      "code": "FTH",
      "system": "http://hl7.org/fhir/v3/RoleCode",
      "display": "father"
    }
  ]
}

Learn more about the (FamilyMemberHistory) relationship FHIR attribute

Description: The taking of a family member's history did not occur

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"notDone": false

Learn more about the (FamilyMemberHistory) notDone FHIR attribute

Description: When history was captured/updated

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2011-03-18"

Learn more about the (FamilyMemberHistory) date FHIR attribute

Description: Condition that the related person had

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"condition": [
  {
    "note": [
      {
        "text": "Was fishing at the time. At least he went doing someting he loved."
      }
    ],
    "onsetAge": {
      "code": "a",
      "unit": "yr",
      "value": 74,
      "system": "http://unitsofmeasure.org"
    },
    "code": {
      "text": "Heart Attack",
      "coding": [
        {
          "code": "315619001",
          "system": "http://snomed.info/sct",
          "display": "Myocardial Infarction"
        }
      ]
    }
  }
]

Learn more about the (FamilyMemberHistory) condition FHIR attribute

Description: Instantiates protocol or definition

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"definition": [
  {
    "display": "Family Member History Questionnaire"
  }
]

Learn more about the (FamilyMemberHistory) definition FHIR attribute

Description: "ageString" : "<string>",

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"ageString":

Learn more about the (FamilyMemberHistory) ageString FHIR attribute

Description: "reasonReference" : [{ Reference(Condition|Observation|AllergyIntolerance|

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reasonReference":

Learn more about the (FamilyMemberHistory) reasonReference FHIR attribute

Description: The family member described

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name":

Learn more about the (FamilyMemberHistory) name FHIR attribute

Description: male | female | other | unknown

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"gender": "male"

Learn more about the (FamilyMemberHistory) gender FHIR attribute

Description: "deceasedBoolean" : <boolean>,

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"deceasedBoolean":

Learn more about the (FamilyMemberHistory) deceasedBoolean FHIR attribute

Description: C? subject-unknown | withheld | unable-to-obtain | deferred

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"notDoneReason":

Learn more about the (FamilyMemberHistory) notDoneReason FHIR attribute

Description: "ageAge" : { Age },

FHIR Version: stu3

Attribute Type : Age

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"ageAge":

Learn more about the (FamilyMemberHistory) ageAge FHIR attribute

Description: External Id(s) for this record

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "value": "12345"
  }
]

Learn more about the (FamilyMemberHistory) identifier FHIR attribute

FamilyMemberHistory Example

{
  "status": "completed",
  "definition": [
    {
      "display": "Family Member History Questionnaire"
    }
  ],
  "patient": {
    "display": "Peter Patient",
    "reference": "Patient/example"
  },
  "relationship": {
    "coding": [
      {
        "code": "FTH",
        "system": "http://hl7.org/fhir/v3/RoleCode",
        "display": "father"
      }
    ]
  },
  "resourceType": "FamilyMemberHistory",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
  },
  "date": "2011-03-18",
  "gender": "male",
  "notDone": false,
  "identifier": [
    {
      "value": "12345"
    }
  ],
  "id": "father",
  "condition": [
    {
      "note": [
        {
          "text": "Was fishing at the time. At least he went doing someting he loved."
        }
      ],
      "onsetAge": {
        "code": "a",
        "unit": "yr",
        "value": 74,
        "system": "http://unitsofmeasure.org"
      },
      "code": {
        "text": "Heart Attack",
        "coding": [
          {
            "code": "315619001",
            "system": "http://snomed.info/sct",
            "display": "Myocardial Infarction"
          }
        ]
      }
    }
  ]
}

FamilyMemberHistory Structure


  
{
  "resourceType" : "FamilyMemberHistory",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Id(s) for this record
  "definition" : [{ Reference(PlanDefinition|Questionnaire) }], // Instantiates protocol or definition
  "status" : "<code>", // R!  partial | completed | entered-in-error | health-unknown
  "notDone" : <boolean>, // The taking of a family member's history did not occur
  "notDoneReason" : { CodeableConcept }, // C? subject-unknown | withheld | unable-to-obtain | deferred
  "patient" : { Reference(Patient) }, // R!  Patient history is about
  "date" : "<dateTime>", // When history was captured/updated
  "name" : "<string>", // The family member described
  "relationship" : { CodeableConcept }, // R!  Relationship to the subject
  "gender" : "<code>", // male | female | other | unknown
  // born[x]: (approximate) date of birth. One of these 3:
  "bornPeriod" : { Period },
  "bornDate" : "<date>",
  "bornString" : "<string>",
  // age[x]: (approximate) age. One of these 3:
  "ageAge" : { Age },
  "ageRange" : { Range },
  "ageString" : "<string>",
  "estimatedAge" : <boolean>, // C? Age is estimated?
  // deceased[x]: Dead? How old/when?. One of these 5:
  "deceasedBoolean" : <boolean>,
  "deceasedAge" : { Age },
  "deceasedRange" : { Range },
  "deceasedDate" : "<date>",
  "deceasedString" : "<string>",
  "reasonCode" : [{ CodeableConcept }], // Why was family member history performed?
  "reasonReference" : [{ Reference(Condition|Observation|AllergyIntolerance|
   QuestionnaireResponse) }], // Why was family member history performed?
  "note" : [{ Annotation }], // General note about related person
  "condition" : [{ // Condition that the related person had
    "code" : { CodeableConcept }, // R!  Condition suffered by relation
    "outcome" : { CodeableConcept }, // deceased | permanent disability | etc.
    // onset[x]: When condition first manifested. One of these 4:
    "onsetAge" : { Age },
    "onsetRange" : { Range },
    "onsetPeriod" : { Period },
    "onsetString" : "<string>",
    "note" : [{ Annotation }] // Extra information about condition
  }]
}

FamilyMemberHistory Search Parameters

The following search parameters can be used to query FamilyMemberHistory resources. Just submit them like so:

https://api.1up.health/fhir/stu3/FamilyMemberHistory?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`code`	`text`	`condition.code`
`date`	`date`	`date`
`definition`	`reference`	`definition`
`gender`	`text`	`gender`
`identifier`	`text`	`identifier`
`patient`	`reference`	`patient`
`relationship`	`text`	`relationship`
`status`	`text`	`status`