FamilyMemberHistory - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
ageAgefalseAge "ageAge" : { 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
deceasedAgefalseAge "deceasedAge" : { Age },
deceasedBooleanfalseboolean "deceasedBoolean" : <boolean>,
deceasedDatefalsedate "deceasedDate" : "<date>",
deceasedRangefalseRange "deceasedRange" : { Range },
deceasedStringfalsestring "deceasedString" : "<string>",
definitiontrueReference Instantiates protocol or definition
estimatedAgefalseboolean C? Age is estimated?
genderfalsecode male | female | other | unknown
identifiertrueIdentifier External Id(s) for this record
namefalsestring The family member described
notDonefalseboolean The taking of a family member's history did not occur
notDoneReasonfalseCodeableConcept C? subject-unknown | withheld | unable-to-obtain | deferred
notetrueAnnotation General note about related person
patientfalseReference Patient history is about
reasonCodetrueCodeableConcept Why was family member history performed?
reasonReferencetrueReference "reasonReference" : [{ Reference(Condition|Observation|AllergyIntolerance|
relationshipfalseCodeableConcept Relationship to the subject
statusfalsecode partial | completed | entered-in-error | health-unknown

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 the like so:

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