QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-familymemberhistory | Version: 7.0.0 | |||
Active 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.
See the patterns page for implementation and usage patterns.
Father Died of Heart Attack Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | (QI) When history was recorded or last updated ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | (QI) (approximate) age ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Σ | 0..1 | (QI) Dead? How old/when? ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
0..1 | When condition first manifested ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() |
Path | Conformance | ValueSet | URI |
FamilyMemberHistory.status | required | FamilyHistoryStatushttp://hl7.org/fhir/ValueSet/history-status|4.0.1 from the FHIR Standard | |
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | |
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
FamilyMemberHistory | |||
![]() ![]() ![]() |
1..1 | Reference(QICore Patient) | (QI) Patient history is about | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When history was recorded or last updated | |
![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | |
![]() ![]() ![]() |
0..1 | Age, Range, string | (QI) (approximate) age | |
![]() ![]() ![]() |
0..1 | boolean, Age, Range, date, string | (QI) Dead? How old/when? | |
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
![]() ![]() ![]() ![]() |
0..1 | Age, Range, Period, string | When condition first manifested | |
![]() |
Path | Conformance | ValueSet | URI |
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | |
FamilyMemberHistory.condition.extension:condition-severity [CanonicalType[http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity]] | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Id(s) for this record | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | (QI) When history was recorded or last updated | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The family member described | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
![]() ![]() ![]() |
C | 0..1 | (approximate) date of birth | |||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | (QI) (approximate) age | |||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | boolean | Age is estimated? | ||||
![]() ![]() ![]() |
Σ | 0..1 | (QI) Dead? How old/when? | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? | ||||
![]() ![]() ![]() |
0..* | Annotation | General note about related person | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the condition contributed to the cause of death | |||||
![]() ![]() ![]() ![]() |
0..1 | When condition first manifested | ||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Extra information about condition | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
FamilyMemberHistory.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
FamilyMemberHistory.status | required | FamilyHistoryStatushttp://hl7.org/fhir/ValueSet/history-status|4.0.1 from the FHIR Standard | ||||
FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReasonhttp://hl7.org/fhir/ValueSet/history-absent-reason from the FHIR Standard | ||||
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | ||||
FamilyMemberHistory.sex | extensible | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | ||||
FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodeshttp://hl7.org/fhir/ValueSet/condition-outcome from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
This structure is derived from FamilyMemberHistory
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | (QI) When history was recorded or last updated ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | (QI) (approximate) age ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Σ | 0..1 | (QI) Dead? How old/when? ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
date | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
0..1 | When condition first manifested ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() |
Path | Conformance | ValueSet | URI |
FamilyMemberHistory.status | required | FamilyHistoryStatushttp://hl7.org/fhir/ValueSet/history-status|4.0.1 from the FHIR Standard | |
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | |
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
Differential View
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
FamilyMemberHistory | |||
![]() ![]() ![]() |
1..1 | Reference(QICore Patient) | (QI) Patient history is about | |
![]() ![]() ![]() |
0..1 | dateTime | (QI) When history was recorded or last updated | |
![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | |
![]() ![]() ![]() |
0..1 | Age, Range, string | (QI) (approximate) age | |
![]() ![]() ![]() |
0..1 | boolean, Age, Range, date, string | (QI) Dead? How old/when? | |
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
![]() ![]() ![]() ![]() |
0..1 | Age, Range, Period, string | When condition first manifested | |
![]() |
Path | Conformance | ValueSet | URI |
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | |
FamilyMemberHistory.condition.extension:condition-severity [CanonicalType[http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity]] | preferred | Condition/DiagnosisSeverityhttp://hl7.org/fhir/ValueSet/condition-severity from the FHIR Standard | |
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | FamilyMemberHistory | Information about patient's relatives, relevant for patient fhs-1: Can have age[x] or born[x], but not both fhs-2: Can only have estimatedAge if age[x] is present | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Id(s) for this record | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | (QI) When history was recorded or last updated | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The family member described | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
![]() ![]() ![]() |
C | 0..1 | (approximate) date of birth | |||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | (QI) (approximate) age | |||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
ΣC | 0..1 | boolean | Age is estimated? | ||||
![]() ![]() ![]() |
Σ | 0..1 | (QI) Dead? How old/when? | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why was family member history performed? Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? | ||||
![]() ![]() ![]() |
0..* | Annotation | General note about related person | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Condition that the related person had | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The 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. | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | deceased | permanent disability | etc. Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the condition contributed to the cause of death | |||||
![]() ![]() ![]() ![]() |
0..1 | When condition first manifested | ||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Extra information about condition | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
FamilyMemberHistory.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
FamilyMemberHistory.status | required | FamilyHistoryStatushttp://hl7.org/fhir/ValueSet/history-status|4.0.1 from the FHIR Standard | ||||
FamilyMemberHistory.dataAbsentReason | example | FamilyHistoryAbsentReasonhttp://hl7.org/fhir/ValueSet/history-absent-reason from the FHIR Standard | ||||
FamilyMemberHistory.relationship | preferred | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember | ||||
FamilyMemberHistory.sex | extensible | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | ||||
FamilyMemberHistory.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
FamilyMemberHistory.condition.code | extensible | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
FamilyMemberHistory.condition.outcome | example | ConditionOutcomeCodeshttp://hl7.org/fhir/ValueSet/condition-outcome from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | FamilyMemberHistory | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | FamilyMemberHistory | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | FamilyMemberHistory | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
fhs-1 | error | FamilyMemberHistory | Can have age[x] or born[x], but not both : age.empty() or born.empty() | |
fhs-2 | error | FamilyMemberHistory | Can only have estimatedAge if age[x] is present : age.exists() or estimatedAge.empty() |
This structure is derived from FamilyMemberHistory
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#7.0.0 based on FHIR 4.0.1. Generated 2025-02-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change