FHIR Artifacts > Structure Definition: FamilyMemberHistory Profile
Structure Definition: FamilyMemberHistory Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-FamilyMemberHistory
Simplifier project page: FamilyMemberHistory
Derived from: FamilyMemberHistory (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
FamilyMemberHistory | I | FamilyMemberHistory | There are no (further) constraints on this element Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | S Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | CodingFixed Value | Element idFamilyMemberHistory.dataAbsentReason.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://hl7.org/fhir/ValueSet/history-absent-reason", "code": "unable-to-obtain", "display": "Unable To Obtain" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
patient | Σ I | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This should be captured even if the same as the date on the List aggregating the full family history.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | Σ | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.relationship Relationship to the subject DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between the patient and the related person being described in the family member history.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | S Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | S Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.note General note about related person DefinitionThis 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. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Condition suffered by relation DefinitionThe 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither 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. Age of onset of a condition in relatives is predictive of risk for the patient.
| ||
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Hybrid View
FamilyMemberHistory | I | FamilyMemberHistory | There are no (further) constraints on this element Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | S Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | CodingFixed Value | Element idFamilyMemberHistory.dataAbsentReason.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://hl7.org/fhir/ValueSet/history-absent-reason", "code": "unable-to-obtain", "display": "Unable To Obtain" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
patient | Σ I | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This should be captured even if the same as the date on the List aggregating the full family history.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | Σ | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.relationship Relationship to the subject DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between the patient and the related person being described in the family member history.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | S Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | S Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.note General note about related person DefinitionThis 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. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Condition suffered by relation DefinitionThe 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither 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. Age of onset of a condition in relatives is predictive of risk for the patient.
| ||
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Snapshot View
FamilyMemberHistory | I | FamilyMemberHistory | There are no (further) constraints on this element Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | S Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | CodingFixed Value | Element idFamilyMemberHistory.dataAbsentReason.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://hl7.org/fhir/ValueSet/history-absent-reason", "code": "unable-to-obtain", "display": "Unable To Obtain" }
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
patient | Σ I | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This should be captured even if the same as the date on the List aggregating the full family history.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | Σ | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.relationship Relationship to the subject DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between the patient and the related person being described in the family member history.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | S Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | S Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.note General note about related person DefinitionThis 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. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
code | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Condition suffered by relation DefinitionThe 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither 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. Age of onset of a condition in relatives is predictive of risk for the patient.
| ||
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
Table View
FamilyMemberHistory | .. | |
FamilyMemberHistory.dataAbsentReason | .. | |
FamilyMemberHistory.dataAbsentReason.coding | 1..1 | |
FamilyMemberHistory.relationship | .. | |
FamilyMemberHistory.age[x] | .. | |
FamilyMemberHistory.estimatedAge | .. | |
FamilyMemberHistory.note | .. | |
FamilyMemberHistory.condition | .. |
JSON View
{ "resourceType": "StructureDefinition", "id": "ca-on-eReferral-profile-FamilyMemberHistory", "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-FamilyMemberHistory", "name": "FamilyMemberHistory", "title": "FamilyMemberHistory", "status": "draft", "description": "FamilyMemberHistory is one of the event resources in the FHIR workflow specification.\n\nThis resource records significant health conditions for a particular individual related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "FamilyMemberHistory", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory", "derivation": "constraint", "differential": { "element": [ { "id": "FamilyMemberHistory.dataAbsentReason", "path": "FamilyMemberHistory.dataAbsentReason", "mustSupport": true }, { "id": "FamilyMemberHistory.dataAbsentReason.coding", "path": "FamilyMemberHistory.dataAbsentReason.coding", "min": 1, "max": "1", "fixedCoding": { "system": "http://hl7.org/fhir/ValueSet/history-absent-reason", "code": "unable-to-obtain", "display": "Unable To Obtain" } }, { "id": "FamilyMemberHistory.relationship", "path": "FamilyMemberHistory.relationship", "binding": { "strength": "extensible" } }, { "id": "FamilyMemberHistory.age[x]", "path": "FamilyMemberHistory.age[x]", "mustSupport": true }, { "id": "FamilyMemberHistory.estimatedAge", "path": "FamilyMemberHistory.estimatedAge", "mustSupport": true }, { "id": "FamilyMemberHistory.note", "path": "FamilyMemberHistory.note", "mustSupport": false }, { "id": "FamilyMemberHistory.condition", "path": "FamilyMemberHistory.condition", "mustSupport": true } ] } }
Usage
FamilyMemberHistory is one of the event resources in the FHIR workflow specification.
This resource records significant health conditions for a particular individual related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle.
Notes
A minimally populated FamilyMemberHistory resource could include: .status
, .patient
, .relationship
, and .condition.text
.dataAbsentReason
- used to indicate why that family member's history is not available and is fixed to "unable-to-obtain"
.age
- this is the (approximate) age of the family member
- if
.age
is populated,.estimatedAge
SHALL be populated
.estimatedAge
- this is an indication as to whether
.age.
is estimated - SHALL only be populated if
.age
is populated
.condition.text
- can be used to capture textual information about the family member's condition if coded condition information is not available