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-ballot 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-ballot | |||
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.
Father Died of Heart Attack Example |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | FamilyMemberHistory | |||
patient | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | |
date | 0..1 | dateTime | (QI) When history was recorded or last updated | |
relationship | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | |
age[x] | 0..1 | Age, Range, string | (QI) (approximate) age | |
deceased[x] | 0..1 | boolean, Age, Range, date, string | (QI) Dead? How old/when? | |
condition | 0..* | BackboneElement | Condition that the related person had | |
Slices for extension | Content/Rules for all slices | |||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
condition-severity | 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. | |
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
onset[x] | 0..1 | Age, Range, Period, string | When condition first manifested | |
Documentation for this format |
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 |
---|---|---|---|---|
FamilyMemberHistory | 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
patient | Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about |
date | Σ | 0..1 | dateTime | (QI) When history was recorded or last updated |
relationship | Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) |
age[x] | ΣC | 0..1 | (QI) (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
deceased[x] | Σ | 0..1 | (QI) Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
condition | 0..* | BackboneElement | Condition that the related person had | |
Slices for extension | Content/Rules for all slices | |||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
condition-severity | 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. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
Documentation for this format |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
FamilyMemberHistory | 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 | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Id(s) for this record | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
dataAbsentReason | Σ | 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. | ||||
patient | Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | ||||
date | Σ | 0..1 | dateTime | (QI) When history was recorded or last updated | ||||
name | Σ | 0..1 | string | The family member described | ||||
relationship | Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | ||||
sex | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
born[x] | C | 0..1 | (approximate) date of birth | |||||
bornPeriod | Period | |||||||
bornDate | date | |||||||
bornString | string | |||||||
age[x] | ΣC | 0..1 | (QI) (approximate) age | |||||
ageAge | Age | |||||||
ageRange | Range | |||||||
ageString | string | |||||||
estimatedAge | ΣC | 0..1 | boolean | Age is estimated? | ||||
deceased[x] | Σ | 0..1 | (QI) Dead? How old/when? | |||||
deceasedBoolean | boolean | |||||||
deceasedAge | Age | |||||||
deceasedRange | Range | |||||||
deceasedDate | date | |||||||
deceasedString | string | |||||||
reasonCode | Σ | 0..* | CodeableConcept | Why 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..* | Annotation | General note about related person | |||||
condition | 0..* | BackboneElement | Condition that the related person had | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |||||
condition-severity | 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. | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |||||
outcome | 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. | |||||
contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |||||
onset[x] | 0..1 | When condition first manifested | ||||||
onsetAge | Age | |||||||
onsetRange | Range | |||||||
onsetPeriod | Period | |||||||
onsetString | string | |||||||
note | 0..* | Annotation | Extra information about condition | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
FamilyMemberHistory.language | preferred | CommonLanguages
http://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
Differential View
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | FamilyMemberHistory | |||
patient | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | |
date | 0..1 | dateTime | (QI) When history was recorded or last updated | |
relationship | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | |
age[x] | 0..1 | Age, Range, string | (QI) (approximate) age | |
deceased[x] | 0..1 | boolean, Age, Range, date, string | (QI) Dead? How old/when? | |
condition | 0..* | BackboneElement | Condition that the related person had | |
Slices for extension | Content/Rules for all slices | |||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
condition-severity | 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. | |
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
onset[x] | 0..1 | Age, Range, Period, string | When condition first manifested | |
Documentation for this format |
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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | 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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. |
patient | Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about |
date | Σ | 0..1 | dateTime | (QI) When history was recorded or last updated |
relationship | Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) |
age[x] | ΣC | 0..1 | (QI) (approximate) age | |
ageAge | Age | |||
ageRange | Range | |||
ageString | string | |||
deceased[x] | Σ | 0..1 | (QI) Dead? How old/when? | |
deceasedBoolean | boolean | |||
deceasedAge | Age | |||
deceasedRange | Range | |||
deceasedDate | date | |||
deceasedString | string | |||
condition | 0..* | BackboneElement | Condition that the related person had | |
Slices for extension | Content/Rules for all slices | |||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |
condition-severity | 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. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |
onset[x] | 0..1 | When condition first manifested | ||
onsetAge | Age | |||
onsetRange | Range | |||
onsetPeriod | Period | |||
onsetString | string | |||
Documentation for this format |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
FamilyMemberHistory | 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 | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Id(s) for this record | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
status | ?!Σ | 1..1 | code | partial | completed | entered-in-error | health-unknown Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record. | ||||
dataAbsentReason | Σ | 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. | ||||
patient | Σ | 1..1 | Reference(QICore Patient) | (QI) Patient history is about | ||||
date | Σ | 0..1 | dateTime | (QI) When history was recorded or last updated | ||||
name | Σ | 0..1 | string | The family member described | ||||
relationship | Σ | 1..1 | CodeableConcept | (QI) Relationship to the subject Binding: FamilyMember (preferred) | ||||
sex | Σ | 0..1 | CodeableConcept | male | female | other | unknown Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration. | ||||
born[x] | C | 0..1 | (approximate) date of birth | |||||
bornPeriod | Period | |||||||
bornDate | date | |||||||
bornString | string | |||||||
age[x] | ΣC | 0..1 | (QI) (approximate) age | |||||
ageAge | Age | |||||||
ageRange | Range | |||||||
ageString | string | |||||||
estimatedAge | ΣC | 0..1 | boolean | Age is estimated? | ||||
deceased[x] | Σ | 0..1 | (QI) Dead? How old/when? | |||||
deceasedBoolean | boolean | |||||||
deceasedAge | Age | |||||||
deceasedRange | Range | |||||||
deceasedDate | date | |||||||
deceasedString | string | |||||||
reasonCode | Σ | 0..* | CodeableConcept | Why 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..* | Annotation | General note about related person | |||||
condition | 0..* | BackboneElement | Condition that the related person had | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
condition-abatement | 0..1 | date, Age, boolean | When (or if) the family member's condition resolved URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement | |||||
condition-severity | 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. | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | (QI) Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (extensible): Identification of the Condition or diagnosis. | |||||
outcome | 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. | |||||
contributedToDeath | 0..1 | boolean | Whether the condition contributed to the cause of death | |||||
onset[x] | 0..1 | When condition first manifested | ||||||
onsetAge | Age | |||||||
onsetRange | Range | |||||||
onsetPeriod | Period | |||||||
onsetString | string | |||||||
note | 0..* | Annotation | Extra information about condition | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
FamilyMemberHistory.language | preferred | CommonLanguages
http://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