MediRecords FHIR Implementation Guide
1.4.2 - release


Resource Profile: MR FamilyMemberHistory

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-family-member-history
Version:1.4.2
Name:MRFamilyMemberHistory
Title:MR FamilyMemberHistory
Status:Active as of 2025-04-04 01:10:23+0000
Definition:

MediRecords core FamilyMemberHistory profile to record active, inactive or terminal condition of a family member for the patient in context. This includes details on condition, relationship with the patient, status of the condition etc.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-family-member-history

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 1 element
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of FamilyMemberHistory.deceased[x]

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
inv-mr-fmh-condition-or-note-01: Either condition or note.text must be present
inv-mr-fmh-condition-code-text-coding: Either condition.code.text or condition.code.coding must be present
inv-mr-fmh-condition-active-or-contributed-to-death-1: 1 condition.contributedToDeath and condition.mr-fmh-condition-isactive-extn cannot be both present
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated S 0..1 instant When the resource version last changed
.... security S 0..* Coding Security Labels applied to this resource
... status SC 1..1 code partial | completed | entered-in-error | health-unknown
inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... patient S 1..1 Reference(MR Patient) Patient history is about
... relationship S 1..1 CodeableConcept Relationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... Slices for deceased[x] 0..1 boolean, Age, Range, date, string Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Dead? How old/when?
... note
.... text S 1..1 markdown The annotation - text content (as markdown)
Max Length:500
... condition 1..1 BackboneElement Condition that the related person had
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... isActive S 0..1 boolean Condition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Clinical Condition . (extensible)
..... coding 0..1 Coding Code defined by a terminology system
.... contributedToDeath S 0..1 boolean Whether the condition contributed to the cause of death

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
inv-mr-fmh-condition-or-note-01: Either condition or note.text must be present
inv-mr-fmh-condition-code-text-coding: Either condition.code.text or condition.code.coding must be present
inv-mr-fmh-condition-active-or-contributed-to-death-1: 1 condition.contributedToDeath and condition.mr-fmh-condition-isactive-extn cannot be both present
... id Σ 0..1 id Logical id of this artifact
... meta 0..1 MRMeta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Id(s) for this record
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!SΣC 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient SΣ 1..1 Reference(MR Patient) Patient history is about
... date Σ 0..1 dateTime When history was recorded or last updated
... name SΣ 0..1 string The family member described
... relationship SΣ 1..1 CodeableConcept Relationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean Dead? How old/when?
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
... note 0..* Annotation General note about related person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
Max Length:500
... condition 1..1 BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... isActive S 0..1 boolean Condition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Clinical Condition . (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... outcome 0..1 CodeableConcept deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath S 0..1 boolean Whether the condition contributed to the cause of death
.... onset[x] 0..1 When condition first manifested
..... onsetAge Age
..... onsetRange Range
..... onsetPeriod Period
..... onsetString string
.... note 0..* Annotation Extra information about condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... security ΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
... status ?!ΣC 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... patient Σ 1..1 Reference(MR Patient) Patient history is about
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... Slices for deceased[x] Content/Rules for all slices
.... deceased[x]:deceasedBoolean Σ 0..1 boolean Dead? How old/when?
... note 0..* Annotation General note about related person
.... text Σ 1..1 markdown The annotation - text content (as markdown)
Max Length:500
... condition 1..1 BackboneElement Condition that the related person had
.... Slices for extension Content/Rules for all slices
..... isActive 0..1 boolean Condition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Clinical Condition . (extensible)
.... contributedToDeath 0..1 boolean Whether the condition contributed to the cause of death

doco Documentation for this format

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 1 element
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of FamilyMemberHistory.deceased[x]

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
inv-mr-fmh-condition-or-note-01: Either condition or note.text must be present
inv-mr-fmh-condition-code-text-coding: Either condition.code.text or condition.code.coding must be present
inv-mr-fmh-condition-active-or-contributed-to-death-1: 1 condition.contributedToDeath and condition.mr-fmh-condition-isactive-extn cannot be both present
... meta 0..1 MRMeta Metadata about a resource
.... lastUpdated S 0..1 instant When the resource version last changed
.... security S 0..* Coding Security Labels applied to this resource
... status SC 1..1 code partial | completed | entered-in-error | health-unknown
inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... patient S 1..1 Reference(MR Patient) Patient history is about
... relationship S 1..1 CodeableConcept Relationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... Slices for deceased[x] 0..1 boolean, Age, Range, date, string Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Dead? How old/when?
... note
.... text S 1..1 markdown The annotation - text content (as markdown)
Max Length:500
... condition 1..1 BackboneElement Condition that the related person had
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... isActive S 0..1 boolean Condition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Clinical Condition . (extensible)
..... coding 0..1 Coding Code defined by a terminology system
.... contributedToDeath S 0..1 boolean Whether the condition contributed to the cause of death

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
inv-mr-fmh-condition-or-note-01: Either condition or note.text must be present
inv-mr-fmh-condition-code-text-coding: Either condition.code.text or condition.code.coding must be present
inv-mr-fmh-condition-active-or-contributed-to-death-1: 1 condition.contributedToDeath and condition.mr-fmh-condition-isactive-extn cannot be both present
... id Σ 0..1 id Logical id of this artifact
... meta 0..1 MRMeta Metadata about a resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-mr-meta-security-01: Medirecords supports only U, R security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Id(s) for this record
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!SΣC 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient SΣ 1..1 Reference(MR Patient) Patient history is about
... date Σ 0..1 dateTime When history was recorded or last updated
... name SΣ 0..1 string The family member described
... relationship SΣ 1..1 CodeableConcept Relationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean Dead? How old/when?
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
... note 0..* Annotation General note about related person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
Max Length:500
... condition 1..1 BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... isActive S 0..1 boolean Condition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Clinical Condition . (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... outcome 0..1 CodeableConcept deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath S 0..1 boolean Whether the condition contributed to the cause of death
.... onset[x] 0..1 When condition first manifested
..... onsetAge Age
..... onsetRange Range
..... onsetPeriod Period
..... onsetString string
.... note 0..* Annotation Extra information about condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
http://hl7.org/fhir/ValueSet/history-absent-reason
from the FHIR Standard
FamilyMemberHistory.relationshippreferredMRFamilyMemberRelationshipTypeValueSet
https://fhir.medirecords.com/ValueSet/mr-family-member-relationship-type-code
from this IG
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
FamilyMemberHistory.condition.codeextensibleClinicalCondition .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-condition-1
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()
inv-mr-fmh-condition-active-or-contributed-to-death-1errorFamilyMemberHistory1 condition.contributedToDeath and condition.mr-fmh-condition-isactive-extn cannot be both present
: (condition.extension('https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn').exists() implies condition.contributedToDeath.empty()) or (condition.contributedToDeath.exists() implies condition.extension('https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn').empty())
inv-mr-fmh-condition-code-text-codingerrorFamilyMemberHistoryEither condition.code.text or condition.code.coding must be present
: condition.code.text.exists() or condition.code.coding.exists()
inv-mr-fmh-condition-or-note-01errorFamilyMemberHistoryEither condition or note.text must be present
: condition.exists() or note.exists()
inv-mr-fmh-status-01errorFamilyMemberHistory.statusMedirecords only supports 'completed' or 'entered-in-error' status
: $this.exists() implies ($this = 'completed' or $this = 'entered-in-error')
inv-mr-meta-security-01errorFamilyMemberHistory.meta.securityMedirecords supports only U, R security code
: code.exists() implies (code = 'U' or code = 'R')