FamilyMemberHistory - FHIR Resource (r4)
This FamilyMemberHistory Resource uses the FHIR API standard for access and structure.
Validate an FamilyMemberHistory FHIR Resource (r4)
FamilyMemberHistory Attributes
AttributeField is listTypeDescription
Description: External Id(s) for this record
FHIR Version: r4
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
Description: "instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|
FHIR Version: r4
Attribute Type : canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (FamilyMemberHistory) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": [
"http://example.org/family-member-history-questionnaire"
]Learn more about the (FamilyMemberHistory) instantiatesUri FHIR attribute
Description: partial | completed | entered-in-error | health-unknown
FHIR Version: r4
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: subject-unknown | withheld | unable-to-obtain | deferred
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dataAbsentReason": Learn more about the (FamilyMemberHistory) dataAbsentReason FHIR attribute
Description: Patient history is about
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example",
"display": "Peter Patient"
}Learn more about the (FamilyMemberHistory) patient FHIR attribute
Description: When history was recorded or last updated
FHIR Version: r4
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: The family member described
FHIR Version: r4
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: Relationship to the subject
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "FTH",
"display": "father"
}
]
}Learn more about the (FamilyMemberHistory) relationship FHIR attribute
Description: male | female | other | unknown
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "male",
"display": "Male"
}
]
}Learn more about the (FamilyMemberHistory) sex FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Period|date|string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"born[x]": Learn more about the (FamilyMemberHistory) born[x] FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Age|Range|string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"age[x]": Learn more about the (FamilyMemberHistory) age[x] FHIR attribute
Description: C? Age is estimated?
FHIR Version: r4
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:
FHIR Version: r4
Attribute Type : boolean|Age|Range|date|string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deceased[x]": Learn more about the (FamilyMemberHistory) deceased[x] FHIR attribute
Description: Why was family member history performed?
FHIR Version: r4
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: "reasonReference" : [{ Reference(Condition|Observation|AllergyIntolerance|
FHIR Version: r4
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: General note about related person
FHIR Version: r4
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: Condition that the related person had
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"condition": [
{
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "315619001",
"display": "Myocardial Infarction"
}
],
"text": "Heart Attack"
},
"contributedToDeath": true,
"onsetAge": {
"value": 74,
"unit": "yr",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"note": [
{
"text": "Was fishing at the time. At least he went doing someting he loved."
}
]
}
]Learn more about the (FamilyMemberHistory) condition FHIR attribute
FamilyMemberHistory Example
{
"resourceType": "FamilyMemberHistory",
"id": "father",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
},
"identifier": [
{
"value": "12345"
}
],
"instantiatesUri": [
"http://example.org/family-member-history-questionnaire"
],
"status": "completed",
"patient": {
"reference": "Patient/example",
"display": "Peter Patient"
},
"date": "2011-03-18",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "FTH",
"display": "father"
}
]
},
"sex": {
"coding": [
{
"system": "http://hl7.org/fhir/administrative-gender",
"code": "male",
"display": "Male"
}
]
},
"condition": [
{
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "315619001",
"display": "Myocardial Infarction"
}
],
"text": "Heart Attack"
},
"contributedToDeath": true,
"onsetAge": {
"value": 74,
"unit": "yr",
"system": "http://unitsofmeasure.org",
"code": "a"
},
"note": [
{
"text": "Was fishing at the time. At least he went doing someting he loved."
}
]
}
]
}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
"instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|
ActivityDefinition|Measure|OperationDefinition) }], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"status" : "<code>", // R! partial | completed | entered-in-error | health-unknown
"dataAbsentReason" : { CodeableConcept }, // subject-unknown | withheld | unable-to-obtain | deferred
"patient" : { Reference(Patient) }, // R! Patient history is about
"date" : "<dateTime>", // When history was recorded or last updated
"name" : "<string>", // The family member described
"relationship" : { CodeableConcept }, // R! Relationship to the subject
"sex" : { CodeableConcept }, // 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|DiagnosticReport|DocumentReference) }], // 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.
"contributedToDeath" : <boolean>, // Whether the condition contributed to the cause of death
// 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/r4/FamilyMemberHistory?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | condition.code |
date | date | date |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
patient | reference | patient |
relationship | text | relationship |
sex | text | sex |
status | text | status |
