FamilyMemberHistory
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/FamilyMemberHistory/[id] |
| Vread | GET | /fhir/R4/FamilyMemberHistory/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/FamilyMemberHistory/[id] |
| Patch | PATCH | /fhir/R4/FamilyMemberHistory/[id] |
| Delete | DELETE | /fhir/R4/FamilyMemberHistory/[id] |
| Create | POST | /fhir/R4/FamilyMemberHistory |
| Search | GET | /fhir/R4/FamilyMemberHistory |
| History | GET | /fhir/R4/FamilyMemberHistory/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | External Id(s) for this record |
instantiatesCanonical | canonical | 0..* | Instantiates FHIR protocol or definition |
instantiatesUri | uri | 0..* | Instantiates external protocol or definition |
status | code | 1..1 | partial | completed | entered-in-error | health-unknown |
dataAbsentReason | CodeableConcept | 0..1 | subject-unknown | withheld | unable-to-obtain | deferred |
patient | Reference | 1..1 | Patient history is about |
date | dateTime | 0..1 | When history was recorded or last updated |
name | string | 0..1 | The family member described |
relationship | CodeableConcept | 1..1 | Relationship to the subject |
sex | CodeableConcept | 0..1 | male | female | other | unknown |
born[x] | Period, date, string | 0..1 | (approximate) date of birth |
age[x] | Age, Range, string | 0..1 | (approximate) age |
estimatedAge | boolean | 0..1 | Age is estimated? |
deceased[x] | boolean, Age, Range, date, string | 0..1 | Dead? How old/when? |
reasonCode | CodeableConcept | 0..* | Why was family member history performed? |
reasonReference | Reference | 0..* | Why was family member history performed? |
note | Annotation | 0..* | General note about related person |
condition | BackboneElement | 0..* | Condition that the related person had |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
code | token | Multiple Resources: AllergyIntolerance: Code that identifies the allergy or intolerance ; Condition: Code for the condition ; DeviceRequest: Code for what is being requested/ordered ; DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result ; FamilyMemberHistory: A search by a condition code ; List: What the purpose of this list is ; Medication: Returns medications for a specific code ; MedicationAdministration: Return administrations of this medication code ; MedicationDispense: Returns dispenses of this medicine code ; MedicationRequest: Return prescriptions of this medication code ; MedicationStatement: Return statements of this medication code ; Observation: The code of the observation type ; Procedure: A code to identify a procedure ; ServiceRequest: What is being requested/ordered |
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
instantiates-canonical | reference | Instantiates FHIR protocol or definition |
instantiates-uri | uri | Instantiates external protocol or definition |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
relationship | token | A search by a relationship type |
sex | token | A search by a sex code of a family member |
status | token | partial | completed | entered-in-error | health-unknown |
Reference
Official FHIR R4 spec: FamilyMemberHistory.
Maturity: Trial Use 2 (FMM 2).