FHIR Artifacts > Structure Definition: FamilyMemberHistory Profile

Structure Definition: FamilyMemberHistory Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-FamilyMemberHistory

Simplifier project page: FamilyMemberHistory

Derived from: FamilyMemberHistory (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
instantiatesCanonicalΣ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
instantiatesUriΣ0..*uri
statusΣ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
codingΣ1..1CodingFixed Value
textΣ0..1string
patientΣ I1..1Reference(Patient)
dateΣ0..1dateTime
nameΣ0..1string
relationshipΣ1..1CodeableConceptBinding
sexΣ0..1CodeableConceptBinding
bornPeriodPeriod
bornDatedate
bornStringstring
ageAgeAge
ageRangeRange
ageStringstring
estimatedAgeS Σ I0..1boolean
deceasedBooleanboolean
deceasedAgeAge
deceasedRangeRange
deceasedDatedate
deceasedStringstring
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1CodeableConcept
outcome0..1CodeableConcept
contributedToDeath0..1boolean
onsetAgeAge
onsetRangeRange
onsetPeriodPeriod
onsetStringstring
note0..*Annotation

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
instantiatesCanonicalΣ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
instantiatesUriΣ0..*uri
statusΣ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
codingΣ1..1CodingFixed Value
textΣ0..1string
patientΣ I1..1Reference(Patient)
dateΣ0..1dateTime
nameΣ0..1string
relationshipΣ1..1CodeableConceptBinding
sexΣ0..1CodeableConceptBinding
bornPeriodPeriod
bornDatedate
bornStringstring
ageAgeAge
ageRangeRange
ageStringstring
estimatedAgeS Σ I0..1boolean
deceasedBooleanboolean
deceasedAgeAge
deceasedRangeRange
deceasedDatedate
deceasedStringstring
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1CodeableConcept
outcome0..1CodeableConcept
contributedToDeath0..1boolean
onsetAgeAge
onsetRangeRange
onsetPeriodPeriod
onsetStringstring
note0..*Annotation

Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
instantiatesCanonicalΣ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)
instantiatesUriΣ0..*uri
statusΣ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
codingΣ1..1CodingFixed Value
textΣ0..1string
patientΣ I1..1Reference(Patient)
dateΣ0..1dateTime
nameΣ0..1string
relationshipΣ1..1CodeableConceptBinding
sexΣ0..1CodeableConceptBinding
bornPeriodPeriod
bornDatedate
bornStringstring
ageAgeAge
ageRangeRange
ageStringstring
estimatedAgeS Σ I0..1boolean
deceasedBooleanboolean
deceasedAgeAge
deceasedRangeRange
deceasedDatedate
deceasedStringstring
reasonCodeΣ0..*CodeableConcept
reasonReferenceΣ I0..*Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference)
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1CodeableConcept
outcome0..1CodeableConcept
contributedToDeath0..1boolean
onsetAgeAge
onsetRangeRange
onsetPeriodPeriod
onsetStringstring
note0..*Annotation

Table View

FamilyMemberHistory..
FamilyMemberHistory.dataAbsentReason..
FamilyMemberHistory.dataAbsentReason.coding1..1
FamilyMemberHistory.relationship..
FamilyMemberHistory.age[x]..
FamilyMemberHistory.estimatedAge..
FamilyMemberHistory.note..
FamilyMemberHistory.condition..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-eReferral-profile-FamilyMemberHistory",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-FamilyMemberHistory",
    "name": "FamilyMemberHistory",
    "title": "FamilyMemberHistory",
    "status": "draft",
    "description": "FamilyMemberHistory is one of the event resources in the FHIR workflow specification.\n\nThis resource records significant health conditions for a particular individual related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "FamilyMemberHistory",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "FamilyMemberHistory.dataAbsentReason",
                "path": "FamilyMemberHistory.dataAbsentReason",
                "mustSupport": true
            },
            {
                "id": "FamilyMemberHistory.dataAbsentReason.coding",
                "path": "FamilyMemberHistory.dataAbsentReason.coding",
                "min": 1,
                "max": "1",
                "fixedCoding": {
                    "system": "http://hl7.org/fhir/ValueSet/history-absent-reason",
                    "code": "unable-to-obtain",
                    "display": "Unable To Obtain"
                }
            },
            {
                "id": "FamilyMemberHistory.relationship",
                "path": "FamilyMemberHistory.relationship",
                "binding": {
                    "strength": "extensible"
                }
            },
            {
                "id": "FamilyMemberHistory.age[x]",
                "path": "FamilyMemberHistory.age[x]",
                "mustSupport": true
            },
            {
                "id": "FamilyMemberHistory.estimatedAge",
                "path": "FamilyMemberHistory.estimatedAge",
                "mustSupport": true
            },
            {
                "id": "FamilyMemberHistory.note",
                "path": "FamilyMemberHistory.note",
                "mustSupport": false
            },
            {
                "id": "FamilyMemberHistory.condition",
                "path": "FamilyMemberHistory.condition",
                "mustSupport": true
            }
        ]
    }
}

Usage

FamilyMemberHistory is one of the event resources in the FHIR workflow specification.

This resource records significant health conditions for a particular individual related to the subject. This information can be known to different levels of accuracy. Sometimes the exact condition ('asthma') is known, and sometimes it is less precise ('some sort of cancer'). Equally, sometimes the person can be identified ('my aunt Agatha') and sometimes all that is known is that the person was an uncle.

Notes

A minimally populated FamilyMemberHistory resource could include: .status, .patient, .relationship, and .condition.text

.dataAbsentReason

  • used to indicate why that family member's history is not available and is fixed to "unable-to-obtain"

.age

  • this is the (approximate) age of the family member
  • if .age is populated, .estimatedAge SHALL be populated

.estimatedAge

  • this is an indication as to whether .age. is estimated
  • SHALL only be populated if .age is populated

.condition.text

  • can be used to capture textual information about the family member's condition if coded condition information is not available