MediRecords FHIR Implementation Guide
1.4.0 - release


Resource Profile: MR FamilyMemberHistory

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-family-member-history
Version:1.4.0
Name:MRFamilyMemberHistory
Title:MR FamilyMemberHistory
Status:Active as of 2024-06-28 01:25:00+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:

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation 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..1MRMetaMetadata about a resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... security S0..*CodingSecurity Labels applied to this resource
... status SC1..1codepartial | completed | entered-in-error | health-unknown
inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... patient S1..1Reference(MR Patient)Patient history is about
... relationship S1..1CodeableConceptRelationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... deceasedBoolean S0..1booleanDead? How old/when?
... note
.... text S1..1markdownThe annotation - text content (as markdown)
Max Length: 500
... condition 1..1BackboneElementCondition that the related person had
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... isActive S0..1booleanCondition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Clinical Condition . (extensible)
..... coding 0..1CodingCode defined by a terminology system
.... contributedToDeath S0..1booleanWhether the condition contributed to the cause of death

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation 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..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity 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..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!SΣC1..1codepartial | 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..1CodeableConceptsubject-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..1Reference(MR Patient)Patient history is about
... date Σ0..1dateTimeWhen history was recorded or last updated
... name SΣ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated?
... Slices for deceased[x] Σ0..1Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
.... deceased[x]:deceasedBoolean SΣ0..1booleanDead? How old/when?
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationGeneral note about related person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
Max Length: 500
... condition 1..1BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... isActive S0..1booleanCondition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Clinical Condition . (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath S0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... meta 0..1MRMetaMetadata about a resource
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... security ΣC0..*CodingSecurity 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 ?!ΣC1..1codepartial | 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..1Reference(MR Patient)Patient history is about
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... deceased[x]:deceasedBoolean Σ0..1booleanDead? How old/when?
... note 0..*AnnotationGeneral note about related person
.... text Σ1..1markdownThe annotation - text content (as markdown)
Max Length: 500
... condition 1..1BackboneElementCondition that the related person had
.... isActive 0..1booleanCondition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Clinical Condition . (extensible)
.... contributedToDeath 0..1booleanWhether 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:

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation 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..1MRMetaMetadata about a resource
.... lastUpdated S0..1instantWhen the resource version last changed
.... security S0..*CodingSecurity Labels applied to this resource
... status SC1..1codepartial | completed | entered-in-error | health-unknown
inv-mr-fmh-status-01: Medirecords only supports 'completed' or 'entered-in-error' status
... patient S1..1Reference(MR Patient)Patient history is about
... relationship S1..1CodeableConceptRelationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... deceasedBoolean S0..1booleanDead? How old/when?
... note
.... text S1..1markdownThe annotation - text content (as markdown)
Max Length: 500
... condition 1..1BackboneElementCondition that the related person had
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... isActive S0..1booleanCondition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Clinical Condition . (extensible)
..... coding 0..1CodingCode defined by a terminology system
.... contributedToDeath S0..1booleanWhether the condition contributed to the cause of death

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C0..*FamilyMemberHistoryInformation 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..1idLogical id of this artifact
... meta 0..1MRMetaMetadata about a resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣC0..*CodingSecurity 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..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!SΣC1..1codepartial | 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..1CodeableConceptsubject-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..1Reference(MR Patient)Patient history is about
... date Σ0..1dateTimeWhen history was recorded or last updated
... name SΣ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: MediRecords Family Member Relationship Type ValueSet (preferred)
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] ΣC0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣC0..1booleanAge is estimated?
... Slices for deceased[x] Σ0..1Dead? How old/when?
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
.... deceased[x]:deceasedBoolean SΣ0..1booleanDead? How old/when?
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationGeneral note about related person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
Max Length: 500
... condition 1..1BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... isActive S0..1booleanCondition Active status as mentioned for a Family Member Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-fmh-condition-isactive-extn
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Clinical Condition . (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath S0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra 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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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')