Profiles & Operations > Structure Definition: AllergyIntolerance Profile

Profile: AllergyIntolerance

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-accdr-profile-AllergyIntolerance

Simplifier project page: CDRAllergyIntolerance

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
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..1codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConcept
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
onsetDateTimedateTime
onsetStringstring
recordedDateS0..1dateTime
recorderS I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrence0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConcept
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..1codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConcept
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
onsetDateTimedateTime
onsetStringstring
recordedDateS0..1dateTime
recorderS I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrence0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConcept
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
clinicalStatusΣ ?! I0..1CodeableConceptBinding
verificationStatusΣ ?! I0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryS Σ0..1codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConcept
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
onsetDateTimedateTime
onsetStringstring
recordedDateS0..1dateTime
recorderS I0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrence0..1dateTime
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
substance0..1CodeableConcept
manifestationS1..*CodeableConcept
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
note0..*Annotation

Table View

AllergyIntolerance..
AllergyIntolerance.meta1..
AllergyIntolerance.meta.profile1..
AllergyIntolerance.category..1
AllergyIntolerance.code1..
AllergyIntolerance.patientReference(CDRPatient)..
AllergyIntolerance.patient.reference1..
AllergyIntolerance.encounterReference(CDREncounter)..
AllergyIntolerance.encounter.reference1..
AllergyIntolerance.onset[x]dateTime, string..
AllergyIntolerance.recordedDate..
AllergyIntolerance.recorder..
AllergyIntolerance.reaction..
AllergyIntolerance.reaction.manifestation..
AllergyIntolerance.reaction.severity..

JSON View

{
    "resourceType": "StructureDefinition",
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-accdr-profile-AllergyIntolerance",
    "name": "CDRAllergyIntolerance",
    "status": "active",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AllergyIntolerance",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AllergyIntolerance.meta",
                "path": "AllergyIntolerance.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.meta.profile",
                "path": "AllergyIntolerance.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.category",
                "path": "AllergyIntolerance.category",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code",
                "path": "AllergyIntolerance.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient",
                "path": "AllergyIntolerance.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-accdr-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/StructureDefinition/ca-on-accdr-profile-Encounter"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.encounter.reference",
                "path": "AllergyIntolerance.encounter.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]",
                "path": "AllergyIntolerance.onset[x]",
                "type":  [
                    {
                        "code": "dateTime"
                    },
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recordedDate",
                "path": "AllergyIntolerance.recordedDate",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recorder",
                "path": "AllergyIntolerance.recorder",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction",
                "path": "AllergyIntolerance.reaction",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation",
                "path": "AllergyIntolerance.reaction.manifestation",
                "mustSupport": true
            },
            {
                "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

.meta.profile

  • must contain the canonical URI of the profile

.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