Qi-Core Implementation Guide (Release 2.1 Trial-Use Ballot)

This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-familymemberhistory

Examples:

Father Died of Heart Attack Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-familymemberhistory

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

This profile builds on FamilyMemberHistory.

This profile was published on Mon Aug 21 00:00:00 AEST 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, and Snapshots.

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*Information about patient's relatives, relevant for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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
... definition Σ0..*Reference(PlanDefinition), Reference(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... notDone ?!Σ0..1booleanThe taking of a family member's history did not occur
... notDoneReason ΣI0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryNotDoneReason (example)
... patient SΣ1..1Reference(QICore-Patient)Patient history is about
... date SΣ0..1dateTimeWhen history was captured/updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... born[x] I0..1Period, date, string(approximate) date of birth
... age[x] SΣI0..1Age, Range, string(approximate) age
... estimatedAge ?!ΣI0..1booleanAge is estimated?
... deceased[x] SΣ0..1boolean, Age, Range, date, stringDead? How old/when?
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation), Reference(AllergyIntolerance), Reference(QuestionnaireResponse)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition I0..*BackboneElementCondition that the related person had
.... id 0..1stringxml:id (or equivalent in JSON)
.... familymemberhistory-abatement I0..1date, Age, booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/Diagnosis Severity (example)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Problem Value Set (preferred)
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: Condition Outcome Codes (example)
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*Information about patient's relatives, relevant for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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
... definition Σ0..*Reference(PlanDefinition), Reference(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... notDone ?!Σ0..1booleanThe taking of a family member's history did not occur
... notDoneReason ΣI0..1CodeableConceptsubject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryNotDoneReason (example)
... patient SΣ1..1Reference(QICore-Patient)Patient history is about
... date SΣ0..1dateTimeWhen history was captured/updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... born[x] I0..1Period, date, string(approximate) date of birth
... age[x] SΣI0..1Age, Range, string(approximate) age
... estimatedAge ?!ΣI0..1booleanAge is estimated?
... deceased[x] SΣ0..1boolean, Age, Range, date, stringDead? How old/when?
... reasonCode Σ0..*CodeableConceptWhy was family member history performed?
Binding: SNOMED CT Clinical Findings (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation), Reference(AllergyIntolerance), Reference(QuestionnaireResponse)Why was family member history performed?
... note 0..*AnnotationGeneral note about related person
... condition I0..*BackboneElementCondition that the related person had
.... id 0..1stringxml:id (or equivalent in JSON)
.... familymemberhistory-abatement I0..1date, Age, booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
.... familymemberhistory-severity I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/Diagnosis Severity (example)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Problem Value Set (preferred)
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: Condition Outcome Codes (example)
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
FamilyMemberHistory.languageCommon LanguagesextensibleCommon Languages
FamilyMemberHistory.statusFamilyHistoryStatusrequiredFamilyHistoryStatus
FamilyMemberHistory.notDoneReasonFamilyHistoryNotDoneReasonexampleFamilyHistoryNotDoneReason
FamilyMemberHistory.relationshipFamilyMemberexampleFamilyMember
FamilyMemberHistory.genderAdministrativeGenderrequiredAdministrativeGender
FamilyMemberHistory.reasonCodeSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings
FamilyMemberHistory.condition.codeProblem Value SetpreferredProblem Value Set
FamilyMemberHistory.condition.outcomeCondition Outcome CodesexampleCondition Outcome Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2FamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1FamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4FamilyMemberHistoryIf 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-3FamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
fhs-2FamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()
fhs-3FamilyMemberHistoryNot Done Reason can only be specified if NotDone is "true"
: notDone or notDoneReason.exists().not()
fhs-1FamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
ele-1FamilyMemberHistory.conditionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()