FamilyMemberHistory - FHIR Resource (dstu2)


Resource Attributes

AttributeField is listTypeDescription
ageQuantityfalseQuantity "ageQuantity" : { Quantity(Age) },
ageRangefalseRange "ageRange" : { Range },
ageStringfalsestring "ageString" : "<string>",
bornDatefalsedate "bornDate" : "<date>",
bornPeriodfalsePeriod "bornPeriod" : { Period },
bornStringfalsestring "bornString" : "<string>",
conditiontrueData Type Condition that the related person had
datefalsedateTime When history was captured/updated
deceasedBooleanfalseboolean "deceasedBoolean" : <boolean>,
deceasedDatefalsedate "deceasedDate" : "<date>",
deceasedQuantityfalseQuantity "deceasedQuantity" : { Quantity(Age) },
deceasedRangefalseRange "deceasedRange" : { Range },
deceasedStringfalsestring "deceasedString" : "<string>",
genderfalsecode male | female | other | unknown
identifiertrueIdentifier External Id(s) for this record
namefalsestring The family member described
notefalseAnnotation General note about related person
patientfalseReference Patient history is about
relationshipfalseCodeableConcept Relationship to the subject
statusfalsecode 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 the like so:

https://api.1up.health/fhir/dstu2/FamilyMemberHistory?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcondition.code
datedatedate
gendertextgender
identifiertextidentifier
patientreferencepatient
relationshiptextrelationship