QI-Core Implementation Guide
4.1.1 - STU 4.1.1 US

This page is part of the Quality Improvement Core Framework (v4.1.1: STU 4) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: QICoreFamilyMemberHistory

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-familymemberhistory Version: 4.1.1
Draft as of 2018-08-22 Computable Name: QICoreFamilyMemberHistory

Profile of Family Member History for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

Examples

Father Died of Heart Attack Example

Usage:

Formal Views of Profile Content

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

This structure is derived from FamilyMemberHistory

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... patient S1..1Reference(QICorePatient)Patient history is about
... date S0..1dateTimeWhen history was recorded or last updated
... relationship S1..1CodeableConceptRelationship to the subject
... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
... condition 0..*BackboneElementCondition that the related person had
.... familymemberhistory-abatement 0..1date, Age, booleanWhen (or if) the family member's condition resolved
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity 0..1CodeableConceptThe seriousness of the family member condition
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/DiagnosisSeverity (example): A subjective assessment of the severity of the condition as evaluated by the clinician.

.... code S1..1CodeableConceptCondition suffered by relation
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient SΣ1..1Reference(QICorePatient)Patient history is about
... date SΣ0..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] SΣI0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣI0..1booleanAge is estimated?
... deceased[x] SΣ0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... familymemberhistory-abatement 0..1date, Age, booleanWhen (or if) the family member's condition resolved
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity 0..1CodeableConceptThe seriousness of the family member condition
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/DiagnosisSeverity (example): A subjective assessment of the severity of the condition as evaluated by the clinician.


.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... patient Σ1..1Reference(QICorePatient)Patient history is about
... date Σ0..1dateTimeWhen history was recorded or last updated
... relationship Σ1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... deceased[x] Σ0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... condition 0..*BackboneElementCondition that the related person had
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.


doco Documentation for this format

This structure is derived from FamilyMemberHistory

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... patient S1..1Reference(QICorePatient)Patient history is about
... date S0..1dateTimeWhen history was recorded or last updated
... relationship S1..1CodeableConceptRelationship to the subject
... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
... condition 0..*BackboneElementCondition that the related person had
.... familymemberhistory-abatement 0..1date, Age, booleanWhen (or if) the family member's condition resolved
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity 0..1CodeableConceptThe seriousness of the family member condition
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/DiagnosisSeverity (example): A subjective assessment of the severity of the condition as evaluated by the clinician.

.... code S1..1CodeableConceptCondition suffered by relation
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryInformation about patient's relatives, relevant for patient
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient SΣ1..1Reference(QICorePatient)Patient history is about
... date SΣ0..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... age[x] SΣI0..1(approximate) age
.... ageAgeAge
.... ageRangeRange
.... ageStringstring
... estimatedAge ΣI0..1booleanAge is estimated?
... deceased[x] SΣ0..1Dead? How old/when?
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceasedRangeRange
.... deceasedDatedate
.... deceasedStringstring
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... familymemberhistory-abatement 0..1date, Age, booleanWhen (or if) the family member's condition resolved
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity 0..1CodeableConceptThe seriousness of the family member condition
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/DiagnosisSeverity (example): A subjective assessment of the severity of the condition as evaluated by the clinician.


.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
FamilyMemberHistory.languagepreferredCommonLanguages
Max Binding: AllLanguages
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshipexampleFamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

Constraints

IdGradePathDetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()
ele-1errorFamilyMemberHistory.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.sexAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.born[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.estimatedAgeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.extension:condition-abatementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.extension:condition-abatementMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.extension:condition-severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.extension:condition-severityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.outcomeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.contributedToDeathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())