FamilyMemberHistory - FHIR Resource (dstu2)
This FamilyMemberHistory Resource uses the
FHIR API standard for access and structure.
Validate an FamilyMemberHistory FHIR Resource (dstu2)
Resource Attributes
Attribute | Field is list | Type | Description |
---|
ageQuantity | false | Quantity | # "ageQuantity" : { Quantity(Age) },
|
ageRange | false | Range | # "ageRange" : { Range },
|
ageString | false | string | # "ageString" : "<string>",
|
bornDate | false | date | # "bornDate" : "<date>",
|
bornPeriod | false | Period | # "bornPeriod" : { Period },
|
bornString | false | string | # "bornString" : "<string>",
|
condition | true | Data Type | # Condition that the related person had
|
date | false | dateTime | # When history was captured/updated
|
deceasedBoolean | false | boolean | # "deceasedBoolean" : <boolean>,
|
deceasedDate | false | date | # "deceasedDate" : "<date>",
|
deceasedQuantity | false | Quantity | # "deceasedQuantity" : { Quantity(Age) },
|
deceasedRange | false | Range | # "deceasedRange" : { Range },
|
deceasedString | false | string | # "deceasedString" : "<string>",
|
gender | false | code | # male | female | other | unknown
|
identifier | true | Identifier | # External Id(s) for this record
|
name | false | string | # The family member described
|
note | false | Annotation | # General note about related person
|
patient | false | Reference | # Patient history is about
|
relationship | false | CodeableConcept | # Relationship to the subject
|
status | false | code | # partial | completed | entered-in-error | health-unknown
|
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 |