FamilyMemberHistory - FHIR Resource (r4)


This FamilyMemberHistory Resource uses the FHIR API standard for access and structure.

Validate an FamilyMemberHistory FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
age[x]falseAge|Range|string#undefined
born[x]falsePeriod|date|string#undefined
conditiontrueData Type# Condition that the related person had
dataAbsentReasonfalseCodeableConcept# subject-unknown | withheld | unable-to-obtain | deferred
datefalsedateTime# When history was recorded or last updated
deceased[x]falseboolean|Age|Range|date|string#undefined
estimatedAgefalseboolean# C? Age is estimated?
identifiertrueIdentifier# External Id(s) for this record
instantiatesCanonicaltruecanonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)# "instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|
instantiatesUritrueuri# Instantiates external protocol or definition
namefalsestring# The family member described
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
sexfalseCodeableConcept# male | female | other | unknown
statusfalsecode# partial | completed | entered-in-error | health-unknown

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 ParameterField TypeResource Fields Searched
codetextcondition.code
datedatedate
identifiertextidentifier
instantiates-canonicalreferenceinstantiatesCanonical
instantiates-uriuriinstantiatesUri
patientreferencepatient
relationshiptextrelationship
sextextsex
statustextstatus