ONCOnnectTumorboardIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Family History Member (Profile)

Captures information about a family member's health history, including conditions and their relationship to the patient.

Usages:

• Refer to this Profile: Family History (Profile)
• Examples for this Profile: FamilyMemberHistory/ONCOnnect-EX-TB-FamilyHistoryMemberFather, FamilyMemberHistory/ONCOnnect-EX-TB-FamilyHistoryMemberGrandfather and FamilyMemberHistory/ONCOnnect-EX-TB-FamilyHistoryMemberMother

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2, family-history-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text		0..1	Narrative	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 (Profile))	Patient history is about
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (3.0.0) (preferred)
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
deceasedString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
FamilyMemberHistory.status	required	FamilyHistoryStatus http://hl7.org/fhir/ValueSet/history-status|4.0.1 From the FHIR Standard
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0

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()
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: family-history-1
text		0..1	Narrative	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way.
patient		1..1	Reference(Patient (Profile))	Patient history is about
relationship		1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (3.0.0) (preferred)
deceased[x]		0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
deceasedString			string
condition
onset[x]		0..1		When condition first manifested
onsetAge			Age
onsetRange			Range
onsetString			string
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0

Constraints

Id	Grade	Path(s)	Details	Requirements
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2, family-history-1
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	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 (Profile))	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 (3.0.0) (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?
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
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
onsetString			string
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
FamilyMemberHistory.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus http://hl7.org/fhir/ValueSet/history-status|4.0.1 From the FHIR Standard
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason http://hl7.org/fhir/ValueSet/history-absent-reason From the FHIR Standard
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0
FamilyMemberHistory.sex	extensible	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
FamilyMemberHistory.condition.code	example	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes http://hl7.org/fhir/ValueSet/condition-outcome From the FHIR Standard

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()
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.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

Structures

This structure refers to these other structures:

• Patient (Profile) (https://fhir.ccc-onconnect.de/StructureDefinition/onconnect-pr-tb-patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2, family-history-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text		0..1	Narrative	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 (Profile))	Patient history is about
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (3.0.0) (preferred)
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
deceasedString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
FamilyMemberHistory.status	required	FamilyHistoryStatus http://hl7.org/fhir/ValueSet/history-status|4.0.1 From the FHIR Standard
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0

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()
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.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()

Differential View

This structure is derived from FamilyMemberHistory

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: family-history-1
text		0..1	Narrative	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way.
patient		1..1	Reference(Patient (Profile))	Patient history is about
relationship		1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (3.0.0) (preferred)
deceased[x]		0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
deceasedString			string
condition
onset[x]		0..1		When condition first manifested
onsetAge			Age
onsetRange			Range
onsetString			string
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0

Constraints

Id	Grade	Path(s)	Details	Requirements
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient Constraints: fhs-1, fhs-2, family-history-1
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	Use the text property in case it's not possible or requires significant effort to track the family history in a structured way. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 (Profile))	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 (3.0.0) (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?
deceased[x]	Σ	0..1		Dead? How old/when?
deceasedAge			Age
deceasedRange			Range
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
onsetString			string
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
FamilyMemberHistory.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus http://hl7.org/fhir/ValueSet/history-status|4.0.1 From the FHIR Standard
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason http://hl7.org/fhir/ValueSet/history-absent-reason From the FHIR Standard
FamilyMemberHistory.relationship	preferred	FamilyMember http://terminology.hl7.org/ValueSet/v3-FamilyMember|3.0.0
FamilyMemberHistory.sex	extensible	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
FamilyMemberHistory.condition.code	example	Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes http://hl7.org/fhir/ValueSet/condition-outcome From the FHIR Standard

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()
family-history-1	error	FamilyMemberHistory	If any condition has contributedToDeath as true, then deceased[x] must also be present. : condition.where(contributedToDeath = true).exists() implies deceased.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

Structures

This structure refers to these other structures:

• Patient (Profile) (https://fhir.ccc-onconnect.de/StructureDefinition/onconnect-pr-tb-patient)

Other representations of profile: CSV, Excel, Schematron