FHIR Core Implementation Guide (CO) - 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: Profile: Family Member History CO

FHIR FamilyMemberHistory Core profile, defined by HL7 CO.

Record information about the relevant health history of members of the patient’s blood or related family. [ES: Registrar información sobre los antecedentes de salud relevantes de los miembros de la familia consanguínea o afín del paciente.]

Usage:

• Examples for this Resource Profile: Mercedez Jaramillo and Alberto Mora

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
meta
profile		0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/FamilyMemberHistoryCO
status	S	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason		0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	S	1..1	Reference(Profile: Patient CO)	Patient history is about
relationship	S	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/FamilyMember
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
sex		0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/administrative-gender
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
reasonCode		0..*	CodeableConcept	Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example)
reasonReference		0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Why was family member history performed?
condition
code		1..1	CodeableConcept	Condition suffered by relation Binding: http://terminology.fhir.guide/co/ValueSet/ICD10Codes (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
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	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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	required	http://terminology.fhir.guide/co/ValueSet/ICD10Codes http://terminology.fhir.guide/co/ValueSet/ICD10Codes
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes http://hl7.org/fhir/ValueSet/condition-outcome from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	SΣ	1..1	Reference(Profile: Patient CO)	Patient history is about
relationship	SΣ	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
sex	Σ	0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
reasonCode	Σ	0..*	CodeableConcept	Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example)
reasonReference	Σ	0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Why was family member history performed?
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.dataAbsentReason	example	FamilyHistoryAbsentReason http://hl7.org/fhir/ValueSet/history-absent-reason from the FHIR Standard
FamilyMemberHistory.relationship	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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

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 fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/FamilyMemberHistoryCO
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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	?!SΣ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	SΣ	1..1	Reference(Profile: Patient CO)	Patient history is about
date	Σ	0..1	dateTime	When history was recorded or last updated
name	Σ	0..1	string	The family member described
relationship	SΣ	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/FamilyMember
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
sex	Σ	0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/administrative-gender
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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)
reasonReference	Σ	0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | 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: http://terminology.fhir.guide/co/ValueSet/ICD10Codes (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example)
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	URI
FamilyMemberHistory.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
FamilyMemberHistory.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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	required	http://terminology.fhir.guide/co/ValueSet/ICD10Codes http://terminology.fhir.guide/co/ValueSet/ICD10Codes
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()
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

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)
• Profile: Condition CO (http://co.fhir.guide/core/StructureDefinition/ConditionCO)
• Profile: Allergy or Intolerance CO (http://co.fhir.guide/core/StructureDefinition/AllergyIntoleranceCO)

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
meta
profile		0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/FamilyMemberHistoryCO
status	S	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason		0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	S	1..1	Reference(Profile: Patient CO)	Patient history is about
relationship	S	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/FamilyMember
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
sex		0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
coding
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/administrative-gender
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
reasonCode		0..*	CodeableConcept	Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example)
reasonReference		0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Why was family member history performed?
condition
code		1..1	CodeableConcept	Condition suffered by relation Binding: http://terminology.fhir.guide/co/ValueSet/ICD10Codes (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
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	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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	required	http://terminology.fhir.guide/co/ValueSet/ICD10Codes http://terminology.fhir.guide/co/ValueSet/ICD10Codes
FamilyMemberHistory.condition.outcome	example	ConditionOutcomeCodes http://hl7.org/fhir/ValueSet/condition-outcome from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	SΣ	1..1	Reference(Profile: Patient CO)	Patient history is about
relationship	SΣ	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
sex	Σ	0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
reasonCode	Σ	0..*	CodeableConcept	Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example)
reasonReference	Σ	0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | QuestionnaireResponse | DiagnosticReport | DocumentReference)	Why was family member history performed?
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.dataAbsentReason	example	FamilyHistoryAbsentReason http://hl7.org/fhir/ValueSet/history-absent-reason from the FHIR Standard
FamilyMemberHistory.relationship	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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

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 fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/FamilyMemberHistoryCO
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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	?!SΣ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required)
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example)
patient	SΣ	1..1	Reference(Profile: Patient CO)	Patient history is about
date	Σ	0..1	dateTime	When history was recorded or last updated
name	Σ	0..1	string	The family member described
relationship	SΣ	1..1	CodeableConcept	Relationship to the subject Binding: http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.fhir.guide/co/CodeSystem/FamilyMember
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
sex	Σ	0..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/administrative-gender
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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)
reasonReference	Σ	0..*	Reference(Profile: Condition CO | Observation | Profile: Allergy or Intolerance CO | 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: http://terminology.fhir.guide/co/ValueSet/ICD10Codes (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example)
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	URI
FamilyMemberHistory.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
FamilyMemberHistory.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	required	http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes http://terminology.fhir.guide/co/ValueSet/FamilyMemberCodes
FamilyMemberHistory.sex	required	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	required	http://terminology.fhir.guide/co/ValueSet/ICD10Codes http://terminology.fhir.guide/co/ValueSet/ICD10Codes
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()
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

Mandatory: 0 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)
• Profile: Condition CO (http://co.fhir.guide/core/StructureDefinition/ConditionCO)
• Profile: Allergy or Intolerance CO (http://co.fhir.guide/core/StructureDefinition/AllergyIntoleranceCO)

Other representations of profile: CSV, Excel, Schematron