FamilyMemberHistory - FHIR Resource (dstu2)
This FamilyMemberHistory Resource uses the FHIR API standard for access and structure.
Validate an FamilyMemberHistory FHIR Resource (dstu2)
FamilyMemberHistory Attributes
AttributeField is listTypeDescription
Description: partial | completed | entered-in-error | health-unknown
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (FamilyMemberHistory) status FHIR attribute
Description: "bornDate" : "<date>",
FHIR Version: dstu2
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: "ageString" : "<string>",
FHIR Version: dstu2
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: Patient history is about
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (FamilyMemberHistory) patient FHIR attribute
Description: The family member described
FHIR Version: dstu2
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: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relationship": Learn more about the (FamilyMemberHistory) relationship FHIR attribute
Description: "deceasedString" : "<string>",
FHIR Version: dstu2
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: male | female | other | unknown
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"gender": Learn more about the (FamilyMemberHistory) gender FHIR attribute
Description: "bornString" : "<string>",
FHIR Version: dstu2
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: "deceasedDate" : "<date>",
FHIR Version: dstu2
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: "bornPeriod" : { Period },
FHIR Version: dstu2
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: "deceasedBoolean" : <boolean>,
FHIR Version: dstu2
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: General note about related person
FHIR Version: dstu2
Attribute Type : Annotation
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (FamilyMemberHistory) note FHIR attribute
Description: "ageQuantity" : { Quantity(Age) },
FHIR Version: dstu2
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"ageQuantity": Learn more about the (FamilyMemberHistory) ageQuantity FHIR attribute
Description: "deceasedQuantity" : { Quantity(Age) },
FHIR Version: dstu2
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deceasedQuantity": Learn more about the (FamilyMemberHistory) deceasedQuantity FHIR attribute
Description: "deceasedRange" : { Range },
FHIR Version: dstu2
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: "ageRange" : { Range },
FHIR Version: dstu2
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: External Id(s) for this record
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (FamilyMemberHistory) identifier FHIR attribute
Description: When history was captured/updated
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (FamilyMemberHistory) date FHIR attribute
Description: Condition that the related person had
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"condition": Learn more about the (FamilyMemberHistory) condition FHIR attribute
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
"patient" : { Reference(Patient) }, // R! Patient history is about
"date" : "<dateTime>", // When history was captured/updated
"status" : "<code>", // R! partial | completed | entered-in-error | health-unknown
"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:
"ageQuantity" : { Quantity(Age) },
"ageRange" : { Range },
"ageString" : "<string>",
// deceased[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>,
"deceasedQuantity" : { Quantity(Age) },
"deceasedRange" : { Range },
"deceasedDate" : "<date>",
"deceasedString" : "<string>",
"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:
"onsetQuantity" : { Quantity(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/dstu2/FamilyMemberHistory?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | condition.code |
date | date | date |
gender | text | gender |
identifier | text | identifier |
patient | reference | patient |
relationship | text | relationship |
