FamilyMemberHistory | Medplum

Elements

Name Required Type Description
identifier Identifier[] External Id(s) for this record
Details
Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
instantiatesCanonical canonical[] Instantiates FHIR protocol or definition
Details
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri uri[] Instantiates external protocol or definition
Details
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
status ✓ code partial
dataAbsentReason CodeableConcept subject-unknown
patient ✓ Reference< Patient > Patient history is about
Details
The person who this history concerns.
date dateTime When history was recorded or last updated
Details
The date (and possibly time) when the family member history was recorded or last updated.
This should be captured even if the same as the date on the List aggregating the full family history.
name string The family member described
Details
This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
relationship ✓ CodeableConcept Relationship to the subject
Details
The type of relationship this person has to the patient (father, mother, brother etc.).
sex CodeableConcept male
born[x] Period, date, string (approximate) date of birth
Details
The actual or approximate date of birth of the relative.
age[x] Age, Range, string (approximate) age
Details
The age of the relative at the time the family member history is recorded.
use estimatedAge to indicate whether the age is actual or not.
estimatedAge boolean Age is estimated?
Details
If true, indicates that the age value specified is an estimated value.
This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.
deceased[x] boolean, Age, Range, date, string Dead? How old/when?
Details
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
reasonCode CodeableConcept[] Why was family member history performed?
Details
Describes why the family member history occurred in coded or textual form.
Textual reasons can be captured using reasonCode.text.
reasonReference Reference< Condition
Observation
note Annotation[] General note about related person
Details
This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
condition FamilyMemberHistoryCondition[] Condition that the related person had
Details
The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
id string Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension Extension[] Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension Extension[] Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
code ✓ CodeableConcept Condition suffered by relation
Details
The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.
outcome CodeableConcept deceased
contributedToDeath boolean Whether the condition contributed to the cause of death
Details
This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
onset[x] Age, Range, Period, string When condition first manifested
Details
Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
note Annotation[] Extra information about condition
Details
An area where general notes can be placed about this specific condition.

Search Parameters

Name Type Description Expression
code token A search by a condition code FamilyMemberHistory.condition.code
date date When history was recorded or last updated FamilyMemberHistory.date
identifier token A search by a record identifier FamilyMemberHistory.identifier
patient reference The identity of a subject to list family member history items for FamilyMemberHistory.patient
instantiates-canonical reference Instantiates FHIR protocol or definition FamilyMemberHistory.instantiatesCanonical
instantiates-uri uri Instantiates external protocol or definition FamilyMemberHistory.instantiatesUri
relationship token A search by a relationship type FamilyMemberHistory.relationship
sex token A search by a sex code of a family member FamilyMemberHistory.sex
status token partial completed

Inherited Elements

Name Required Type Description
id string Logical id of this artifact
Details
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta Meta Metadata about the resource
Details
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules uri A set of rules under which this content was created
Details
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
language code Language of the resource content
Details
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag).
text Narrative Text summary of the resource, for human interpretation
Details
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative.
contained Resource[] Contained, inline Resources
Details
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
extension Extension[] Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the resource.
modifierExtension Extension[] Extensions that cannot be ignored
Details
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. However, the governing set of rules applies to the definition and use of extensions.