Onconova Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• JSON

Resource Profile: Cancer Family Member History Profile

A profile recording of a patient's family member's history of cancer.

This profile is based on the core FHIR FamilyMemberHistory resource rather than the mCODE HistoryOfMetastaticCancer profile to allow for a broader range of cancer history documentation (not limited to metastatic cancer). It includes constraints to ensure that at least one cancer condition is recorded, along with optional extensions for cancer morphology and topography.

Conformance:

FamilyMemberHistory resources representing a history of (primary or metastatic) cancer in a patient's family member in the scope of Onconova SHALL conform to this profile. Any resource intended to conform to this profile SHOULD populate meta.profile accordingly.

Usages:

• CapabilityStatements using this Profile: Onconova FHIR REST Server Capability Statement
• This Profile is not used by any profiles in this Implementation Guide

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, o-fam-req-1, o-fam-req-2, o-fam-req-3
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	OΣ	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	OΣ	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name	Σ	0..1	string	Not used in this profile
relationship	OΣ	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. Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex	Σ	0..1	CodeableConcept	Not used in this profile Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
born[x]	C	0..1		Not used in this profile
bornPeriod			Period
bornDate			date
bornString			string
age[x]	ΣC	0..1		Not used in this profile
ageAge			Age
ageRange			Range
ageString			string
estimatedAge	ΣC	0..1	boolean	Not used in this profile
deceased[x]	OΣ	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode	Σ	0..*	CodeableConcept	Not used in this profile Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
reasonReference	Σ	0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:All Slices				Content/Rules for all slices
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.
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
code	Σ	0..1	code	Coded form of the unit Required Pattern: a
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
FamilyMemberHistory.​status	Base	required	FamilyHistoryStatus	📍4.0.1	FHIR Std.
FamilyMemberHistory.​relationship	Base	example	FamilyMember	📦3.0.0	THO v7.1
FamilyMemberHistory.​sex	Base	extensible	AdministrativeGender	📍4.0.1	FHIR Std.
FamilyMemberHistory.​reasonCode	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​onset[x].comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.exists()

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: o-fam-req-1, o-fam-req-2, o-fam-req-3
patient	O	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	O	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name		0..1	string	Not used in this profile
relationship	O	1..1	CodeableConcept	Relationship to the subject Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex		0..1	CodeableConcept	Not used in this profile
born[x]		0..1	Period, date, string	Not used in this profile
age[x]		0..1	Age, Range, string	Not used in this profile
estimatedAge		0..1	boolean	Not used in this profile
deceased[x]	O	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode		0..*	CodeableConcept	Not used in this profile
reasonReference		0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
code		1..1	CodeableConcept	Condition suffered by relation Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
code		0..1	code	Coded form of the unit Required Pattern: a
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.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, o-fam-req-1, o-fam-req-2, o-fam-req-3
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 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	OΣ	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	OΣ	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name	Σ	0..1	string	Not used in this profile
relationship	OΣ	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. Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex	Σ	0..1	CodeableConcept	Not used in this profile Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
born[x]	C	0..1		Not used in this profile
bornPeriod			Period
bornDate			date
bornString			string
age[x]	ΣC	0..1		Not used in this profile
ageAge			Age
ageRange			Range
ageString			string
estimatedAge	ΣC	0..1	boolean	Not used in this profile
deceased[x]	OΣ	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode	Σ	0..*	CodeableConcept	Not used in this profile Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
reasonReference	Σ	0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
note		0..*	Annotation	General note about related person
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:All Slices				Content/Rules for all slices
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
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
userSelected		0..1	boolean	If this coding was chosen directly by the user
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		0..1	boolean	Whether the condition contributed to the cause of death
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	Σ	0..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	Σ	0..1	string	Unit representation
system	ΣC	0..1	uri	System that defines coded unit form
code	Σ	0..1	code	Coded form of the unit Required Pattern: a
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
FamilyMemberHistory.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
FamilyMemberHistory.​status	Base	required	FamilyHistoryStatus	📍4.0.1	FHIR Std.
FamilyMemberHistory.​dataAbsentReason	Base	example	FamilyHistoryAbsentReason	📍4.0.1	FHIR Std.
FamilyMemberHistory.​relationship	Base	example	FamilyMember	📦3.0.0	THO v7.1
FamilyMemberHistory.​sex	Base	extensible	AdministrativeGender	📍4.0.1	FHIR Std.
FamilyMemberHistory.​reasonCode	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.outcome	Base	example	Condition Outcome Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​outcome	Base	example	Condition Outcome Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​onset[x].comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.exists()

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• Cancer Patient Profile (http://onconova.github.io/fhir/StructureDefinition/onconova-cancer-patient)

Extensions

This structure refers to these extensions:

• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology
• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography
• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of FamilyMemberHistory.condition

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, o-fam-req-1, o-fam-req-2, o-fam-req-3
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	OΣ	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	OΣ	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name	Σ	0..1	string	Not used in this profile
relationship	OΣ	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. Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex	Σ	0..1	CodeableConcept	Not used in this profile Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
born[x]	C	0..1		Not used in this profile
bornPeriod			Period
bornDate			date
bornString			string
age[x]	ΣC	0..1		Not used in this profile
ageAge			Age
ageRange			Range
ageString			string
estimatedAge	ΣC	0..1	boolean	Not used in this profile
deceased[x]	OΣ	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode	Σ	0..*	CodeableConcept	Not used in this profile Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
reasonReference	Σ	0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:All Slices				Content/Rules for all slices
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.
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
code	Σ	0..1	code	Coded form of the unit Required Pattern: a
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
FamilyMemberHistory.​status	Base	required	FamilyHistoryStatus	📍4.0.1	FHIR Std.
FamilyMemberHistory.​relationship	Base	example	FamilyMember	📦3.0.0	THO v7.1
FamilyMemberHistory.​sex	Base	extensible	AdministrativeGender	📍4.0.1	FHIR Std.
FamilyMemberHistory.​reasonCode	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​onset[x].comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.exists()

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: o-fam-req-1, o-fam-req-2, o-fam-req-3
patient	O	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	O	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name		0..1	string	Not used in this profile
relationship	O	1..1	CodeableConcept	Relationship to the subject Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex		0..1	CodeableConcept	Not used in this profile
born[x]		0..1	Period, date, string	Not used in this profile
age[x]		0..1	Age, Range, string	Not used in this profile
estimatedAge		0..1	boolean	Not used in this profile
deceased[x]	O	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode		0..*	CodeableConcept	Not used in this profile
reasonReference		0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
code		1..1	CodeableConcept	Condition suffered by relation Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
code		0..1	code	Coded form of the unit Required Pattern: a
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.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, o-fam-req-1, o-fam-req-2, o-fam-req-3
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 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	OΣ	1..1	Reference(Cancer Patient Profile)	The patient whose family member is the subject of this history Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
date	OΣ	0..1	dateTime	When history was recorded or last updated Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
name	Σ	0..1	string	Not used in this profile
relationship	OΣ	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. Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
sex	Σ	0..1	CodeableConcept	Not used in this profile Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
born[x]	C	0..1		Not used in this profile
bornPeriod			Period
bornDate			date
bornString			string
age[x]	ΣC	0..1		Not used in this profile
ageAge			Age
ageRange			Range
ageString			string
estimatedAge	ΣC	0..1	boolean	Not used in this profile
deceased[x]	OΣ	0..1	boolean	Indicates whether the family member is deceased Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
reasonCode	Σ	0..*	CodeableConcept	Not used in this profile Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
reasonReference	Σ	0..*	Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Not used in this profile
note		0..*	Annotation	General note about related person
Slices for condition	S	1..*	BackboneElement	Condition that the related person had Slice: Unordered, Open by value:code
condition:All Slices				Content/Rules for all slices
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
condition:cancerCondition	SO	1..*	BackboneElement	Condition that the related person had Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:morphology	SO	0..1	CodeableConcept	Family Member History Cancer Morphology URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology Binding: ICD-O-3 Morphology Behavior Value Set (required) Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:topography	SO	0..1	CodeableConcept	Family Member History Cancer Topography URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography Binding: ICD-O-3 Topographies Value Set (required) Obligations Actor SHALL:populate Creator (Onconova) SHOULD:persist Consumer (Onconova)
extension:contributedToDeath	SO	0..1	boolean	Family Member History Condition Contributed to Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 363346000
display		1..1	string	Representation defined by the system Fixed Value: Malignant neoplastic disease (disorder)
userSelected		0..1	boolean	If this coding was chosen directly by the user
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		0..1	boolean	Whether the condition contributed to the cause of death
onset[x]	O	0..1	Age	When condition first manifested Obligations Actor SHALL:populate-if-known Creator (Onconova) SHOULD:persist Consumer (Onconova)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	Σ	0..1	decimal	Numerical value (with implicit precision)
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit	Σ	0..1	string	Unit representation
system	ΣC	0..1	uri	System that defines coded unit form
code	Σ	0..1	code	Coded form of the unit Required Pattern: a
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
FamilyMemberHistory.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
FamilyMemberHistory.​status	Base	required	FamilyHistoryStatus	📍4.0.1	FHIR Std.
FamilyMemberHistory.​dataAbsentReason	Base	example	FamilyHistoryAbsentReason	📍4.0.1	FHIR Std.
FamilyMemberHistory.​relationship	Base	example	FamilyMember	📦3.0.0	THO v7.1
FamilyMemberHistory.​sex	Base	extensible	AdministrativeGender	📍4.0.1	FHIR Std.
FamilyMemberHistory.​reasonCode	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition.outcome	Base	example	Condition Outcome Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​code	Base	example	Condition/Problem/Diagnosis Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​outcome	Base	example	Condition Outcome Codes	📍4.0.1	FHIR Std.
FamilyMemberHistory.​condition:cancerCondition.​onset[x].comparator	Base	required	QuantityComparator	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
o-fam-req-1	error	FamilyMemberHistory	The patient element is required and must be provided.	patient.exists()
o-fam-req-2	error	FamilyMemberHistory	The date element is required and must be provided.	date.exists() and date.hasValue()
o-fam-req-3	error	FamilyMemberHistory	The relationship element is required and must be provided.	relationship.exists() and relationship.coding.exists()

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• Cancer Patient Profile (http://onconova.github.io/fhir/StructureDefinition/onconova-cancer-patient)

Extensions

This structure refers to these extensions:

• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-morphology
• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-history-member-cancer-topography
• http://onconova.github.io/fhir/StructureDefinition/onconova-ext-family-member-condition-contributed-to-death

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of FamilyMemberHistory.condition

Other representations of profile: CSV, Excel, Schematron