Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

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

Resource Profile: FamilyMemberHistory

Usage:

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

Formal Views of Profile Content

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

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

This structure is derived from FamilyMemberHistory

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	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
date		1..1	dateTime	When history was recorded or last updated
name		1..1	string	The family member described
relationship		1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex		1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]		0..1	date	(approximate) date of birth
age[x]		0..1	Age	(approximate) age
deceased[x]		0..1	date	Dead? How old/when?
condition		1..*	BackboneElement	Condition that the related person had
code		1..1	CodeableConcept	Condition suffered by relation Binding: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
onset[x]		1..1	Range	When condition first manifested
low		1..1	SimpleQuantity	Low limit
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both :
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present :

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
patient	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	1..1	dateTime	When history was recorded or last updated
name	Σ	1..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex	Σ	1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]	C	0..1	date	(approximate) date of birth
age[x]	ΣC	0..1	Age	(approximate) age
deceased[x]	Σ	0..1	date	Dead? How old/when?
condition		1..*	BackboneElement	Condition that the related person had
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Condition suffered by relation Binding: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
onset[x]		1..1	Range	When condition first manifested
low	Σ	1..1	SimpleQuantity	Low limit
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Id(s) for this record
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
patient	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	1..1	dateTime	When history was recorded or last updated
name	Σ	1..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex	Σ	1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]	C	0..1	date	(approximate) date of birth
age[x]	ΣC	0..1	Age	(approximate) age
estimatedAge	ΣC	0..1	boolean	Age is estimated?
deceased[x]	Σ	0..1	date	Dead? How old/when?
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		1..*	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: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
contributedToDeath		0..1	boolean	Whether the condition contributed to the cause of death
onset[x]		1..1	Range	When condition first manifested
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
low	Σ	1..1	SimpleQuantity	Low limit
high	Σ	0..1	SimpleQuantity	High limit
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	FamilyMemberHistory.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 6 elements

Differential View

This structure is derived from FamilyMemberHistory

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
date		1..1	dateTime	When history was recorded or last updated
name		1..1	string	The family member described
relationship		1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex		1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]		0..1	date	(approximate) date of birth
age[x]		0..1	Age	(approximate) age
deceased[x]		0..1	date	Dead? How old/when?
condition		1..*	BackboneElement	Condition that the related person had
code		1..1	CodeableConcept	Condition suffered by relation Binding: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
onset[x]		1..1	Range	When condition first manifested
low		1..1	SimpleQuantity	Low limit
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
fhs-1	error	FamilyMemberHistory	Can have age[x] or born[x], but not both :
fhs-2	error	FamilyMemberHistory	Can only have estimatedAge if age[x] is present :

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
patient	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	1..1	dateTime	When history was recorded or last updated
name	Σ	1..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex	Σ	1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]	C	0..1	date	(approximate) date of birth
age[x]	ΣC	0..1	Age	(approximate) age
deceased[x]	Σ	0..1	date	Dead? How old/when?
condition		1..*	BackboneElement	Condition that the related person had
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	CodeableConcept	Condition suffered by relation Binding: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
onset[x]		1..1	Range	When condition first manifested
low	Σ	1..1	SimpleQuantity	Low limit
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
FamilyMemberHistory	C	0..*	FamilyMemberHistory	Information about patient's relatives, relevant for patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Id(s) for this record
instantiatesCanonical	Σ	0..*	canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
status	?!Σ	1..1	code	partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
dataAbsentReason	Σ	0..1	CodeableConcept	subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
patient	Σ	1..1	Reference(Patient)	Patient history is about
date	Σ	1..1	dateTime	When history was recorded or last updated
name	Σ	1..1	string	The family member described
relationship	Σ	1..1	CodeableConcept	Relationship to the subject Binding: FamilyMember (required)
sex	Σ	1..1	CodeableConcept	male | female | other | unknown Binding: AdministrativeGender (required)
born[x]	C	0..1	date	(approximate) date of birth
age[x]	ΣC	0..1	Age	(approximate) age
estimatedAge	ΣC	0..1	boolean	Age is estimated?
deceased[x]	Σ	0..1	date	Dead? How old/when?
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		1..*	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: BRCID10 (required)
outcome		0..1	CodeableConcept	deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (required)
contributedToDeath		0..1	boolean	Whether the condition contributed to the cause of death
onset[x]		1..1	Range	When condition first manifested
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
low	Σ	1..1	SimpleQuantity	Low limit
high	Σ	0..1	SimpleQuantity	High limit
note		0..*	Annotation	Extra information about condition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
FamilyMemberHistory.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
FamilyMemberHistory.status	required	FamilyHistoryStatus
FamilyMemberHistory.dataAbsentReason	example	FamilyHistoryAbsentReason
FamilyMemberHistory.relationship	required	FamilyMember
FamilyMemberHistory.sex	required	AdministrativeGender
FamilyMemberHistory.reasonCode	example	SNOMEDCTClinicalFindings
FamilyMemberHistory.condition.code	required	BRCID10 (a valid code from Classificação Internacional de Doenças - Décima Revisão - CID-10)
FamilyMemberHistory.condition.outcome	required	ConditionOutcomeCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-r4b	warning	FamilyMemberHistory.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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()

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 6 elements

Other representations of profile: CSV, Excel, Schematron