FHIR Artifacts > Structure Definition: AllergyIntolerance Profile

Structure Definition: AllergyIntolerance Profile

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

Simplifier project page:

Command 'link' could not render: File was not found for ca-on-eReferral-profile-AllergyIntolerance:name

Derived from: AllergyIntolerance (R4)

Formal Views of Profile Content

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

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
typeS Σ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityS Σ0..1codeBinding
codeAllergyCAS Σ0..1CodingBinding
absentOrUnknownAllergyS Σ0..1CodingBinding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
onsetDateTimedateTime
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
recordedDateS0..1dateTime
recorderI0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textS Σ1..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
descriptionS0..1string
onsetS0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
noteS0..*Annotation

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
typeS Σ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityS Σ0..1codeBinding
codeAllergyCAS Σ0..1CodingBinding
absentOrUnknownAllergyS Σ0..1CodingBinding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
onsetDateTimedateTime
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
recordedDateS0..1dateTime
recorderI0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textS Σ1..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
descriptionS0..1string
onsetS0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
noteS0..*Annotation

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
typeS Σ0..1codeBinding
categoryS Σ0..*codeBinding
criticalityS Σ0..1codeBinding
codeAllergyCAS Σ0..1CodingBinding
absentOrUnknownAllergyS Σ0..1CodingBinding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
onsetDateTimedateTime
onsetAgeAge
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
recordedDateS0..1dateTime
recorderI0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)
lastOccurrenceS0..1dateTime
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textS Σ1..1markdown
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
descriptionS0..1string
onsetS0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConcept
noteS0..*Annotation

Table View

AllergyIntolerance..
AllergyIntolerance.meta1..
AllergyIntolerance.meta.profile1..
AllergyIntolerance.identifier..
AllergyIntolerance.identifier.system..
AllergyIntolerance.identifier.value..
AllergyIntolerance.clinicalStatus1..
AllergyIntolerance.clinicalStatus.coding..
AllergyIntolerance.clinicalStatus.coding.system..
AllergyIntolerance.clinicalStatus.coding.code..
AllergyIntolerance.clinicalStatus.coding.display..
AllergyIntolerance.verificationStatus..
AllergyIntolerance.verificationStatus.coding..
AllergyIntolerance.verificationStatus.coding.system..
AllergyIntolerance.verificationStatus.coding.code..
AllergyIntolerance.verificationStatus.coding.display..
AllergyIntolerance.type..
AllergyIntolerance.category..
AllergyIntolerance.criticality..
AllergyIntolerance.code1..
AllergyIntolerance.code.coding..
AllergyIntolerance.code.coding..1
AllergyIntolerance.code.coding..1
AllergyIntolerance.code.text..
AllergyIntolerance.patientReference(Patient)..
AllergyIntolerance.patient.reference1..
AllergyIntolerance.onset[x]..
AllergyIntolerance.recordedDate..
AllergyIntolerance.lastOccurrence..
AllergyIntolerance.note..1
AllergyIntolerance.note.text..
AllergyIntolerance.reaction..
AllergyIntolerance.reaction.substance..
AllergyIntolerance.reaction.substance.coding..
AllergyIntolerance.reaction.substance.coding.system..
AllergyIntolerance.reaction.substance.coding.code..
AllergyIntolerance.reaction.substance.text..
AllergyIntolerance.reaction.manifestation..
AllergyIntolerance.reaction.manifestation.coding..
AllergyIntolerance.reaction.manifestation.coding.system..
AllergyIntolerance.reaction.manifestation.coding.code..
AllergyIntolerance.reaction.manifestation.text..
AllergyIntolerance.reaction.description..
AllergyIntolerance.reaction.onset..
AllergyIntolerance.reaction.severity..
AllergyIntolerance.reaction.note..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-eReferral-profile-AllergyIntolerance",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance",
    "version": "1.0.0",
    "name": "EReferralAllergyIntolerance",
    "title": "AllergyIntolerance",
    "status": "draft",
    "description": "This profile details the clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AllergyIntolerance",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AllergyIntolerance",
                "path": "AllergyIntolerance",
                "short": "AllergyIntolerance Profile",
                "definition": "The AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource"
            },
            {
                "id": "AllergyIntolerance.meta",
                "path": "AllergyIntolerance.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.meta.profile",
                "path": "AllergyIntolerance.meta.profile",
                "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.identifier",
                "path": "AllergyIntolerance.identifier",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.identifier.system",
                "path": "AllergyIntolerance.identifier.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.identifier.value",
                "path": "AllergyIntolerance.identifier.value",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus",
                "path": "AllergyIntolerance.clinicalStatus",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical"
                }
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding",
                "path": "AllergyIntolerance.clinicalStatus.coding",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.system",
                "path": "AllergyIntolerance.clinicalStatus.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.code",
                "path": "AllergyIntolerance.clinicalStatus.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.display",
                "path": "AllergyIntolerance.clinicalStatus.coding.display",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus",
                "path": "AllergyIntolerance.verificationStatus",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification"
                }
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding",
                "path": "AllergyIntolerance.verificationStatus.coding",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.system",
                "path": "AllergyIntolerance.verificationStatus.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.code",
                "path": "AllergyIntolerance.verificationStatus.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.display",
                "path": "AllergyIntolerance.verificationStatus.coding.display",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.type",
                "path": "AllergyIntolerance.type",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type"
                }
            },
            {
                "id": "AllergyIntolerance.category",
                "path": "AllergyIntolerance.category",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category"
                }
            },
            {
                "id": "AllergyIntolerance.criticality",
                "path": "AllergyIntolerance.criticality",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality"
                }
            },
            {
                "id": "AllergyIntolerance.code",
                "path": "AllergyIntolerance.code",
                "short": "Concept - reference to a terminology or just  text",
                "definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
                "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "Type of the substance/product, allergy or intolerance condition.",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips"
                }
            },
            {
                "id": "AllergyIntolerance.code.coding",
                "path": "AllergyIntolerance.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "definition": "A reference to a code defined by a terminology system.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:codeAllergyCA",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "codeAllergyCA",
                "short": "Optional slice for code for allergy or intolerance from the SNOMED CT CA code set",
                "definition": "Code for an allergy or intolerance statement that is selected from the SNOMED CT Canadian edition value set.",
                "comment": "Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "Codes for allergy or intolerance from the SNOMED CT GPS code set",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/substanceandpharmaceuticalbiologicproductcode"
                }
            },
            {
                "id": "AllergyIntolerance.code.coding:absentOrUnknownAllergy",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "absentOrUnknownAllergy",
                "short": "Code for absent or unknown allergy",
                "definition": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement).  This describes a categorical negated statement (e.g., \"No known allergy\").",
                "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "description": "negation/exclusion codes for reporting no known allergies or not available data.",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-allergies-uv-ips"
                }
            },
            {
                "id": "AllergyIntolerance.code.text",
                "path": "AllergyIntolerance.code.text",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient",
                "path": "AllergyIntolerance.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient.reference",
                "path": "AllergyIntolerance.patient.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]",
                "path": "AllergyIntolerance.onset[x]",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recordedDate",
                "path": "AllergyIntolerance.recordedDate",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.lastOccurrence",
                "path": "AllergyIntolerance.lastOccurrence",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note",
                "path": "AllergyIntolerance.note",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.text",
                "path": "AllergyIntolerance.note.text",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction",
                "path": "AllergyIntolerance.reaction",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance",
                "path": "AllergyIntolerance.reaction.substance",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding.system",
                "path": "AllergyIntolerance.reaction.substance.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding.code",
                "path": "AllergyIntolerance.reaction.substance.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.text",
                "path": "AllergyIntolerance.reaction.substance.text",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation",
                "path": "AllergyIntolerance.reaction.manifestation",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding",
                "path": "AllergyIntolerance.reaction.manifestation.coding",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding.system",
                "path": "AllergyIntolerance.reaction.manifestation.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding.code",
                "path": "AllergyIntolerance.reaction.manifestation.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.text",
                "path": "AllergyIntolerance.reaction.manifestation.text",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.description",
                "path": "AllergyIntolerance.reaction.description",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.onset",
                "path": "AllergyIntolerance.reaction.onset",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.severity",
                "path": "AllergyIntolerance.reaction.severity",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.note",
                "path": "AllergyIntolerance.reaction.note",
                "mustSupport": true
            }
        ]
    }
}

Usage

The AllergyIntolerance resource is used to attach supporting information to a ServiceRequest.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance|1.0.0