This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Patient
Care
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/familymemberhistory-genetic
Adds additional information to a family member history supporting both the capture of mother/father relationships as well as additional observations necessary to enable genetics-based risk analysis for patients
This
profile
was
published
on
Sat,
Feb
21,
2015
00:00+1100
00:00+0800
as
a
draft
by
Health
Level
Seven,
Inc.
-
FHIR
WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from FamilyMemberHistory .
Summary
Must-Support: 12 elements
Extensions
This structure refers to these extensions:
This indicates the differences between this profile and the base FamilyMemberHistory structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0..* | FamilyMemberHistory |
Information
about
patient's
relatives,
relevant
for
patient
|
|
|
Content/Rules for all slices | |||
![]() ![]() ![]() | S | 0 .. * | (Complex) |
Mother(s)
&
Father(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent |
|
S | 0 .. * | (Complex) |
natural
brother(s)
&
natural
sister(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling |
|
S | 0 .. * | Reference ( Observation ) |
Genetic
markers,
ethnicity,
etc.
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation |
|
S | 1 .. 1 | CodeableConcept | Relationship to the subject |
|
S | 0 .. 1 | CodeableConcept | male | female | other | unknown |
|
S | 0 .. 1 | Period , date , string | (approximate) date of birth |
|
S | 0 .. 1 | Age , Range , string | (approximate) age |
|
S | 0 .. 1 | boolean , Age , Range , date , string | Dead? How old/when? |
|
S | 0 .. * | BackboneElement | Condition that the related person had |
|
S | 1 .. 1 | CodeableConcept |
|
|
S | 0 .. 1 | CodeableConcept | deceased | permanent disability | etc |
|
S | 0 .. 1 | Age , Range , Period , string | When condition first manifested |
|
0 .. * | Annotation | Extra information about condition | |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base FamilyMemberHistory structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
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 fhs-3: Can have age[x] or deceased[x], but not both |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | (Complex) |
Mother(s)
&
Father(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent |
||||
|
S | 0..* | (Complex) |
natural
brother(s)
&
natural
sister(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling |
||||
|
S | 0..* | Reference ( Observation ) |
Genetic
markers,
ethnicity,
etc.
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 0..* | Identifier |
External
Id(s)
for
this
record
|
||||
|
Σ | 0..* | canonical ( PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition ) |
Instantiates
FHIR
protocol
or
definition
|
||||
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
||||
|
?! Σ | 1..1 | code |
partial
|
completed
|
entered-in-error
|
health-unknown
Binding: Family History Status ( required ): A code that identifies the status of the family history record. |
||||
|
Σ | 0..1 | CodeableConcept |
subject-unknown
|
withheld
|
unable-to-obtain
|
deferred
Binding: Family History Absent Reason ( example ): Codes describing the reason why a family member's history is not available. |
||||
|
Σ | 1..1 | Reference ( Patient ) | Patient history is about | ||||
|
Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
|
Σ | 0..* | BackboneElement |
Who
or
what
participated
in
the
activities
related
to
the
family
member
history
and
how
they
were
involved
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 0..1 | CodeableConcept |
Type
of
involvement
Binding: Participation Role Type ( extensible ) |
||||
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam ) | Who or what participated in the activities related to the family member history | ||||
|
Σ | 0..1 | string | The family member described | ||||
|
S Σ | 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.
|
||||
|
S Σ | 0..1 | CodeableConcept |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( extensible ): Codes describing the sex assigned at birth as documented on the birth registration. |
||||
|
S
C
|
0..1 | (approximate) date of birth | |||||
|
Period | |||||||
|
date | |||||||
|
string | |||||||
|
S
Σ
C
|
0..1 | (approximate) age | |||||
|
Age | |||||||
|
Range | |||||||
|
string | |||||||
|
Σ
C
|
0..1 | boolean | Age is estimated? | ||||
|
S
Σ
C
|
0..1 | Dead? How old/when? | |||||
|
boolean | |||||||
|
Age | |||||||
|
Range | |||||||
|
date | |||||||
|
string | |||||||
|
Σ | 0..* | CodeableReference ( Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference ) |
Why
was
family
member
history
performed?
Binding: SNOMED CT Clinical Findings ( example ): Codes indicating why the family member history was done. |
||||
|
0..* | Annotation |
General
note
about
related
person
|
|||||
|
S | 0..* | BackboneElement |
Condition
that
the
related
person
had
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
S | 1..1 | CodeableConcept |
Binding: Condition/Problem/Diagnosis Codes ( example ): Identification of the Condition or diagnosis. |
||||
|
S | 0..1 | CodeableConcept |
deceased
|
permanent
disability
|
etc
Binding: Condition Outcome Codes ( example ): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. |
||||
|
0..1 | boolean | Whether the condition contributed to the cause of death | |||||
|
S | 0..1 | When condition first manifested | |||||
|
Age | |||||||
|
Range | |||||||
|
Period | |||||||
|
string | |||||||
|
0..* | Annotation |
Extra
information
about
condition
|
|||||
|
0..* | BackboneElement |
Procedures
that
the
related
person
had
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | CodeableConcept |
Procedures
performed
on
the
related
person
Binding: Procedure Codes (SNOMED CT) ( example ): A code to identify a specific procedure. |
|||||
|
0..1 | CodeableConcept |
What
happened
following
the
procedure
Binding: SNOMED CT Clinical Findings ( example ): The result of the procedure; e.g. death, permanent disability, temporary disability, etc. |
|||||
|
0..1 | boolean | Whether the procedure contributed to the cause of death | |||||
|
0..1 | When the procedure was performed | ||||||
|
Age | |||||||
|
Range | |||||||
|
Period | |||||||
|
string | |||||||
|
dateTime | |||||||
|
0..* | Annotation |
Extra
information
about
the
procedure
|
|||||
|
||||||||
<!-- FamilyMemberHistoryForGeneticsAnalysis --><FamilyMemberHistory xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- I 0..* Identifier External Id(s) for this record --></identifier> <instantiatesCanonical value="[canonical]"/><!-- I 0..* Instantiates FHIR protocol or definition --> <instantiatesUri value="[uri]"/><!-- I 0..* Instantiates external protocol or definition --> <status value="[code]"/><!-- I 1..1 partial | completed | entered-in-error | health-unknown --> <dataAbsentReason><!-- I 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred --></dataAbsentReason> <patient><!-- I 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- I 0..1 When history was recorded or last updated --> <participant> I 0..* BackboneElement <!-- I 0..* Who or what participated in the activities related to the family member history and how they were involved --><<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <function><!-- I 0..1 CodeableConcept Type of involvement --></function> <actor><!-- I 1..1 Reference(Practitioner) Who or what participated in the activities related to the family member history --></actor> </participant> <name value="[string]"/><!-- I 0..1 The family member described --><</relationship><relationship><!-- I 1..1 CodeableConcept Relationship to the subject--></relationship> <sex><!-- I 0..1 CodeableConcept male | female | other | unknown --></sex> <born[x]><!-- I 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- I 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- I 0..1 Age is estimated? --> <deceased[x]><!-- I 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <reason><!-- I 0..* CodeableReference Why was family member history performed? --></reason> <note><!-- I 0..* Annotation General note about related person --></note> <condition> I 0..* BackboneElement <!-- I 0..* Condition that the related person had -->
<<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Condition, allergy, or intolerance suffered by relation --></code> <outcome><!-- I 0..1 CodeableConcept deceased | permanent disability | etc --></outcome> <contributedToDeath value="[boolean]"/><!-- I 0..1 Whether the condition contributed to the cause of death --> <onset[x]><!-- I 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- I 0..* Annotation Extra information about condition --></note> </condition> <procedure> I 0..* BackboneElement <!-- I 0..* Procedures that the related person had --><<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.procedure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Procedures performed on the related person --></code> <outcome><!-- I 0..1 CodeableConcept What happened following the procedure --></outcome> <contributedToDeath value="[boolean]"/><!-- I 0..1 Whether the procedure contributed to the cause of death --> <performed[x]><!-- I 0..1 Age|Range|Period|string| dateTime When the procedure was performed --></performed[x]> <note><!-- I 0..* Annotation Extra information about the procedure --></note> </procedure> </FamilyMemberHistory>
{ // FamilyMemberHistoryForGeneticsAnalysis
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // Mother(s) & Father(s) - genetic & other // I
// from Element: extension
},
{ // natural brother(s) & natural sister(s) - genetic & other // I
// from Element: extension
},
{ // Genetic markers, ethnicity, etc. // I
// from Element: extension
}
],
"<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"identifier" : [{ Identifier }], // IExternal Id(s) for this record
"instantiatesCanonical" : ["<canonical>"], // IInstantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // IInstantiates external protocol or definition
"status" : "<code>", // I R! partial | completed | entered-in-error | health-unknown
"dataAbsentReason" : { CodeableConcept }, // Isubject-unknown | withheld | unable-to-obtain | deferred
"patient" : { Reference(Patient) }, // I R! Patient history is about
"date" : "<dateTime>", // IWhen history was recorded or last updated
"participant" : [{ BackboneElement }], // IWho or what participated in the activities related to the family member history and how they were involved
"name" : "<string>", // IThe family member described
"
"relationship" : { CodeableConcept }, // I R! Relationship to the subject
"sex" : { CodeableConcept }, // Imale | female | other | unknown
// value[x]: (approximate) date of birth. One of these 3:
"bornPeriod" : { Period }, // I(approximate) date of birth
"bornDate" : "<date>", // I(approximate) date of birth
"bornString" : "<string>", // I(approximate) date of birth
// value[x]: (approximate) age. One of these 3:
"ageAge" : { Age }, // I(approximate) age
"ageRange" : { Range }, // I(approximate) age
"ageString" : "<string>", // I(approximate) age
"estimatedAge" : <boolean>, // IAge is estimated?
// value[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>, // IDead? How old/when?
"deceasedAge" : { Age }, // IDead? How old/when?
"deceasedRange" : { Range }, // IDead? How old/when?
"deceasedDate" : "<date>", // IDead? How old/when?
"deceasedString" : "<string>", // IDead? How old/when?
"reason" : [{ CodeableReference(Condition) }], // IWhy was family member history performed?
"note" : [{ Annotation }], // IGeneral note about related person
"condition" : [{ BackboneElement }], // ICondition that the related person had
"procedure" : [{ BackboneElement }], // IProcedures that the related person had
}
This structure is derived from FamilyMemberHistory .
Differential View
This indicates the differences between this profile and the base FamilyMemberHistory structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0..* | FamilyMemberHistory |
Information
about
patient's
relatives,
relevant
for
patient
|
|
|
Content/Rules for all slices | |||
![]() ![]() ![]() | S | 0 .. * | (Complex) |
Mother(s)
&
Father(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent |
|
S | 0 .. * | (Complex) |
natural
brother(s)
&
natural
sister(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling |
|
S | 0 .. * | Reference ( Observation ) |
Genetic
markers,
ethnicity,
etc.
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation |
|
S | 1 .. 1 | CodeableConcept | Relationship to the subject |
|
S | 0 .. 1 | CodeableConcept | male | female | other | unknown |
|
S | 0 .. 1 | Period , date , string | (approximate) date of birth |
|
S | 0 .. 1 | Age , Range , string | (approximate) age |
|
S | 0 .. 1 | boolean , Age , Range , date , string | Dead? How old/when? |
|
S | 0 .. * | BackboneElement | Condition that the related person had |
|
S | 1 .. 1 | CodeableConcept |
|
|
S | 0 .. 1 | CodeableConcept | deceased | permanent disability | etc |
|
S | 0 .. 1 | Age , Range , Period , string | When condition first manifested |
|
0 .. * | Annotation | Extra information about condition | |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base FamilyMemberHistory structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
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 fhs-3: Can have age[x] or deceased[x], but not both |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | (Complex) |
Mother(s)
&
Father(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent |
||||
|
S | 0..* | (Complex) |
natural
brother(s)
&
natural
sister(s)
-
genetic
&
other
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling |
||||
|
S | 0..* | Reference ( Observation ) |
Genetic
markers,
ethnicity,
etc.
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 0..* | Identifier |
External
Id(s)
for
this
record
|
||||
|
Σ | 0..* | canonical ( PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition ) |
Instantiates
FHIR
protocol
or
definition
|
||||
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
||||
|
?! Σ | 1..1 | code |
partial
|
completed
|
entered-in-error
|
health-unknown
Binding: Family History Status ( required ): A code that identifies the status of the family history record. |
||||
|
Σ | 0..1 | CodeableConcept |
subject-unknown
|
withheld
|
unable-to-obtain
|
deferred
Binding: Family History Absent Reason ( example ): Codes describing the reason why a family member's history is not available. |
||||
|
Σ | 1..1 | Reference ( Patient ) | Patient history is about | ||||
|
Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
|
Σ | 0..* | BackboneElement |
Who
or
what
participated
in
the
activities
related
to
the
family
member
history
and
how
they
were
involved
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 0..1 | CodeableConcept |
Type
of
involvement
Binding: Participation Role Type ( extensible ) |
||||
|
Σ | 1..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam ) | Who or what participated in the activities related to the family member history | ||||
|
Σ | 0..1 | string | The family member described | ||||
|
S Σ | 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.
|
||||
|
S Σ | 0..1 | CodeableConcept |
male
|
female
|
other
|
unknown
Binding: AdministrativeGender ( extensible ): Codes describing the sex assigned at birth as documented on the birth registration. |
||||
|
S
C
|
0..1 | (approximate) date of birth | |||||
|
Period | |||||||
|
date | |||||||
|
string | |||||||
|
S
Σ
C
|
0..1 | (approximate) age | |||||
|
Age | |||||||
|
Range | |||||||
|
string | |||||||
|
Σ
C
|
0..1 | boolean | Age is estimated? | ||||
|
S
Σ
C
|
0..1 | Dead? How old/when? | |||||
|
boolean | |||||||
|
Age | |||||||
|
Range | |||||||
|
date | |||||||
|
string | |||||||
|
Σ | 0..* | CodeableReference ( Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference ) |
Why
was
family
member
history
performed?
Binding: SNOMED CT Clinical Findings ( example ): Codes indicating why the family member history was done. |
||||
|
0..* | Annotation |
General
note
about
related
person
|
|||||
|
S | 0..* | BackboneElement |
Condition
that
the
related
person
had
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
S | 1..1 | CodeableConcept |
Binding: Condition/Problem/Diagnosis Codes ( example ): Identification of the Condition or diagnosis. |
||||
|
S | 0..1 | CodeableConcept |
deceased
|
permanent
disability
|
etc
Binding: Condition Outcome Codes ( example ): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. |
||||
|
0..1 | boolean | Whether the condition contributed to the cause of death | |||||
|
S | 0..1 | When condition first manifested | |||||
|
Age | |||||||
|
Range | |||||||
|
Period | |||||||
|
string | |||||||
|
0..* | Annotation |
Extra
information
about
condition
|
|||||
|
0..* | BackboneElement |
Procedures
that
the
related
person
had
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | CodeableConcept |
Procedures
performed
on
the
related
person
Binding: Procedure Codes (SNOMED CT) ( example ): A code to identify a specific procedure. |
|||||
|
0..1 | CodeableConcept |
What
happened
following
the
procedure
Binding: SNOMED CT Clinical Findings ( example ): The result of the procedure; e.g. death, permanent disability, temporary disability, etc. |
|||||
|
0..1 | boolean | Whether the procedure contributed to the cause of death | |||||
|
0..1 | When the procedure was performed | ||||||
|
Age | |||||||
|
Range | |||||||
|
Period | |||||||
|
string | |||||||
|
dateTime | |||||||
|
0..* | Annotation |
Extra
information
about
the
procedure
|
|||||
|
||||||||
XML Template
<!-- FamilyMemberHistoryForGeneticsAnalysis --><FamilyMemberHistory xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- I 0..* Identifier External Id(s) for this record --></identifier> <instantiatesCanonical value="[canonical]"/><!-- I 0..* Instantiates FHIR protocol or definition --> <instantiatesUri value="[uri]"/><!-- I 0..* Instantiates external protocol or definition --> <status value="[code]"/><!-- I 1..1 partial | completed | entered-in-error | health-unknown --> <dataAbsentReason><!-- I 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred --></dataAbsentReason> <patient><!-- I 1..1 Reference(Patient) Patient history is about --></patient> <date value="[dateTime]"/><!-- I 0..1 When history was recorded or last updated --> <participant> I 0..* BackboneElement <!-- I 0..* Who or what participated in the activities related to the family member history and how they were involved --><<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <function><!-- I 0..1 CodeableConcept Type of involvement --></function> <actor><!-- I 1..1 Reference(Practitioner) Who or what participated in the activities related to the family member history --></actor> </participant> <name value="[string]"/><!-- I 0..1 The family member described --><</relationship><relationship><!-- I 1..1 CodeableConcept Relationship to the subject--></relationship> <sex><!-- I 0..1 CodeableConcept male | female | other | unknown --></sex> <born[x]><!-- I 0..1 Period|date|string (approximate) date of birth --></born[x]> <age[x]><!-- I 0..1 Age|Range|string (approximate) age --></age[x]> <estimatedAge value="[boolean]"/><!-- I 0..1 Age is estimated? --> <deceased[x]><!-- I 0..1 boolean|Age|Range|date|string Dead? How old/when? --></deceased[x]> <reason><!-- I 0..* CodeableReference Why was family member history performed? --></reason> <note><!-- I 0..* Annotation General note about related person --></note> <condition> I 0..* BackboneElement <!-- I 0..* Condition that the related person had -->
<<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Condition, allergy, or intolerance suffered by relation --></code> <outcome><!-- I 0..1 CodeableConcept deceased | permanent disability | etc --></outcome> <contributedToDeath value="[boolean]"/><!-- I 0..1 Whether the condition contributed to the cause of death --> <onset[x]><!-- I 0..1 Age|Range|Period|string When condition first manifested --></onset[x]> <note><!-- I 0..* Annotation Extra information about condition --></note> </condition> <procedure> I 0..* BackboneElement <!-- I 0..* Procedures that the related person had --><<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.procedure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 1..1 CodeableConcept Procedures performed on the related person --></code> <outcome><!-- I 0..1 CodeableConcept What happened following the procedure --></outcome> <contributedToDeath value="[boolean]"/><!-- I 0..1 Whether the procedure contributed to the cause of death --> <performed[x]><!-- I 0..1 Age|Range|Period|string| dateTime When the procedure was performed --></performed[x]> <note><!-- I 0..* Annotation Extra information about the procedure --></note> </procedure> </FamilyMemberHistory>
JSON Template
{ // FamilyMemberHistoryForGeneticsAnalysis
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // Mother(s) & Father(s) - genetic & other // I
// from Element: extension
},
{ // natural brother(s) & natural sister(s) - genetic & other // I
// from Element: extension
},
{ // Genetic markers, ethnicity, etc. // I
// from Element: extension
}
],
"<a href="familymemberhistory-genetic-definitions.html#FamilyMemberHistory.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"identifier" : [{ Identifier }], // IExternal Id(s) for this record
"instantiatesCanonical" : ["<canonical>"], // IInstantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // IInstantiates external protocol or definition
"status" : "<code>", // I R! partial | completed | entered-in-error | health-unknown
"dataAbsentReason" : { CodeableConcept }, // Isubject-unknown | withheld | unable-to-obtain | deferred
"patient" : { Reference(Patient) }, // I R! Patient history is about
"date" : "<dateTime>", // IWhen history was recorded or last updated
"participant" : [{ BackboneElement }], // IWho or what participated in the activities related to the family member history and how they were involved
"name" : "<string>", // IThe family member described
"
"relationship" : { CodeableConcept }, // I R! Relationship to the subject
"sex" : { CodeableConcept }, // Imale | female | other | unknown
// value[x]: (approximate) date of birth. One of these 3:
"bornPeriod" : { Period }, // I(approximate) date of birth
"bornDate" : "<date>", // I(approximate) date of birth
"bornString" : "<string>", // I(approximate) date of birth
// value[x]: (approximate) age. One of these 3:
"ageAge" : { Age }, // I(approximate) age
"ageRange" : { Range }, // I(approximate) age
"ageString" : "<string>", // I(approximate) age
"estimatedAge" : <boolean>, // IAge is estimated?
// value[x]: Dead? How old/when?. One of these 5:
"deceasedBoolean" : <boolean>, // IDead? How old/when?
"deceasedAge" : { Age }, // IDead? How old/when?
"deceasedRange" : { Range }, // IDead? How old/when?
"deceasedDate" : "<date>", // IDead? How old/when?
"deceasedString" : "<string>", // IDead? How old/when?
"reason" : [{ CodeableReference(Condition) }], // IWhy was family member history performed?
"note" : [{ Annotation }], // IGeneral note about related person
"condition" : [{ BackboneElement }], // ICondition that the related person had
"procedure" : [{ BackboneElement }], // IProcedures that the related person had
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| FamilyMemberHistory.language | All Languages | required | All Languages |
| FamilyMemberHistory.status | Family History Status | required | Family History Status |
| FamilyMemberHistory.dataAbsentReason | Family History Absent Reason | example | Family History Absent Reason |
| FamilyMemberHistory.participant.function | Participation Role Type | extensible | Participation Role Type |
| FamilyMemberHistory.relationship | FamilyMember | example |
FamilyMember
|
| FamilyMemberHistory.sex | AdministrativeGender | extensible | AdministrativeGender |
| FamilyMemberHistory.reason | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
| FamilyMemberHistory.condition.code | Condition/Problem/Diagnosis Codes | example | Condition/Problem/Diagnosis Codes |
| FamilyMemberHistory.condition.outcome | Condition Outcome Codes | example | Condition Outcome Codes |
| FamilyMemberHistory.procedure.code | Procedure Codes (SNOMED CT) | example | Procedure Codes (SNOMED CT) |
| FamilyMemberHistory.procedure.outcome | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |