Log in Request access

FamilyMemberHistory

Health events in the patient's family history.

Patient-context only: patient/FamilyMemberHistory.rs returns the family history entries recorded on the launched patient's chart.

Advertises a validated CA Core+ profile.

Access

Mode Interactions Scopes
App launch read + search patient/FamilyMemberHistory.rs
Backend services

Search parameters

Search results are searchset Bundles; follow the Bundle's next link for cursor pagination.

Parameter Type Description
_id token Match a specific logical resource id.
_lastUpdated date Filter by last modification time; supports FHIR date prefixes such as ge and lt.
_count number Page size hint for the searchset Bundle.
_page_token string Opaque pagination cursor. Never construct one — follow the Bundle's next link.
patient reference Family history entries for a specific Patient.
status token partial, completed, entered-in-error, or health-unknown.

Read a family history entry

GET /FamilyMemberHistory/{id} 200 OK
Request
curl "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/FamilyMemberHistory/synthetic-familyhistory-1" \
  -H "Authorization: Bearer $SMART_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"
Response · launch context
{
  "resourceType": "FamilyMemberHistory",
  "id": "synthetic-familyhistory-1",
  "meta": {
    "profile": ["http://fhir.infoway-inforoute.ca/io/CA-Core/StructureDefinition/familymemberhistory-ca-core|1.1.0"]
  },
  "status": "completed",
  "patient": { "reference": "Patient/synthetic-patient-1" },
  "relationship": { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "MTH", "display": "mother" }] },
  "condition": [
    { "code": { "coding": [{ "system": "http://snomed.info/sct", "code": "38341003", "display": "Hypertension" }] } }
  ]
}