This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Todo
Definitions for the family-history-genetics-geneticpedigreefamilyhistory Profile.
FamilyHistory(GeneticPedigreeFamilyHistory) | |
Definition | Significant health events and conditions for people related to the subject relevant in the context of care for the subject. |
Control | 1..1 |
Requirements | |
Comments | |
FamilyHistory.id | |
Definition | The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Requirements | |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
FamilyHistory.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Requirements | |
Comments | |
FamilyHistory.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Requirements | |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
FamilyHistory.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Requirements | |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
FamilyHistory.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Requirements | |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
FamilyHistory.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Requirements | |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
FamilyHistory.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.modifierExtension | |
Definition | 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.identifier | |
Definition | This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
Control | 0..* |
Type | Identifier |
Requirements | Need to allow connection to a wider workflow. |
Comments | |
FamilyHistory.patient | |
Definition | The person who this history concerns. |
Control | 1..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient)) |
Requirements | |
Alternate Names | Proband |
Comments | |
FamilyHistory.date | |
Definition | The date (and possibly time) when the family history was taken. |
Control | 0..1 |
Type | dateTime |
Requirements | Allows determination of how current the summary is. |
Comments | |
FamilyHistory.note | |
Definition | Conveys information about family history not specific to individual relations. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | |
FamilyHistory.relation | |
Definition | The related person. Each FamilyHistory resource contains the entire family history for a single person. |
Control | 1..* |
Must Support | true |
Requirements | |
Comments | |
Invariants | Defined on this element fhs-1: Can have age[x] or birth[x], but not both (xpath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])) |
FamilyHistory.relation.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
FamilyHistory.relation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
FamilyHistory.relation.extension (http://hl7.org/fhir/ExtensionDefinition/genetics-relationParent) | |
Definition | Identifies a parent of the relative. |
Control | 0..* |
Requirements | |
Comments | Some individuals may have more than two parents (e.g. genetic vs. adoptive parents). Even non-genetic relationships can be relevant in terms of genetic exposure. |
FamilyHistory.relation.extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
FamilyHistory.relation.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
FamilyHistory.relation.extension.extension(Parent.type) | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.relation.extension.extension(Parent.identifier) | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.relation.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Requirements | |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #. |
FamilyHistory.relation.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | * |
Requirements | |
Comments | |
FamilyHistory.relation.extension (http://hl7.org/fhir/ExtensionDefinition/genetics-relationObservation) | |
Definition | Allows capturing risk-relevant observations about the relative that aren't themselves a specific health condition. E.g. Certain ethnic ancestries that are disease-relevant, presence of particular genetic markers, etc. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Observation)) |
Requirements | |
Comments | This may be extended with additional genomics-specific resources when they are ready. |
FamilyHistory.relation.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.relation.name | |
Definition | This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair". |
Control | 0..1 |
Type | string |
Requirements | Allows greater ease in ensuring the same person is being talked about. |
Comments | |
FamilyHistory.relation.relationship | |
Definition | The type of relationship this person has to the patient (father, mother, brother etc.). |
Control | 1..1 |
Binding | The nature of the relationship between the patient and the related person being described in the family history The codes SHOULD be taken from FamilyMember; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Comments | |
FamilyHistory.relation.born[x] | |
Definition | The actual or approximate date of birth of the relative. |
Control | 0..1 This element is affected by the following invariants: fhs-1 |
Type | Choice of: Period, date, string |
Must Support | true |
Requirements | Allows calculation of the relative's age. |
Comments | |
FamilyHistory.relation.age[x] | |
Definition | The actual or approximate age of the relative at the time the family history is recorded. |
Control | 0..1 This element is affected by the following invariants: fhs-1 |
Type | Choice of: Age, Range, string |
Requirements | While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians. |
Comments | |
FamilyHistory.relation.deceased[x] | |
Definition | If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set. |
Control | 0..1 |
Type | Choice of: boolean, Age, Range, string |
Must Support | true |
Requirements | |
Comments | |
FamilyHistory.relation.note | |
Definition | This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | |
FamilyHistory.relation.condition | |
Definition | The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. |
Control | 0..* |
Must Support | true |
Requirements | |
Comments | |
FamilyHistory.relation.condition.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
FamilyHistory.relation.condition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.relation.condition.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
FamilyHistory.relation.condition.type | |
Definition | The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. |
Control | 1..1 |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Comments | |
FamilyHistory.relation.condition.outcome | |
Definition | Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation. |
Control | 0..1 |
Binding | The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc. |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Comments | |
FamilyHistory.relation.condition.onset[x] | |
Definition | Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. |
Control | 0..1 |
Type | Choice of: Age, Range, string |
Must Support | true |
Requirements | Age of onset of a condition in relatives is predictive of risk for the patient. |
Comments | |
FamilyHistory.relation.condition.note | |
Definition | An area where general notes can be placed about this specific condition. |
Control | 0..1 |
Type | string |
Requirements | |
Comments |