Profiles & Interactions > Structure Definition: Observation-BornInCanada Profile

Profile: Observation-BornInCanada

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Observation-born-in-canada

Simplifier project page: package/StructureDefinition.ca-on-mha-profile-ObservationBornInCanada.json

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
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ0..*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Σ0..*Reference(Resource)
encounterΣ0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..1instant
performerΣ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
valueBooleanboolean
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
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..1CodeableConcept
method0..1CodeableConcept
specimen0..1Reference(Specimen)
device0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
age0..1Range
text0..1string
hasMemberΣ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
codingS Σ1..1Coding
textS Σ1..1stringFixed Value
valueDateTimedateTime
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Hybrid View

Command 'tree' could not render: File not found for 'subject=on-mentalhealthandaddictiondatarepositoryObservationBornInCanada'

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
basedOnΣ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ0..*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Σ0..*Reference(Resource)
encounterΣ0..1Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..1instant
performerΣ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
valueBooleanboolean
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
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..1CodeableConcept
method0..1CodeableConcept
specimen0..1Reference(Specimen)
device0..1Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
age0..1Range
text0..1string
hasMemberΣ0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
codingS Σ1..1Coding
textS Σ1..1stringFixed Value
valueDateTimedateTime
dataAbsentReasonI0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
referenceRange0..*see (referenceRange)

Table View

Observation..
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(Patient)1..
Observation.subject.reference1..
Observation.effective[x]dateTime1..
Observation.value[x]boolean..
Observation.dataAbsentReason..
Observation.dataAbsentReason.coding1..1
Observation.dataAbsentReason.coding.system1..
Observation.dataAbsentReason.coding.code1..
Observation.dataAbsentReason.coding.display1..
Observation.component..1
Observation.component.code..
Observation.component.code.coding1..1
Observation.component.code.text1..
Observation.component.value[x]dateTime..

JSON View

{
    "resourceType": "StructureDefinition",
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Observation-born-in-canada",
    "version": "1.0.0",
    "name": "ObservationBornInCanada",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Observation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Observation",
                "path": "Observation",
                "constraint":  [
                    {
                        "key": "component-1",
                        "severity": "error",
                        "human": "\"Arrive In Canada\" must be completed if \"Born In Canada\" is false",
                        "expression": "value = 'false' implies component.exists()"
                    }
                ]
            },
            {
                "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|2.0.0"
                }
            },
            {
                "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://snomed.info/sct",
                "mustSupport": true
            },
            {
                "id": "Observation.code.coding.code",
                "path": "Observation.code.coding.code",
                "min": 1,
                "fixedCode": "315398004",
                "mustSupport": true
            },
            {
                "id": "Observation.code.coding.display",
                "path": "Observation.code.coding.display",
                "min": 1,
                "fixedString": "Born in Canada",
                "mustSupport": true
            },
            {
                "id": "Observation.subject",
                "path": "Observation.subject",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Patient|2.0.0"
                        ]
                    }
                ]
            },
            {
                "id": "Observation.subject.reference",
                "path": "Observation.subject.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.effective[x]",
                "path": "Observation.effective[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.value[x]",
                "path": "Observation.value[x]",
                "type":  [
                    {
                        "code": "boolean"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Observation.dataAbsentReason",
                "path": "Observation.dataAbsentReason",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "codes that indicate the reason the value is missing",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/mha-sdoh-data-absent-reason"
                }
            },
            {
                "id": "Observation.dataAbsentReason.coding",
                "path": "Observation.dataAbsentReason.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.dataAbsentReason.coding.system",
                "path": "Observation.dataAbsentReason.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.dataAbsentReason.coding.code",
                "path": "Observation.dataAbsentReason.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.dataAbsentReason.coding.display",
                "path": "Observation.dataAbsentReason.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Observation.component",
                "path": "Observation.component",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.component.code",
                "path": "Observation.component.code",
                "mustSupport": true
            },
            {
                "id": "Observation.component.code.coding",
                "path": "Observation.component.code.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Observation.component.code.text",
                "path": "Observation.component.code.text",
                "min": 1,
                "fixedString": "Arrive In Canada",
                "mustSupport": true
            },
            {
                "id": "Observation.component.value[x]",
                "path": "Observation.component.value[x]",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Usage

The Observation-BornInCanada Resource is used to identify whether the client was born in Canada or immigrated to Canada. Born/arrived in Canada status refers to a person’s origin and/or arrival into Canada and the time frame when they arrived in Canada.

Notes

meta.profile

  • Used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Observation-born-in-canada|1.0.0

.status

  • SHALL send an applicable value defined in FHIR. If vendor system does not support this field, use “unknown”.

.category

  • SHALL contain one coding element with system, code and display
    • system SHALL contain a fixed URI value of http://terminology.hl7.org/CodeSystem/observation-category
    • code SHALLcontain a fixed value of social-history.
    • display SHALL contain a fixed value of Social History.

.code

  • SHALL contain one coding element with system, code and display
    • system SHALL contain a fixed URI value of http://snomed.info/sct
    • code SHALLcontain a fixed value of ?.
    • display SHALL contain a fixed value of ?.

.subject

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

.effectiveDateTime

  • SHALL be populated to indicate that the SDOH attribute is effective only from a specific date, and that date is known.

.valueBoolean

  • SHALL contain true if client is born in Canada, false if client is not born in Canada
  • If populated, dataAbsentReason field SHALL not be populated

.dataAbsentReason

  • SHALL contain a code in teh value set if value[x] cannot be provided
  • If populated, value[x] SHALL not be populated.

.component

  • SHALL only be populated if valueBoolean is false. If populated, SHALL indicate the year the client arrived in Canada
    • SHALL contain a code
    • If the value is known, SHALL populate component.valuedateTime with a date that at least contains the year, e.g. "1979"
    • If the value is not known, SHALL populate component.dataAbsentReason with a code from the value set