Profiles & Operations > Structure Definition: AllergyIntolerance Profile

Profile: AllergyIntolerance

Canonical URL:http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-allergyIntolerance

Simplifier project page: AllergyIntolerance EHR

Derived from: AllergyIntolerance (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
ext-abatement-datetimeI0..1Extension(dateTime)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConceptEHRBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetDateTimeS0..1dateTime
onsetStringS0..1string
recordedDateS0..1dateTime
recorderS0..1Reference(PractitionerEHR | PractitionerRoleEHR | PatientEHR)
asserterΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConceptEHRBinding
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
ext-abatement-datetimeI0..1Extension(dateTime)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConceptEHRBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetDateTimeS0..1dateTime
onsetStringS0..1string
recordedDateS0..1dateTime
recorderS0..1Reference(PractitionerEHR | PractitionerRoleEHR | PatientEHR)
asserterΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConceptEHRBinding
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
ext-abatement-datetimeI0..1Extension(dateTime)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConceptEHRBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetDateTimeS0..1dateTime
onsetStringS0..1string
recordedDateS0..1dateTime
recorderS0..1Reference(PractitionerEHR | PractitionerRoleEHR | PatientEHR)
asserterΣ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConceptEHRBinding
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Table View

AllergyIntolerance..
AllergyIntolerance.extension..
AllergyIntolerance.extensionExtension0..1
AllergyIntolerance.category..
AllergyIntolerance.codeCodeableConceptEHR1..
AllergyIntolerance.patientReference(PatientEHR)..
AllergyIntolerance.patient.reference1..
AllergyIntolerance.encounterReference(EncounterEHR)..
AllergyIntolerance.encounter.reference1..
AllergyIntolerance.onset[x]..
AllergyIntolerance.onset[x]dateTime0..1
AllergyIntolerance.onset[x]string0..1
AllergyIntolerance.recordedDate..
AllergyIntolerance.recorderReference(PractitionerEHR | PractitionerRoleEHR | PatientEHR)..
AllergyIntolerance.lastOccurrence..
AllergyIntolerance.reaction..
AllergyIntolerance.reaction.manifestationCodeableConceptEHR..
AllergyIntolerance.reaction.severity..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "AllergyIntolerance",
    "url": "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-allergyIntolerance",
    "version": "1.0.0",
    "name": "AllergyIntoleranceEHR",
    "title": "AllergyIntolerance EHR",
    "status": "active",
    "description": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AllergyIntolerance",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AllergyIntolerance.extension",
                "path": "AllergyIntolerance.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "AllergyIntolerance.extension:ext-abatement-datetime",
                "path": "AllergyIntolerance.extension",
                "sliceName": "ext-abatement-datetime",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips"
                        ]
                    }
                ]
            },
            {
                "id": "AllergyIntolerance.category",
                "path": "AllergyIntolerance.category",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code",
                "path": "AllergyIntolerance.code",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/CodeableConcept-oh-ehr"
                        ]
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "preferred",
                    "valueSet": "http://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode",
                    "extension":  [
                        {
                            "extension":  [
                                {
                                    "url": "purpose",
                                    "valueCode": "candidate"
                                },
                                {
                                    "url": "valueSet",
                                    "valueCanonical": "http://ehealthontario.ca/fhir/ValueSet/canadianclinicaldrugdataset-CCDD"
                                },
                                {
                                    "url": "documentation",
                                    "valueMarkdown": "Canadian Clinical Drug Data Set providing codes for identification of medications and medical devices in Canada. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology."
                                }
                            ],
                            "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "purpose",
                                    "valueCode": "candidate"
                                },
                                {
                                    "url": "valueSet",
                                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/LicensedNaturalHealthProducts"
                                },
                                {
                                    "url": "documentation",
                                    "valueMarkdown": "All Natural Product Number (NPN) and Homeopathic Medicine Number (DIN-HM) codes that are licensed by Health Canada and present in the Licensed Natural Health Products Database."
                                }
                            ],
                            "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "purpose",
                                    "valueCode": "candidate"
                                },
                                {
                                    "url": "valueSet",
                                    "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-allergies-uv-ips"
                                },
                                {
                                    "url": "documentation",
                                    "valueMarkdown": "A code that classifies a use of Contrast for an MI procedure. This is used for searching, sorting and display purposes."
                                }
                            ],
                            "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
                        }
                    ]
                }
            },
            {
                "id": "AllergyIntolerance.patient",
                "path": "AllergyIntolerance.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient.reference",
                "path": "AllergyIntolerance.patient.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.encounter",
                "path": "AllergyIntolerance.encounter",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-encounter"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.encounter.reference",
                "path": "AllergyIntolerance.encounter.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]",
                "path": "AllergyIntolerance.onset[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetDateTime",
                "path": "AllergyIntolerance.onset[x]",
                "sliceName": "onsetDateTime",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetString",
                "path": "AllergyIntolerance.onset[x]",
                "sliceName": "onsetString",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recordedDate",
                "path": "AllergyIntolerance.recordedDate",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recorder",
                "path": "AllergyIntolerance.recorder",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-practitioner",
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-practitionerRole",
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.lastOccurrence",
                "path": "AllergyIntolerance.lastOccurrence",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction",
                "path": "AllergyIntolerance.reaction",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation",
                "path": "AllergyIntolerance.reaction.manifestation",
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/ehr/StructureDefinition/CodeableConcept-oh-ehr"
                        ]
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.severity",
                "path": "AllergyIntolerance.reaction.severity",
                "mustSupport": true
            }
        ]
    }
}

Usage

The AllergyIntolerance resource captures information about a patient visit. This could be acute related or virtual visit. Some elements use different values for acute and virtual visits. Pelase see notes below.

Notes

.contained

  • If populated, this contains the resources referenced by the AllergyIntolerance resource.

.category

  • SHOULD specify the high-level category of allergy (e.g. drug, food, animal).

.code

  • SHALL identify the allergen, using an identified standard coding system, local mnemonic or description

.patient

  • SHALL contain a reference to the patient resource

.encounter

  • SHOULD contain a reference to the Encounter resource if applicable

.onset[x]

  • SHOULD contain a date of the first reaction if applicable. This could indicate a dateime or a textual description of the first reaction if an exact date is not known, such as "Childhood" or "Summer 2003"

.recordedDate

  • SHOULD contain a timestamp describing when this allergen was first reported

.recorder

  • SHOULD contain a reference identifying the person who reported the allergy to the patient. The type of reference indicates the relationship to the patient, such as "RelatedPerson" if the patient's relative reproted the allergy

.reaction

  • SHOULD contain the symptom associated with the allergy if applicable
  • if populated,
    • .reaction.manifestion SHALL contain the symptom
    • .reaction.severity SHOULD indicate the severity of the allergy