IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-family-member-history | Version: 0.18.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: ILCoreFamilyMemberHistory |
Israel Core proposed constraints and extensions on theILCoreFamilyMemberHistory Resource
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 | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile | |
patient | 1..1 | Reference(ILCore Patient Profile) | Patient history is about | |
reasonReference | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why was family member history performed? | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | C | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile 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(ILCore Patient Profile) | Patient history is about |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. |
reasonReference | Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why was family member history performed? |
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 | example | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
FamilyMemberHistory | C | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile 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(ILCore Patient Profile) | Patient history is about | ||||
date | Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
name | Σ | 0..1 | string | The family member described | ||||
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. | ||||
sex | Σ | 0..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 | (approximate) age | |||||
ageAge | Age | |||||||
ageRange | Range | |||||||
ageString | string | |||||||
estimatedAge | ΣC | 0..1 | boolean | Age is estimated? | ||||
deceased[x] | Σ | 0..1 | 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(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): 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 | example | 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 | example | 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 |
This structure is derived from FamilyMemberHistory
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from FamilyMemberHistory
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile | |
patient | 1..1 | Reference(ILCore Patient Profile) | Patient history is about | |
reasonReference | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why was family member history performed? | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FamilyMemberHistory | C | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile 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(ILCore Patient Profile) | Patient history is about |
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. |
reasonReference | Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | Why was family member history performed? |
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 | example | FamilyMemberhttp://terminology.hl7.org/ValueSet/v3-FamilyMember |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
FamilyMemberHistory | C | 0..* | FamilyMemberHistory | ILCore FamilyMemberHistory Profile 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(ILCore Patient Profile) | Patient history is about | ||||
date | Σ | 0..1 | dateTime | When history was recorded or last updated | ||||
name | Σ | 0..1 | string | The family member described | ||||
relationship | Σ | 1..1 | CodeableConcept | Relationship to the subject Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history. | ||||
sex | Σ | 0..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 | (approximate) age | |||||
ageAge | Age | |||||||
ageRange | Range | |||||||
ageString | string | |||||||
estimatedAge | ΣC | 0..1 | boolean | Age is estimated? | ||||
deceased[x] | Σ | 0..1 | 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(ILCore Condition Profile | ILCore Observation Profile | ILCore AllergyIntolerance Profile | ILCore QuestionnaireResponse Profile | ILCore DiagnosticReport Profile | ILCore DocumentReference Profile) | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Condition suffered by relation Binding: Condition/Problem/DiagnosisCodes (example): 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 | example | 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 | example | 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 |
This structure is derived from FamilyMemberHistory
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron