Profiles & Operations > Structure Definition: Observation-TotalHouseholdIncome Profile

Profile: Observation-TotalHouseholdIncome

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-profile-observation-total-household-income

Simplifier project page: MHA Observation-TotalHouseholdIncome Profile

Derived from: Observation(R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
focusΣ I0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..1instant
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..1CodeableConcept
method0..1CodeableConcept
specimenI0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
focusΣ I0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..1instant
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..1CodeableConcept
method0..1CodeableConcept
specimenI0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
focusΣ I0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..1instant
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..1CodeableConcept
method0..1CodeableConcept
specimenI0..1Reference(Specimen)
deviceI0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ I0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ1..1CodeableConcept
valueQuantityQuantity
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Table View

Observation..
Observation.meta1..
Observation.meta.profile1..1
Observation.status..
Observation.category1..1
Observation.category.coding1..1
Observation.category.coding.system1..
Observation.category.coding.code1..
Observation.category.coding.display1..
Observation.code..
Observation.code.coding1..1
Observation.code.coding.system1..
Observation.code.coding.code1..
Observation.code.coding.display1..
Observation.subjectReference(MHA Patient Profile)1..
Observation.subject.reference1..
Observation.effective[x]dateTime..
Observation.value[x]CodeableConcept1..
Observation.value[x].coding1..1
Observation.value[x].coding.system1..
Observation.value[x].coding.code1..
Observation.value[x].coding.display1..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Observation",
    "meta": {
        "lastUpdated": "2022-06-25T04:06:37.08876+00:00"
    },
    "text": {
        "status": "extensions",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-profile-observation-total-household-income",
    "version": "1.0.0",
    "name": "ObservationTotalHouseholdIncome",
    "title": "MHA Observation-TotalHouseholdIncome Profile",
    "status": "active",
    "date": "2022-08-22T20:17:06.3613088+00:00",
    "publisher": "Ontario Health",
    "description": "This profile constrains the Observation resource for use related to Social Determinants of Health observations that involve assessments conducted along the client journey.",
    "jurisdiction":  [
        {
            "coding":  [
                {
                    "system": "urn:iso:std:iso:3166",
                    "code": "US"
                }
            ]
        }
    ],
    "purpose": "This resource will capture information pertaining to the client's total household income.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "sct-concept",
            "uri": "http://snomed.info/conceptdomain",
            "name": "SNOMED CT Concept Domain Binding"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "sct-attr",
            "uri": "http://snomed.org/attributebinding",
            "name": "SNOMED CT Attribute Binding"
        },
        {
            "identity": "MHA-PDS-Mapping",
            "name": "MHA PDS Mapping"
        }
    ],
    "kind": "resource",
    "abstract": true,
    "type": "Observation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Observation",
                "path": "Observation",
                "short": "SDOH assessment observation",
                "definition": "For SDOH observations derived from assessment of the client.",
                "comment": "For representation of SDOH observations that involve assessments conducted along the client journey.",
                "mustSupport": true
            },
            {
                "id": "Observation.meta",
                "path": "Observation.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.meta.profile",
                "path": "Observation.meta.profile",
                "min": 1,
                "max": "1",
                "fixedCanonical": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-profile-observation-total-household-income",
                "mustSupport": true
            },
            {
                "id": "Observation.status",
                "path": "Observation.status",
                "mustSupport": true
            },
            {
                "id": "Observation.category",
                "path": "Observation.category",
                "min": 1,
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required"
                }
            },
            {
                "id": "Observation.category.coding",
                "path": "Observation.category.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.category.coding.system",
                "path": "Observation.category.coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category",
                "mustSupport": true
            },
            {
                "id": "Observation.category.coding.code",
                "path": "Observation.category.coding.code",
                "min": 1,
                "fixedCode": "social-history",
                "mustSupport": true
            },
            {
                "id": "Observation.category.coding.display",
                "path": "Observation.category.coding.display",
                "min": 1,
                "fixedString": "Social History",
                "mustSupport": true
            },
            {
                "id": "Observation.code",
                "path": "Observation.code",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/sdohObservationCode"
                }
            },
            {
                "id": "Observation.code.coding",
                "path": "Observation.code.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.code.coding.system",
                "path": "Observation.code.coding.system",
                "min": 1,
                "fixedUri": "http://loinc.org",
                "mustSupport": true
            },
            {
                "id": "Observation.code.coding.code",
                "path": "Observation.code.coding.code",
                "min": 1,
                "fixedCode": "77244-2",
                "mustSupport": true
            },
            {
                "id": "Observation.code.coding.display",
                "path": "Observation.code.coding.display",
                "min": 1,
                "fixedString": "Total Household Income",
                "mustSupport": true
            },
            {
                "id": "Observation.subject",
                "path": "Observation.subject",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.subject.reference",
                "path": "Observation.subject.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.effective[x]",
                "path": "Observation.effective[x]",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.value[x]",
                "path": "Observation.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "The combined annual income (before tax) of client's household from all sources, including wages, commissions, bonuses, social assistance and retirement income.",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/total-household-income"
                }
            },
            {
                "id": "Observation.value[x].coding",
                "path": "Observation.value[x].coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.value[x].coding.system",
                "path": "Observation.value[x].coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.value[x].coding.code",
                "path": "Observation.value[x].coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.value[x].coding.display",
                "path": "Observation.value[x].coding.display",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Usage

The Observation-TotalHouseholdIncome Resource is used to collect data regarding a client's total household income.

Notes

.meta.profile

  • Used to declare conformance to this profile.
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-profile-observation-total-household-income
.meta.versionId

  • SHALL be populated by the OH FHIR server
  • source systems do not need to populate this element prior to submission
category.coding.system

  • SHALL contain a fixed URI value of http://terminology.hl7.org/CodeSystem/observation-category.
category.coding.code

  • SHALL contain a fixed value of social-history.
category.coding.display

  • SHALL contain a fixed value of social-history.
code.coding.system

  • SHALL contain a fixed value of http://loinc.org.
code.coding.code

  • SHALL contain a fixed code value of 77244-2.
code.coding.display

  • SHALL contain a fixed value of Total Household Income in the display field.
.subject

  • SHALL contain a reference to the Patient resource to which this Observation resource applies.
effective.effectiveDateTime

  • MAY contain an effective date if the SDOH attribute is effective only from a specific date, and that date is known.
.value.coding.system

  • SHALL contain the URI for one of the systems specified in the value set.
.value.coding.code

  • SHALL contain a code with the value from the specified value set that best represents the client's total household income.