EHI Export Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Family Member History

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from FamilyMemberHistory

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory		0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
patient	Σ	1..1	Reference(Patient)	Patient history is about
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.relationship	example	FamilyMember

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	FamilyMemberHistory	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	FamilyMemberHistory	If 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-4	error	FamilyMemberHistory	If 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-5	error	FamilyMemberHistory	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	FamilyMemberHistory	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both : age.empty() or born.empty()
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty()

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
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	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	0..1	dateTime	When history was recorded or last updated
name	Σ	0..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
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?
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedBoolean			boolean
deceasedAge			Age
deceasedRange			Range
deceasedDate			date
deceasedString			string
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
condition		0..*	BackboneElement	Condition that the related person had
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
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		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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason
FamilyMemberHistory.relationship	example	FamilyMember
FamilyMemberHistory.sex	extensible	AdministrativeGender
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings
FamilyMemberHistory.condition.code	example	Condition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	FamilyMemberHistory	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	FamilyMemberHistory	If 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-4	error	FamilyMemberHistory	If 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-5	error	FamilyMemberHistory	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	FamilyMemberHistory	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both : age.empty() or born.empty()
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistory

Summary

Differential View

This structure is derived from FamilyMemberHistory

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory		0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
patient	Σ	1..1	Reference(Patient)	Patient history is about
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.relationship	example	FamilyMember

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	FamilyMemberHistory	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	FamilyMemberHistory	If 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-4	error	FamilyMemberHistory	If 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-5	error	FamilyMemberHistory	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	FamilyMemberHistory	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both : age.empty() or born.empty()
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
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	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	0..1	dateTime	When history was recorded or last updated
name	Σ	0..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.
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?
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedBoolean			boolean
deceasedAge			Age
deceasedRange			Range
deceasedDate			date
deceasedString			string
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
condition		0..*	BackboneElement	Condition that the related person had
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
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		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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason
FamilyMemberHistory.relationship	example	FamilyMember
FamilyMemberHistory.sex	extensible	AdministrativeGender
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings
FamilyMemberHistory.condition.code	example	Condition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	FamilyMemberHistory	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	FamilyMemberHistory	If 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-4	error	FamilyMemberHistory	If 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-5	error	FamilyMemberHistory	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	FamilyMemberHistory	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both : age.empty() or born.empty()
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistory

Summary

Other representations of profile: CSV, Excel, Schematron