QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
| Father Died of Heart Attack Example |
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 Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  FamilyMemberHistory | 0..* | FamilyMemberHistory | ||
  patient | S | 1..1 | Reference(QICorePatient) | |
 date | S | 0..1 | dateTime | |
| relationship | S | 1..1 | CodeableConcept | |
| age[x] | S | 0..1 | Age, Range, string | |
| deceased[x] | S | 0..1 | boolean, Age, Range, date, string | |
 condition | 0..* | BackboneElement | ||
  familymemberhistory-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
| familymemberhistory-severity | 0..1 | CodeableConcept | The seriousness of the family member condition URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity Binding: Condition/DiagnosisSeverity (example) | |
| code | S | 1..1 | CodeableConcept | |
| onset[x] | 0..1 | Age, Range, Period, string | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External Id(s) for this record |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| status | ?!ΣI | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
| dataAbsentReason | ΣI | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example) |
| patient | SΣI | 1..1 | Reference(QICorePatient) | Patient history is about |
| date | SΣI | 0..1 | dateTime | When history was recorded or last updated |
| name | ΣI | 0..1 | string | The family member described |
| relationship | SΣI | 1..1 | CodeableConcept | Relationship to the subject Binding: V3 Value SetFamilyMember (example) |
| sex | ΣI | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible) |
 born[x] | I | 0..1 | (approximate) date of birth | |
 bornPeriod | Period | |||
| bornDate | date | |||
| bornString | string | |||
| age[x] | SΣI | 0..1 | (approximate) age | |
| ageAge | Age | |||
| ageRange | Range | |||
| ageString | string | |||
| estimatedAge | ΣI | 0..1 | boolean | Age is estimated? |
| deceased[x] | SΣI | 0..1 | Dead? How old/when? | |
| deceasedBoolean | boolean | |||
| deceasedAge | Age | |||
| deceasedRange | Range | |||
| deceasedDate | date | |||
| deceasedString | string | |||
| reasonCode | ΣI | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
| note | I | 0..* | Annotation | General note about related person |
| condition | I | 0..* | BackboneElement | Condition that the related person had |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| familymemberhistory-abatement | I | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement |
| familymemberhistory-severity | I | 0..1 | CodeableConcept | The seriousness of the family member condition URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity Binding: Condition/DiagnosisSeverity (example) |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SI | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example) |
| outcome | I | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example) |
| contributedToDeath | I | 0..1 | boolean | Whether the condition contributed to the cause of death |
| onset[x] | I | 0..1 | When condition first manifested | |
| onsetAge | Age | |||
| onsetRange | Range | |||
| onsetPeriod | Period | |||
| onsetString | string | |||
| note | I | 0..* | Annotation | Extra information about condition |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | 0..* | FamilyMemberHistory | ||
| patient | S | 1..1 | Reference(QICorePatient) | |
| date | S | 0..1 | dateTime | |
| relationship | S | 1..1 | CodeableConcept | |
| age[x] | S | 0..1 | Age, Range, string | |
| deceased[x] | S | 0..1 | boolean, Age, Range, date, string | |
| condition | 0..* | BackboneElement | ||
| familymemberhistory-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
| familymemberhistory-severity | 0..1 | CodeableConcept | The seriousness of the family member condition URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity Binding: Condition/DiagnosisSeverity (example) | |
| code | S | 1..1 | CodeableConcept | |
| onset[x] | 0..1 | Age, Range, Period, string | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| FamilyMemberHistory | I | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External Id(s) for this record |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| status | ?!ΣI | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required) |
| dataAbsentReason | ΣI | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example) |
| patient | SΣI | 1..1 | Reference(QICorePatient) | Patient history is about |
| date | SΣI | 0..1 | dateTime | When history was recorded or last updated |
| name | ΣI | 0..1 | string | The family member described |
| relationship | SΣI | 1..1 | CodeableConcept | Relationship to the subject Binding: V3 Value SetFamilyMember (example) |
| sex | ΣI | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible) |
| born[x] | I | 0..1 | (approximate) date of birth | |
| bornPeriod | Period | |||
| bornDate | date | |||
| bornString | string | |||
| age[x] | SΣI | 0..1 | (approximate) age | |
| ageAge | Age | |||
| ageRange | Range | |||
| ageString | string | |||
| estimatedAge | ΣI | 0..1 | boolean | Age is estimated? |
| deceased[x] | SΣI | 0..1 | Dead? How old/when? | |
| deceasedBoolean | boolean | |||
| deceasedAge | Age | |||
| deceasedRange | Range | |||
| deceasedDate | date | |||
| deceasedString | string | |||
| reasonCode | ΣI | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? |
| note | I | 0..* | Annotation | General note about related person |
| condition | I | 0..* | BackboneElement | Condition that the related person had |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| familymemberhistory-abatement | I | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement |
| familymemberhistory-severity | I | 0..1 | CodeableConcept | The seriousness of the family member condition URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity Binding: Condition/DiagnosisSeverity (example) |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SI | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example) |
| outcome | I | 0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example) |
| contributedToDeath | I | 0..1 | boolean | Whether the condition contributed to the cause of death |
| onset[x] | I | 0..1 | When condition first manifested | |
| onsetAge | Age | |||
| onsetRange | Range | |||
| onsetPeriod | Period | |||
| onsetString | string | |||
| note | I | 0..* | Annotation | Extra information about condition |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| FamilyMemberHistory.language | preferred | CommonLanguages Max Binding: AllLanguages |
| FamilyMemberHistory.status | required | FamilyHistoryStatus |
| FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReason |
| FamilyMemberHistory.relationship | example | v3.FamilyMember |
| FamilyMemberHistory.sex | extensible | AdministrativeGender |
| FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindings |
| FamilyMemberHistory.condition.code | example | Condition/Problem/DiagnosisCodes |
| FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodes |
| Id | Path | Details | Requirements |
| dom-2 | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | FamilyMemberHistory | If 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-4 | FamilyMemberHistory | If 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-5 | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
| fhs-1 | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
| fhs-2 | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() | |
| ele-1 | FamilyMemberHistory.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.dataAbsentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.sex | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.born[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.age[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.estimatedAge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.extension:condition-abatement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.extension:condition-abatement | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.extension:condition-severity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.extension:condition-severity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | FamilyMemberHistory.condition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | FamilyMemberHistory.condition.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.outcome | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.contributedToDeath | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | FamilyMemberHistory.condition.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 