Visit the HL7 website
Visit the FHIR website

CA Core+ v1.1.0 DFT-preBallot

1.1.0-DFT-preBallot   Canada flag
  • Index
  • Home
  • Business Context
    • Business Context
    • Relationship to PCHDCF
    • Relationship to Other Specifications
    • CA Core+ to pCHDCF Mapping
  • Technical Context
    • Technical Context
    • Artifact Status Summary
    • Profiling Conventions & Approach
    • General Guidance
    • Mapping Logic
    • Security And Privacy
  • Modules
    • Modules
    • Common Data Exchange
    • Workflows
  • FHIR Artifacts
    • FHIR Artifacts
    • Profiles
    • Extensions
    • Data Types
    • Terminology
    • Examples
    • Download
  • Change Log
    • Change Log
    • Specification Guidance
    • Copyrights
    • Known Issues & Future Development
    • Specification Feedback
    1. Index
    2. FHIR Artifacts
    3. Profiles
    4. AllergyIntolerance (CA-Core)

DFT-preBallot - The specification is a DFT-preBallot version of CA Core+ for collecting community feedback. For a full list of available versions, see the Directory of published versions

AllergyIntolerance (CA-Core)

Links

Profile

allergyintolerance-ca-core

Derived from

http://hl7.org/fhir/StructureDefinition/AllergyIntolerance

Examples

ExampleAllergyIntolerance

Description

This profile applies constraints to the AllergyIntolerance resource for CA Core+ to support the documentation of allergies and intolerances in the pan-Canadian context. It includes expectations for coded substances, reactions, and severity.

References to this resource

FamilyMemberHistoryCACore

CFMM: 2

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
AllergyIntoleranceCACore (AllergyIntolerance)CAllergyIntoleranceElement id
AllergyIntolerance
Short description

Allergy or Intolerance (generally: Risk of adverse reaction to a substance)

Alternate names

Allergy, Intolerance, Adverse Reaction

Definition

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Comments

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

Data type

AllergyIntolerance

Constraints
  • ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
  • ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: Observation[classCode=OBS, moodCode=EVN]
  • CACDI: Patient Allergy-Intolerance
idΣ0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
AllergyIntolerance.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
AllergyIntolerance.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
AllergyIntolerance.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
AllergyIntolerance.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*ExtensionElement id
AllergyIntolerance.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
abatementC0..1Extension(dateTimeAgePeriodRangestring)Element id
AllergyIntolerance.extension:abatement
Short description

When the allergy or intolerance resolved

Alternate names

extensions, user content

Definition

The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.

Comments

Age is generally used when the patient reports an age at which the allergy or intolerance abated. If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.

Data type

Extension(dateTimeAgePeriodRangestring)

Extension URL

http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
AllergyIntolerance.identifier
Short description

External ids for this item

Definition

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: IAM-7
  • rim: id
clinicalStatusΣ ?! C0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.clinicalStatus
Short description

active | inactive | resolved

Definition

The clinical status of the allergy or intolerance.

Comments

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

CodeableConcept

Binding

The clinical status of the allergy or intolerance.

AllergyIntoleranceClinicalStatusCodes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ait-1, ait-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
verificationStatusΣ ?! C0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.verificationStatus
Short description

unconfirmed | confirmed | refuted | entered-in-error

Definition

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

Comments

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

CodeableConcept

Binding

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

AllergyIntoleranceVerificationStatusCodes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ait-1, ait-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
typeΣ0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.type
Short description

allergy | intolerance - Underlying mechanism (if known)

Alternate names

Category, Class

Definition

Identification of the underlying physiological mechanism for the reaction risk.

Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

Data type

code

Binding

Identification of the underlying physiological mechanism for a Reaction Risk.

AllergyIntoleranceType (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: IAM-9
  • rim: code
categoryΣ0..*codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.category
Short description

food | medication | environment | biologic

Alternate names

Category, Type, Reaction Type, Class

Definition

Category of the identified substance.

Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

Data type

code

Binding

Category of an identified substance associated with allergies or intolerances.

AllergyIntoleranceCategory (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: AL1-2
  • rim: value < IntoleranceValue (Agent)
criticalityΣ0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.criticality
Short description

low | high | unable-to-assess

Alternate names

Severity, Seriousness, Contra-indication, Risk

Definition

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

Comments

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

Data type

code

Binding

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

AllergyIntoleranceCriticality (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.grade
  • v2: AL1-4
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
codeO Σ0..1CodeableConceptCACoreBindingElement id
AllergyIntolerance.code
Short description

Concept - reference to a terminology or just text

Alternate names

Code

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

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.

Data type

CodeableConceptCACore

Binding

Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

PharmaceuticalBiologicProductAndSubstanceCode (preferred)

Additional bindings
  • PrescriptionMedicinalProduct (candidate)

    Canadian Clinical Drug Data Set CCDD

  • CodeICD10CA (candidate)

    International Classifications of Disease ICD 10 CA Codes

  • LicensedNaturalHealthProducts (candidate)

    ValusSet of Licensed Natural Health Products

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • v2: AL1-3 / IAM-3
  • rim: substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • CACDI: Patient Allergy or Intolerance.Allergy or Intolerance Code
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
patientΣ1..1Reference(PatientCACore)Element id
AllergyIntolerance.patient
Short description

Who the sensitivity is for

Alternate names

Patient

Definition

The patient who has the allergy or intolerance.

Data type

Reference(PatientCACore)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • v2: (PID-3)
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: FiveWs.subject
  • CACDI: Patient
encounter0..1Reference(EncounterCACore)Element id
AllergyIntolerance.encounter
Short description

Encounter when the allergy or intolerance was asserted

Definition

The encounter when the allergy or intolerance was asserted.

Data type

Reference(EncounterCACore)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.context
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
onset[x]0..1Element id
AllergyIntolerance.onset[x]
Short description

When allergy or intolerance was identified

Definition

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

Slicing

Unordered, Open, by $this(Type)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • rim: effectiveTime.low
onsetAgeAge
There are no (further) constraints on this element
Data type

Age

onsetPeriodPeriod
There are no (further) constraints on this element
Data type

Period

onsetRangeRange
There are no (further) constraints on this element
Data type

Range

onsetStringstring
There are no (further) constraints on this element
Data type

string

onsetDateTime0..1dateTimeElement id
AllergyIntolerance.onset[x]:onsetDateTime
Short description

When allergy or intolerance was identified

Definition

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • rim: effectiveTime.low
recordedDate0..1dateTimeElement id
AllergyIntolerance.recordedDate
Short description

Date first version of the resource instance was recorded

Definition

The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • v2: IAM-13
  • rim: .participation[typeCode=AUT].time
  • CACDI: Health Care Service Event.Event Start Date Time
recorder0..1Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)Element id
AllergyIntolerance.recorder
Short description

Who recorded the sensitivity

Alternate names

Author

Definition

Individual who recorded the record and takes responsibility for its content.

Data type

Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.author
  • rim: .participation[typeCode=AUT].role
asserterΣ0..1Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)Element id
AllergyIntolerance.asserter
Short description

Source of the information about the allergy

Alternate names

Source, Informant

Definition

The source of the information about the allergy that is recorded.

Comments

The recorder takes responsibility for the content, but can reference the source from where they got it.

Data type

Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.source
  • v2: IAM-14 (if patient) / IAM-18 (if practitioner)
  • rim: .participation[typeCode=INF].role
lastOccurrence0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.lastOccurrence
Short description

Date(/time) of last known occurrence of a reaction

Definition

Represents the date and/or time of the last known occurrence of a reaction event.

Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime
note0..*Annotation
There are no (further) constraints on this element
Element id
AllergyIntolerance.note
Short description

Additional text not captured in other fields

Definition

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: subjectOf.observationEvent[code="annotation"].value
reactionO0..*BackboneElementElement id
AllergyIntolerance.reaction
Short description

Adverse Reaction Events linked to exposure to substance

Definition

Details about each adverse reaction event linked to exposure to the identified substance.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]
  • CACDI: Patient Allergy-Intolerance Reaction
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
substance0..1CodeableConcept
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.substance
Short description

Specific substance or pharmaceutical product considered to be responsible for event

Definition

Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

Comments

Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.

Data type

CodeableConcept

Binding

Codes defining the type of the substance (including pharmaceutical products).

SubstanceCode (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]
manifestationO1..*CodeableConceptCACoreBindingElement id
AllergyIntolerance.reaction.manifestation
Short description

Concept - reference to a terminology or just text

Alternate names

Symptoms, Signs

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

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.

Data type

CodeableConceptCACore

Binding

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

ClinicalFindingCode (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: AL1-5
  • rim: code
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • CACDI: Allergy or Intolerance Reaction Manifestation
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
codingO Σ0..*CodingCACoreElement id
AllergyIntolerance.reaction.manifestation.coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • CACDI: Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
textΣ0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.text
Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
description0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.description
Short description

Description of the event as a whole

Alternate names

Narrative, Text

Definition

Text description about the reaction as a whole, including details of the manifestation if required.

Comments

Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: text
onset0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.onset
Short description

Date(/time) when manifestations showed

Definition

Record of the date and/or time of the onset of the Reaction.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: AL1-6
  • rim: effectiveTime.low
severity0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.severity
Short description

mild | moderate | severe (of event as a whole)

Definition

Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

Comments

It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

Data type

code

Binding

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

AllergyIntoleranceSeverity (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
exposureRoute0..1CodeableConcept
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.exposureRoute
Short description

How the subject was exposed to the substance

Definition

Identification of the route by which the subject was exposed to the substance.

Comments

Coding of the route of exposure with a terminology should be used wherever possible.

Data type

CodeableConcept

Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode
note0..*Annotation
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.note
Short description

Text about event not captured in other fields

Definition

Additional text about the adverse reaction event not captured in other fields.

Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: subjectOf.observationEvent[code="annotation"].value
AllergyIntoleranceCACore (AllergyIntolerance)CAllergyIntolerance
There are no (further) constraints on this element
Element id
AllergyIntolerance
Short description

Allergy or Intolerance (generally: Risk of adverse reaction to a substance)

Alternate names

Allergy, Intolerance, Adverse Reaction

Definition

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Comments

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

Data type

AllergyIntolerance

Constraints
  • ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
  • ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: Observation[classCode=OBS, moodCode=EVN]
  • CACDI: Patient Allergy-Intolerance
idΣ0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
AllergyIntolerance.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
AllergyIntolerance.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
AllergyIntolerance.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
AllergyIntolerance.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
abatementC0..1Extension(dateTimeAgePeriodRangestring)
There are no (further) constraints on this element
Element id
AllergyIntolerance.extension:abatement
Short description

When the allergy or intolerance resolved

Alternate names

extensions, user content

Definition

The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.

Comments

Age is generally used when the patient reports an age at which the allergy or intolerance abated. If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.

Data type

Extension(dateTimeAgePeriodRangestring)

Extension URL

http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
AllergyIntolerance.identifier
Short description

External ids for this item

Definition

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: IAM-7
  • rim: id
clinicalStatusΣ ?! C0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.clinicalStatus
Short description

active | inactive | resolved

Definition

The clinical status of the allergy or intolerance.

Comments

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

CodeableConcept

Binding

The clinical status of the allergy or intolerance.

AllergyIntoleranceClinicalStatusCodes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ait-1, ait-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
verificationStatusΣ ?! C0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.verificationStatus
Short description

unconfirmed | confirmed | refuted | entered-in-error

Definition

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

Comments

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

Data type

CodeableConcept

Binding

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

AllergyIntoleranceVerificationStatusCodes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ait-1, ait-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
typeΣ0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.type
Short description

allergy | intolerance - Underlying mechanism (if known)

Alternate names

Category, Class

Definition

Identification of the underlying physiological mechanism for the reaction risk.

Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

Data type

code

Binding

Identification of the underlying physiological mechanism for a Reaction Risk.

AllergyIntoleranceType (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: IAM-9
  • rim: code
categoryΣ0..*codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.category
Short description

food | medication | environment | biologic

Alternate names

Category, Type, Reaction Type, Class

Definition

Category of the identified substance.

Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

Data type

code

Binding

Category of an identified substance associated with allergies or intolerances.

AllergyIntoleranceCategory (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: AL1-2
  • rim: value < IntoleranceValue (Agent)
criticalityΣ0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.criticality
Short description

low | high | unable-to-assess

Alternate names

Severity, Seriousness, Contra-indication, Risk

Definition

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

Comments

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

Data type

code

Binding

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

AllergyIntoleranceCriticality (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.grade
  • v2: AL1-4
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
codeO Σ0..1CodeableConceptCACoreBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.code
Short description

Concept - reference to a terminology or just text

Alternate names

Code

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

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.

Data type

CodeableConceptCACore

Binding

Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

PharmaceuticalBiologicProductAndSubstanceCode (preferred)

Additional bindings
  • PrescriptionMedicinalProduct (candidate)

    Canadian Clinical Drug Data Set CCDD

  • CodeICD10CA (candidate)

    International Classifications of Disease ICD 10 CA Codes

  • LicensedNaturalHealthProducts (candidate)

    ValusSet of Licensed Natural Health Products

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • v2: AL1-3 / IAM-3
  • rim: substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • CACDI: Patient Allergy or Intolerance.Allergy or Intolerance Code
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
patientΣ1..1Reference(PatientCACore)
There are no (further) constraints on this element
Element id
AllergyIntolerance.patient
Short description

Who the sensitivity is for

Alternate names

Patient

Definition

The patient who has the allergy or intolerance.

Data type

Reference(PatientCACore)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.subject[x]
  • v2: (PID-3)
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: FiveWs.subject
  • CACDI: Patient
encounter0..1Reference(EncounterCACore)
There are no (further) constraints on this element
Element id
AllergyIntolerance.encounter
Short description

Encounter when the allergy or intolerance was asserted

Definition

The encounter when the allergy or intolerance was asserted.

Data type

Reference(EncounterCACore)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.context
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
onset[x]0..1
There are no (further) constraints on this element
Element id
AllergyIntolerance.onset[x]
Short description

When allergy or intolerance was identified

Definition

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

Slicing

Unordered, Open, by $this(Type)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • rim: effectiveTime.low
onsetAgeAge
There are no (further) constraints on this element
Data type

Age

onsetPeriodPeriod
There are no (further) constraints on this element
Data type

Period

onsetRangeRange
There are no (further) constraints on this element
Data type

Range

onsetStringstring
There are no (further) constraints on this element
Data type

string

onsetDateTime0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.onset[x]:onsetDateTime
Short description

When allergy or intolerance was identified

Definition

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • rim: effectiveTime.low
recordedDate0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.recordedDate
Short description

Date first version of the resource instance was recorded

Definition

The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • v2: IAM-13
  • rim: .participation[typeCode=AUT].time
  • CACDI: Health Care Service Event.Event Start Date Time
recorder0..1Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)
There are no (further) constraints on this element
Element id
AllergyIntolerance.recorder
Short description

Who recorded the sensitivity

Alternate names

Author

Definition

Individual who recorded the record and takes responsibility for its content.

Data type

Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.author
  • rim: .participation[typeCode=AUT].role
asserterΣ0..1Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)
There are no (further) constraints on this element
Element id
AllergyIntolerance.asserter
Short description

Source of the information about the allergy

Alternate names

Source, Informant

Definition

The source of the information about the allergy that is recorded.

Comments

The recorder takes responsibility for the content, but can reference the source from where they got it.

Data type

Reference(PractitionerCACore | PractitionerRoleCACore | PatientCACore | RelatedPerson)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.source
  • v2: IAM-14 (if patient) / IAM-18 (if practitioner)
  • rim: .participation[typeCode=INF].role
lastOccurrence0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.lastOccurrence
Short description

Date(/time) of last known occurrence of a reaction

Definition

Represents the date and/or time of the last known occurrence of a reaction event.

Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime
note0..*Annotation
There are no (further) constraints on this element
Element id
AllergyIntolerance.note
Short description

Additional text not captured in other fields

Definition

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: subjectOf.observationEvent[code="annotation"].value
reactionO0..*BackboneElement
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction
Short description

Adverse Reaction Events linked to exposure to substance

Definition

Details about each adverse reaction event linked to exposure to the identified substance.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]
  • CACDI: Patient Allergy-Intolerance Reaction
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
substance0..1CodeableConcept
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.substance
Short description

Specific substance or pharmaceutical product considered to be responsible for event

Definition

Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

Comments

Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.

Data type

CodeableConcept

Binding

Codes defining the type of the substance (including pharmaceutical products).

SubstanceCode (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]
manifestationO1..*CodeableConceptCACoreBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation
Short description

Concept - reference to a terminology or just text

Alternate names

Symptoms, Signs

Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Comments

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.

Data type

CodeableConceptCACore

Binding

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

ClinicalFindingCode (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: AL1-5
  • rim: code
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • CACDI: Allergy or Intolerance Reaction Manifestation
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
codingO Σ0..*CodingCACore
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • CACDI: Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
textΣ0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.manifestation.text
Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
description0..1string
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.description
Short description

Description of the event as a whole

Alternate names

Narrative, Text

Definition

Text description about the reaction as a whole, including details of the manifestation if required.

Comments

Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: text
onset0..1dateTime
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.onset
Short description

Date(/time) when manifestations showed

Definition

Record of the date and/or time of the onset of the Reaction.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: AL1-6
  • rim: effectiveTime.low
severity0..1codeBinding
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.severity
Short description

mild | moderate | severe (of event as a whole)

Definition

Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

Comments

It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

Data type

code

Binding

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

AllergyIntoleranceSeverity (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
exposureRoute0..1CodeableConcept
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.exposureRoute
Short description

How the subject was exposed to the substance

Definition

Identification of the route by which the subject was exposed to the substance.

Comments

Coding of the route of exposure with a terminology should be used wherever possible.

Data type

CodeableConcept

Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode
note0..*Annotation
There are no (further) constraints on this element
Element id
AllergyIntolerance.reaction.note
Short description

Text about event not captured in other fields

Definition

Additional text about the adverse reaction event not captured in other fields.

Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: subjectOf.observationEvent[code="annotation"].value
{{ren
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="allergyintolerance-ca-core" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2" />
</extension>
<url value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/allergyintolerance-ca-core" />
<version value="1.1.0" />
<name value="AllergyIntoleranceCACore" />
<title value="AllergyIntolerance (CA-Core)" />
<status value="active" />
<experimental value="false" />
<date value="2025-03-31" />
<publisher value="Canada Health Infoway" />
<contact>
<name value="National Standards Release Centre" />
<telecom>
<system value="url" />
<value value="http://www.infoway-inforoute.ca" />
</telecom>
<telecom>
<system value="email" />
<value value="standards@infoway-inforoute.ca" />
</telecom>
</contact>
<description value="This profile applies constraints to the AllergyIntolerance resource for CA Core+ to support the documentation of allergies and intolerances in the pan-Canadian context. It includes expectations for coded substances, reactions, and severity." />
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166" />
<code value="CA" />
</coding>
</jurisdiction>
<copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="CACDI" />
<name value="Canadian Core Data for Interoperability (CACDI)" />
<comment value="Mapping for AllergyIntoleranceCACore to Canadian Core Data for Interoperability (CACDI)." />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="AllergyIntolerance" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" />
<derivation value="constraint" />
<snapshot>
<element id="AllergyIntolerance">
<path value="AllergyIntolerance" />
<short value="Allergy or Intolerance (generally: Risk of adverse reaction to a substance)" />
<definition value="Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance." />
<comment value="Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings." />
<alias value="Allergy" />
<alias value="Intolerance" />
<alias value="Adverse Reaction" />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance" />
<min value="0" />
<max value="*" />
</base>
<constraint>
<key value="ait-1" />
<severity value="error" />
<human value="AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error." />
<expression value="verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()" />
<xpath value="f:verificationStatus/f:coding/f:code/@value='entered-in-error' or exists(f:clinicalStatus)" />
</constraint>
<constraint>
<key value="ait-2" />
<severity value="error" />
<human value="AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error" />
<expression value="verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()" />
<xpath value="not(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(f:clinicalStatus))" />
</constraint>
<constraint>
<key value="dom-2" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
<expression value="contained.contained.empty()" />
<xpath value="not(parent::f:contained and f:contained)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-3" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" />
<expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-4" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-5" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
<expression value="contained.meta.security.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:security))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
<key value="dom-6" />
<severity value="warning" />
<human value="A resource should have narrative for robust management" />
<expression value="text.`div`.exists()" />
<xpath value="exists(f:text/h:div)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Observation[classCode=OBS, moodCode=EVN]" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy-Intolerance" />
</mapping>
</element>
<element id="AllergyIntolerance.id">
<path value="AllergyIntolerance.id" />
<short value="Logical id of this artifact" />
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="AllergyIntolerance.meta">
<path value="AllergyIntolerance.meta" />
<short value="Metadata about the resource" />
<definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.meta" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Meta" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="AllergyIntolerance.implicitRules">
<path value="AllergyIntolerance.implicitRules" />
<short value="A set of rules under which this content was created" />
<definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
<comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.implicitRules" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
<isSummary value="true" />
</element>
<element id="AllergyIntolerance.language">
<path value="AllergyIntolerance.language" />
<short value="Language of the resource content" />
<definition value="The base language in which the resource is written." />
<comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.language" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages" />
</binding>
</element>
<element id="AllergyIntolerance.text">
<path value="AllergyIntolerance.text" />
<short value="Text summary of the resource, for human interpretation" />
<definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." />
<comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." />
<alias value="narrative" />
<alias value="html" />
<alias value="xhtml" />
<alias value="display" />
<min value="0" />
<max value="1" />
<base>
<path value="DomainResource.text" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Narrative" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="Act.text?" />
</mapping>
</element>
<element id="AllergyIntolerance.contained">
<path value="AllergyIntolerance.contained" />
<short value="Contained, inline Resources" />
<definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." />
<comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." />
<alias value="inline resources" />
<alias value="anonymous resources" />
<alias value="contained resources" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.contained" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Resource" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="AllergyIntolerance.extension">
<path value="AllergyIntolerance.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="AllergyIntolerance.extension:abatement">
<path value="AllergyIntolerance.extension" />
<sliceName value="abatement" />
<short value="When the allergy or intolerance resolved" />
<definition value="The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution." />
<comment value="Age is generally used when the patient reports an age at which the allergy or intolerance abated. If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="1" />
<base>
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="AllergyIntolerance.modifierExtension">
<path value="AllergyIntolerance.modifierExtension" />
<short value="Extensions that cannot be ignored" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="AllergyIntolerance.identifier">
<path value="AllergyIntolerance.identifier" />
<short value="External ids for this item" />
<definition value="Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server." />
<comment value="This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number." />
<requirements value="Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers." />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance.identifier" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Identifier" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<mapping>
<identity value="v2" />
<map value="IAM-7" />
</mapping>
<mapping>
<identity value="rim" />
<map value="id" />
</mapping>
</element>
<element id="AllergyIntolerance.clinicalStatus">
<path value="AllergyIntolerance.clinicalStatus" />
<short value="active | inactive | resolved" />
<definition value="The clinical status of the allergy or intolerance." />
<comment value="Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.clinicalStatus" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ait-1" />
<condition value="ait-2" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceClinicalStatus" />
</extension>
<strength value="required" />
<description value="The clinical status of the allergy or intolerance." />
<valueSet value="http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value" />
</mapping>
</element>
<element id="AllergyIntolerance.verificationStatus">
<path value="AllergyIntolerance.verificationStatus" />
<short value="unconfirmed | confirmed | refuted | entered-in-error" />
<definition value="Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)." />
<comment value="The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.verificationStatus" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ait-1" />
<condition value="ait-2" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceVerificationStatus" />
</extension>
<strength value="required" />
<description value="Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance." />
<valueSet value="http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value" />
</mapping>
</element>
<element id="AllergyIntolerance.type">
<path value="AllergyIntolerance.type" />
<short value="allergy | intolerance - Underlying mechanism (if known)" />
<definition value="Identification of the underlying physiological mechanism for the reaction risk." />
<comment value="Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource." />
<alias value="Category" />
<alias value="Class" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceType" />
</extension>
<strength value="required" />
<description value="Identification of the underlying physiological mechanism for a Reaction Risk." />
<valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<mapping>
<identity value="v2" />
<map value="IAM-9" />
</mapping>
<mapping>
<identity value="rim" />
<map value="code" />
</mapping>
</element>
<element id="AllergyIntolerance.category">
<path value="AllergyIntolerance.category" />
<short value="food | medication | environment | biologic" />
<definition value="Category of the identified substance." />
<comment value="This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender." />
<alias value="Category" />
<alias value="Type" />
<alias value="Reaction Type" />
<alias value="Class" />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance.category" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceCategory" />
</extension>
<strength value="required" />
<description value="Category of an identified substance associated with allergies or intolerances." />
<valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<mapping>
<identity value="v2" />
<map value="AL1-2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="value < IntoleranceValue (Agent)" />
</mapping>
</element>
<element id="AllergyIntolerance.criticality">
<path value="AllergyIntolerance.criticality" />
<short value="low | high | unable-to-assess" />
<definition value="Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance." />
<comment value="The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent." />
<alias value="Severity" />
<alias value="Seriousness" />
<alias value="Contra-indication" />
<alias value="Risk" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.criticality" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceCriticality" />
</extension>
<strength value="required" />
<description value="Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance." />
<valueSet value="http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.grade" />
</mapping>
<mapping>
<identity value="v2" />
<map value="AL1-4" />
</mapping>
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" />
</mapping>
</element>
<element id="AllergyIntolerance.code">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.code" />
<short value="Concept - reference to a terminology or just text" />
<definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text." />
<comment value="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." />
<alias value="Code" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.code" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceCode" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct" />
</extension>
<extension url="documentation">
<valueMarkdown value="Canadian Clinical Drug Data Set CCDD" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/ICD10CA" />
</extension>
<extension url="documentation">
<valueMarkdown value="International Classifications of Disease ICD 10 CA Codes" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts" />
</extension>
<extension url="documentation">
<valueMarkdown value="ValusSet of Licensed Natural Health Products" />
</extension>
</extension>
<strength value="preferred" />
<description value="Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies." />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode" />
</binding>
<mapping>
<identity value="w5" />
<map value="FiveWs.what[x]" />
</mapping>
<mapping>
<identity value="v2" />
<map value="AL1-3 / IAM-3" />
</mapping>
<mapping>
<identity value="rim" />
<map value="substance/product:\n\n.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\nnegated/excluded substance/product:\n\n.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\npositive or negated/excluded condition/situation:\n\nObservation.code=ASSERTION; Observation.value" />
</mapping>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy or Intolerance.Allergy or Intolerance Code" />
</mapping>
</element>
<element id="AllergyIntolerance.patient">
<path value="AllergyIntolerance.patient" />
<short value="Who the sensitivity is for" />
<definition value="The patient who has the allergy or intolerance." />
<alias value="Patient" />
<min value="1" />
<max value="1" />
<base>
<path value="AllergyIntolerance.patient" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="w5" />
<map value="FiveWs.subject[x]" />
</mapping>
<mapping>
<identity value="v2" />
<map value="(PID-3)" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode=SBJ].role[classCode=PAT]" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.subject" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Patient" />
</mapping>
</element>
<element id="AllergyIntolerance.encounter">
<path value="AllergyIntolerance.encounter" />
<short value="Encounter when the allergy or intolerance was asserted" />
<definition value="The encounter when the allergy or intolerance was asserted." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.encounter" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/encounter-ca-core" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="w5" />
<map value="FiveWs.context" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" />
</mapping>
</element>
<element id="AllergyIntolerance.onset[x]">
<path value="AllergyIntolerance.onset[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<short value="When allergy or intolerance was identified" />
<definition value="Estimated or actual date, date-time, or age when allergy or intolerance was identified." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.onset[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<type>
<code value="Age" />
</type>
<type>
<code value="Period" />
</type>
<type>
<code value="Range" />
</type>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="w5" />
<map value="FiveWs.init" />
</mapping>
<mapping>
<identity value="rim" />
<map value="effectiveTime.low" />
</mapping>
</element>
<element id="AllergyIntolerance.onset[x]:onsetDateTime">
<path value="AllergyIntolerance.onset[x]" />
<sliceName value="onsetDateTime" />
<short value="When allergy or intolerance was identified" />
<definition value="Estimated or actual date, date-time, or age when allergy or intolerance was identified." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.onset[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="w5" />
<map value="FiveWs.init" />
</mapping>
<mapping>
<identity value="rim" />
<map value="effectiveTime.low" />
</mapping>
</element>
<element id="AllergyIntolerance.recordedDate">
<path value="AllergyIntolerance.recordedDate" />
<short value="Date first version of the resource instance was recorded" />
<definition value="The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.recordedDate" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="w5" />
<map value="FiveWs.recorded" />
</mapping>
<mapping>
<identity value="v2" />
<map value="IAM-13" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode=AUT].time" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Health Care Service Event.Event Start Date Time" />
</mapping>
</element>
<element id="AllergyIntolerance.recorder">
<path value="AllergyIntolerance.recorder" />
<short value="Who recorded the sensitivity" />
<definition value="Individual who recorded the record and takes responsibility for its content." />
<alias value="Author" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.recorder" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="w5" />
<map value="FiveWs.author" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode=AUT].role" />
</mapping>
</element>
<element id="AllergyIntolerance.asserter">
<path value="AllergyIntolerance.asserter" />
<short value="Source of the information about the allergy" />
<definition value="The source of the information about the allergy that is recorded." />
<comment value="The recorder takes responsibility for the content, but can reference the source from where they got it." />
<alias value="Source" />
<alias value="Informant" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.asserter" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="w5" />
<map value="FiveWs.source" />
</mapping>
<mapping>
<identity value="v2" />
<map value="IAM-14 (if patient) / IAM-18 (if practitioner)" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode=INF].role" />
</mapping>
</element>
<element id="AllergyIntolerance.lastOccurrence">
<path value="AllergyIntolerance.lastOccurrence" />
<short value="Date(/time) of last known occurrence of a reaction" />
<definition value="Represents the date and/or time of the last known occurrence of a reaction event." />
<comment value="This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.lastOccurrence" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime" />
</mapping>
</element>
<element id="AllergyIntolerance.note">
<path value="AllergyIntolerance.note" />
<short value="Additional text not captured in other fields" />
<definition value="Additional narrative about the propensity for the Adverse Reaction, not captured in other fields." />
<comment value="For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes." />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance.note" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Annotation" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="subjectOf.observationEvent[code="annotation"].value" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction" />
<short value="Adverse Reaction Events linked to exposure to substance" />
<definition value="Details about each adverse reaction event linked to exposure to the identified substance." />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance.reaction" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="BackboneElement" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy-Intolerance Reaction" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.id">
<path value="AllergyIntolerance.reaction.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.extension">
<path value="AllergyIntolerance.reaction.extension" />
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.modifierExtension">
<path value="AllergyIntolerance.reaction.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<base>
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.substance">
<path value="AllergyIntolerance.reaction.substance" />
<short value="Specific substance or pharmaceutical product considered to be responsible for event" />
<definition value="Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance." />
<comment value="Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.reaction.substance" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="SubstanceCode" />
</extension>
<strength value="example" />
<description value="Codes defining the type of the substance (including pharmaceutical products)." />
<valueSet value="http://hl7.org/fhir/ValueSet/substance-code" />
</binding>
<mapping>
<identity value="rim" />
<map value="outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction.manifestation" />
<short value="Concept - reference to a terminology or just text" />
<definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text." />
<comment value="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." />
<alias value="Symptoms" />
<alias value="Signs" />
<min value="1" />
<max value="*" />
<base>
<path value="AllergyIntolerance.reaction.manifestation" />
<min value="1" />
<max value="*" />
</base>
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Manifestation" />
</extension>
<strength value="preferred" />
<description value="Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event." />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode" />
</binding>
<mapping>
<identity value="v2" />
<map value="AL1-5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="code" />
</mapping>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Allergy or Intolerance Reaction Manifestation" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation.id">
<path value="AllergyIntolerance.reaction.manifestation.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation.extension">
<path value="AllergyIntolerance.reaction.manifestation.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation.coding">
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="normative" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
<valueCode value="4.0.0" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction.manifestation.coding" />
<short value="A reference to a code defined by a terminology system" />
<definition value="A reference to a code defined by a terminology system." />
<comment value="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." />
<requirements value="Allows for alternative encodings within a code system, and translations to other code systems." />
<min value="0" />
<max value="*" />
<base>
<path value="CodeableConcept.coding" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Coding" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="C*E.1-8, C*E.10-22" />
</mapping>
<mapping>
<identity value="rim" />
<map value="union(., ./translation)" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" />
</mapping>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CV" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding rdfs:subClassOf dt:CDCoding" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation.text">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="AllergyIntolerance.reaction.manifestation.text" />
<short value="Plain text representation of the concept" />
<definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." />
<comment value="Very often the text is the same as a displayName of one of the codings." />
<requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source." />
<min value="0" />
<max value="1" />
<base>
<path value="CodeableConcept.text" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="C*E.9. But note many systems use C*E.2 for this" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./originalText[mediaType/code="text/plain"]/data" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.description">
<path value="AllergyIntolerance.reaction.description" />
<short value="Description of the event as a whole" />
<definition value="Text description about the reaction as a whole, including details of the manifestation if required." />
<comment value="Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives." />
<alias value="Narrative" />
<alias value="Text" />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.reaction.description" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="text" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.onset">
<path value="AllergyIntolerance.reaction.onset" />
<short value="Date(/time) when manifestations showed" />
<definition value="Record of the date and/or time of the onset of the Reaction." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.reaction.onset" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="v2" />
<map value="AL1-6" />
</mapping>
<mapping>
<identity value="rim" />
<map value="effectiveTime.low" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.severity">
<path value="AllergyIntolerance.reaction.severity" />
<short value="mild | moderate | severe (of event as a whole)" />
<definition value="Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations." />
<comment value="It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.reaction.severity" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AllergyIntoleranceSeverity" />
</extension>
<strength value="required" />
<description value="Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations." />
<valueSet value="http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.exposureRoute">
<path value="AllergyIntolerance.reaction.exposureRoute" />
<short value="How the subject was exposed to the substance" />
<definition value="Identification of the route by which the subject was exposed to the substance." />
<comment value="Coding of the route of exposure with a terminology should be used wherever possible." />
<min value="0" />
<max value="1" />
<base>
<path value="AllergyIntolerance.reaction.exposureRoute" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="RouteOfAdministration" />
</extension>
<strength value="example" />
<description value="A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject." />
<valueSet value="http://hl7.org/fhir/ValueSet/route-codes" />
</binding>
<mapping>
<identity value="rim" />
<map value="outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.note">
<path value="AllergyIntolerance.reaction.note" />
<short value="Text about event not captured in other fields" />
<definition value="Additional text about the adverse reaction event not captured in other fields." />
<comment value="Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased." />
<min value="0" />
<max value="*" />
<base>
<path value="AllergyIntolerance.reaction.note" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Annotation" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="subjectOf.observationEvent[code="annotation"].value" />
</mapping>
</element>
</snapshot>
<differential>
<element id="AllergyIntolerance">
<path value="AllergyIntolerance" />
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy-Intolerance" />
</mapping>
</element>
<element id="AllergyIntolerance.extension">
<path value="AllergyIntolerance.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="AllergyIntolerance.extension:abatement">
<path value="AllergyIntolerance.extension" />
<sliceName value="abatement" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement" />
</type>
</element>
<element id="AllergyIntolerance.code">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.code" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<binding>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct" />
</extension>
<extension url="documentation">
<valueMarkdown value="Canadian Clinical Drug Data Set CCDD" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/ICD10CA" />
</extension>
<extension url="documentation">
<valueMarkdown value="International Classifications of Disease ICD 10 CA Codes" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts" />
</extension>
<extension url="documentation">
<valueMarkdown value="ValusSet of Licensed Natural Health Products" />
</extension>
</extension>
<strength value="preferred" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode" />
</binding>
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy or Intolerance.Allergy or Intolerance Code" />
</mapping>
</element>
<element id="AllergyIntolerance.patient">
<path value="AllergyIntolerance.patient" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
</type>
<mapping>
<identity value="CACDI" />
<map value="Patient" />
</mapping>
</element>
<element id="AllergyIntolerance.encounter">
<path value="AllergyIntolerance.encounter" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/encounter-ca-core" />
</type>
</element>
<element id="AllergyIntolerance.onset[x]">
<path value="AllergyIntolerance.onset[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="AllergyIntolerance.onset[x]:onsetDateTime">
<path value="AllergyIntolerance.onset[x]" />
<sliceName value="onsetDateTime" />
<min value="0" />
<max value="1" />
<type>
<code value="dateTime" />
</type>
</element>
<element id="AllergyIntolerance.recordedDate">
<path value="AllergyIntolerance.recordedDate" />
<mapping>
<identity value="CACDI" />
<map value="Health Care Service Event.Event Start Date Time" />
</mapping>
</element>
<element id="AllergyIntolerance.recorder">
<path value="AllergyIntolerance.recorder" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
</element>
<element id="AllergyIntolerance.asserter">
<path value="AllergyIntolerance.asserter" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
</element>
<element id="AllergyIntolerance.reaction">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction" />
<mapping>
<identity value="CACDI" />
<map value="Patient Allergy-Intolerance Reaction" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction.manifestation" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<binding>
<strength value="preferred" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode" />
</binding>
<mapping>
<identity value="CACDI" />
<map value="Allergy or Intolerance Reaction Manifestation" />
</mapping>
</element>
<element id="AllergyIntolerance.reaction.manifestation.coding">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="AllergyIntolerance.reaction.manifestation.coding" />
<mapping>
<identity value="CACDI" />
<map value="Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code" />
</mapping>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "allergyintolerance-ca-core",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}
],
"url": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/allergyintolerance-ca-core",
"version": "1.1.0",
"name": "AllergyIntoleranceCACore",
"title": "AllergyIntolerance (CA-Core)",
"status": "active",
"experimental": false,
"date": "2025-03-31",
"publisher": "Canada Health Infoway",
"contact": [
{
"name": "National Standards Release Centre",
"telecom": [
{
"system": "url",
"value": "http://www.infoway-inforoute.ca"
},
{
"system": "email",
"value": "standards@infoway-inforoute.ca"
}
]
}
],
"description": "This profile applies constraints to the AllergyIntolerance resource for CA Core+ to support the documentation of allergies and intolerances in the pan-Canadian context. It includes expectations for coded substances, reactions, and severity.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA"
}
]
}
],
"copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "CACDI",
"name": "Canadian Core Data for Interoperability (CACDI)",
"comment": "Mapping for AllergyIntoleranceCACore to Canadian Core Data for Interoperability (CACDI)."
}
],
"kind": "resource",
"abstract": false,
"type": "AllergyIntolerance",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "AllergyIntolerance",
"path": "AllergyIntolerance",
"short": "Allergy or Intolerance (generally: Risk of adverse reaction to a substance)",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comment": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"alias": [
"Allergy",
"Intolerance",
"Adverse Reaction"
],
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ait-1",
"severity": "error",
"human": "AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.",
"expression": "verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()",
"xpath": "f:verificationStatus/f:coding/f:code/@value='entered-in-error' or exists(f:clinicalStatus)"
},
{
"key": "ait-2",
"severity": "error",
"human": "AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error",
"expression": "verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()",
"xpath": "not(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(f:clinicalStatus))"
},
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "CACDI",
"map": "Patient Allergy-Intolerance"
}
]
},
{
"id": "AllergyIntolerance.id",
"path": "AllergyIntolerance.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "AllergyIntolerance.meta",
"path": "AllergyIntolerance.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "AllergyIntolerance.implicitRules",
"path": "AllergyIntolerance.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "AllergyIntolerance.language",
"path": "AllergyIntolerance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "AllergyIntolerance.text",
"path": "AllergyIntolerance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "AllergyIntolerance.contained",
"path": "AllergyIntolerance.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AllergyIntolerance.extension",
"path": "AllergyIntolerance.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AllergyIntolerance.extension:abatement",
"path": "AllergyIntolerance.extension",
"sliceName": "abatement",
"short": "When the allergy or intolerance resolved",
"definition": "The date or estimated date that the allergy or intolerance resolved. This is called abatement because of the many overloaded connotations associated with resolution.",
"comment": "Age is generally used when the patient reports an age at which the allergy or intolerance abated. If there is no abatement element, the clinicalStatus can be used to convey whether allergy or intolerance has resolved or not. When abatementString exists, it conveys that the allergy or intolerance is abated.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AllergyIntolerance.modifierExtension",
"path": "AllergyIntolerance.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AllergyIntolerance.identifier",
"path": "AllergyIntolerance.identifier",
"short": "External ids for this item",
"definition": "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements": "Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "IAM-7"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"id": "AllergyIntolerance.clinicalStatus",
"path": "AllergyIntolerance.clinicalStatus",
"short": "active | inactive | resolved",
"definition": "The clinical status of the allergy or intolerance.",
"comment": "Refer to [discussion](extensibility.html#Special-Case) if clincalStatus is missing data.\nThe data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.clinicalStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ait-1",
"ait-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceClinicalStatus"
}
],
"strength": "required",
"description": "The clinical status of the allergy or intolerance.",
"valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value"
}
]
},
{
"id": "AllergyIntolerance.verificationStatus",
"path": "AllergyIntolerance.verificationStatus",
"short": "unconfirmed | confirmed | refuted | entered-in-error",
"definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).",
"comment": "The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.verificationStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ait-1",
"ait-2"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceVerificationStatus"
}
],
"strength": "required",
"description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.",
"valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": "Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value"
}
]
},
{
"id": "AllergyIntolerance.type",
"path": "AllergyIntolerance.type",
"short": "allergy | intolerance - Underlying mechanism (if known)",
"definition": "Identification of the underlying physiological mechanism for the reaction risk.",
"comment": "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.",
"alias": [
"Category",
"Class"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceType"
}
],
"strength": "required",
"description": "Identification of the underlying physiological mechanism for a Reaction Risk.",
"valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "v2",
"map": "IAM-9"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"id": "AllergyIntolerance.category",
"path": "AllergyIntolerance.category",
"short": "food | medication | environment | biologic",
"definition": "Category of the identified substance.",
"comment": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to [search](search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.",
"alias": [
"Category",
"Type",
"Reaction Type",
"Class"
],
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceCategory"
}
],
"strength": "required",
"description": "Category of an identified substance associated with allergies or intolerances.",
"valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "v2",
"map": "AL1-2"
},
{
"identity": "rim",
"map": "value < IntoleranceValue (Agent)"
}
]
},
{
"id": "AllergyIntolerance.criticality",
"path": "AllergyIntolerance.criticality",
"short": "low | high | unable-to-assess",
"definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.",
"comment": "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term \"severity\" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.",
"alias": [
"Severity",
"Seriousness",
"Contra-indication",
"Risk"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.criticality",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceCriticality"
}
],
"strength": "required",
"description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.",
"valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.grade"
},
{
"identity": "v2",
"map": "AL1-4"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}
]
},
{
"id": "AllergyIntolerance.code",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"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.",
"alias": [
"Code"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceCode"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
},
{
"url": "documentation",
"valueMarkdown": "Canadian Clinical Drug Data Set CCDD"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/ICD10CA"
},
{
"url": "documentation",
"valueMarkdown": "International Classifications of Disease ICD 10 CA Codes"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts"
},
{
"url": "documentation",
"valueMarkdown": "ValusSet of Licensed Natural Health Products"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"description": "Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "AL1-3 / IAM-3"
},
{
"identity": "rim",
"map": "substance/product:\n\n.participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\nnegated/excluded substance/product:\n\n.participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]\n\npositive or negated/excluded condition/situation:\n\nObservation.code=ASSERTION; Observation.value"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "CACDI",
"map": "Patient Allergy or Intolerance.Allergy or Intolerance Code"
}
]
},
{
"id": "AllergyIntolerance.patient",
"path": "AllergyIntolerance.patient",
"short": "Who the sensitivity is for",
"definition": "The patient who has the allergy or intolerance.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"base": {
"path": "AllergyIntolerance.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "(PID-3)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
},
{
"identity": "CACDI",
"map": "Patient"
}
]
},
{
"id": "AllergyIntolerance.encounter",
"path": "AllergyIntolerance.encounter",
"short": "Encounter when the allergy or intolerance was asserted",
"definition": "The encounter when the allergy or intolerance was asserted.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/encounter-ca-core"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"id": "AllergyIntolerance.onset[x]",
"path": "AllergyIntolerance.onset[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"short": "When allergy or intolerance was identified",
"definition": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.onset[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
},
{
"code": "Age"
},
{
"code": "Period"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"id": "AllergyIntolerance.onset[x]:onsetDateTime",
"path": "AllergyIntolerance.onset[x]",
"sliceName": "onsetDateTime",
"short": "When allergy or intolerance was identified",
"definition": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.onset[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"id": "AllergyIntolerance.recordedDate",
"path": "AllergyIntolerance.recordedDate",
"short": "Date first version of the resource instance was recorded",
"definition": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.recordedDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "v2",
"map": "IAM-13"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "CACDI",
"map": "Health Care Service Event.Event Start Date Time"
}
]
},
{
"id": "AllergyIntolerance.recorder",
"path": "AllergyIntolerance.recorder",
"short": "Who recorded the sensitivity",
"definition": "Individual who recorded the record and takes responsibility for its content.",
"alias": [
"Author"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.recorder",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"id": "AllergyIntolerance.asserter",
"path": "AllergyIntolerance.asserter",
"short": "Source of the information about the allergy",
"definition": "The source of the information about the allergy that is recorded.",
"comment": "The recorder takes responsibility for the content, but can reference the source from where they got it.",
"alias": [
"Source",
"Informant"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.asserter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.source"
},
{
"identity": "v2",
"map": "IAM-14 (if patient) / IAM-18 (if practitioner)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
}
]
},
{
"id": "AllergyIntolerance.lastOccurrence",
"path": "AllergyIntolerance.lastOccurrence",
"short": "Date(/time) of last known occurrence of a reaction",
"definition": "Represents the date and/or time of the last known occurrence of a reaction event.",
"comment": "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.lastOccurrence",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime"
}
]
},
{
"id": "AllergyIntolerance.note",
"path": "AllergyIntolerance.note",
"short": "Additional text not captured in other fields",
"definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comment": "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.",
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"id": "AllergyIntolerance.reaction",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction",
"short": "Adverse Reaction Events linked to exposure to substance",
"definition": "Details about each adverse reaction event linked to exposure to the identified substance.",
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance.reaction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]"
},
{
"identity": "CACDI",
"map": "Patient Allergy-Intolerance Reaction"
}
]
},
{
"id": "AllergyIntolerance.reaction.id",
"path": "AllergyIntolerance.reaction.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AllergyIntolerance.reaction.extension",
"path": "AllergyIntolerance.reaction.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AllergyIntolerance.reaction.modifierExtension",
"path": "AllergyIntolerance.reaction.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AllergyIntolerance.reaction.substance",
"path": "AllergyIntolerance.reaction.substance",
"short": "Specific substance or pharmaceutical product considered to be responsible for event",
"definition": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.",
"comment": "Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, \"penicillins\"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, \"amoxycillin\"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.reaction.substance",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceCode"
}
],
"strength": "example",
"description": "Codes defining the type of the substance (including pharmaceutical products).",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction.manifestation",
"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.",
"alias": [
"Symptoms",
"Signs"
],
"min": 1,
"max": "*",
"base": {
"path": "AllergyIntolerance.reaction.manifestation",
"min": 1,
"max": "*"
},
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Manifestation"
}
],
"strength": "preferred",
"description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode"
},
"mapping": [
{
"identity": "v2",
"map": "AL1-5"
},
{
"identity": "rim",
"map": "code"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "CACDI",
"map": "Allergy or Intolerance Reaction Manifestation"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation.id",
"path": "AllergyIntolerance.reaction.manifestation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation.extension",
"path": "AllergyIntolerance.reaction.manifestation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation.coding",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
},
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction.manifestation.coding",
"short": "A reference to a code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"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.",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity": "rim",
"map": "CV"
},
{
"identity": "orim",
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity": "CACDI",
"map": "Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation.text",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "AllergyIntolerance.reaction.manifestation.text",
"short": "Plain text representation of the concept",
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id": "AllergyIntolerance.reaction.description",
"path": "AllergyIntolerance.reaction.description",
"short": "Description of the event as a whole",
"definition": "Text description about the reaction as a whole, including details of the manifestation if required.",
"comment": "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.",
"alias": [
"Narrative",
"Text"
],
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.reaction.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "text"
}
]
},
{
"id": "AllergyIntolerance.reaction.onset",
"path": "AllergyIntolerance.reaction.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Reaction.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.reaction.onset",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "AL1-6"
},
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"id": "AllergyIntolerance.reaction.severity",
"path": "AllergyIntolerance.reaction.severity",
"short": "mild | moderate | severe (of event as a whole)",
"definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comment": "It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.reaction.severity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AllergyIntoleranceSeverity"
}
],
"strength": "required",
"description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.",
"valueSet": "http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}
]
},
{
"id": "AllergyIntolerance.reaction.exposureRoute",
"path": "AllergyIntolerance.reaction.exposureRoute",
"short": "How the subject was exposed to the substance",
"definition": "Identification of the route by which the subject was exposed to the substance.",
"comment": "Coding of the route of exposure with a terminology should be used wherever possible.",
"min": 0,
"max": "1",
"base": {
"path": "AllergyIntolerance.reaction.exposureRoute",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
}
],
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet": "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode"
}
]
},
{
"id": "AllergyIntolerance.reaction.note",
"path": "AllergyIntolerance.reaction.note",
"short": "Text about event not captured in other fields",
"definition": "Additional text about the adverse reaction event not captured in other fields.",
"comment": "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.",
"min": 0,
"max": "*",
"base": {
"path": "AllergyIntolerance.reaction.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
}
]
},
"differential": {
"element": [
{
"id": "AllergyIntolerance",
"path": "AllergyIntolerance",
"mapping": [
{
"identity": "CACDI",
"map": "Patient Allergy-Intolerance"
}
]
},
{
"id": "AllergyIntolerance.extension",
"path": "AllergyIntolerance.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "AllergyIntolerance.extension:abatement",
"path": "AllergyIntolerance.extension",
"sliceName": "abatement",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
]
}
]
},
{
"id": "AllergyIntolerance.code",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.code",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"binding": {
"extension": [
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
},
{
"url": "documentation",
"valueMarkdown": "Canadian Clinical Drug Data Set CCDD"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/ICD10CA"
},
{
"url": "documentation",
"valueMarkdown": "International Classifications of Disease ICD 10 CA Codes"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts"
},
{
"url": "documentation",
"valueMarkdown": "ValusSet of Licensed Natural Health Products"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode"
},
"mapping": [
{
"identity": "CACDI",
"map": "Patient Allergy or Intolerance.Allergy or Intolerance Code"
}
]
},
{
"id": "AllergyIntolerance.patient",
"path": "AllergyIntolerance.patient",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core"
]
}
],
"mapping": [
{
"identity": "CACDI",
"map": "Patient"
}
]
},
{
"id": "AllergyIntolerance.encounter",
"path": "AllergyIntolerance.encounter",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/encounter-ca-core"
]
}
]
},
{
"id": "AllergyIntolerance.onset[x]",
"path": "AllergyIntolerance.onset[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "AllergyIntolerance.onset[x]:onsetDateTime",
"path": "AllergyIntolerance.onset[x]",
"sliceName": "onsetDateTime",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "AllergyIntolerance.recordedDate",
"path": "AllergyIntolerance.recordedDate",
"mapping": [
{
"identity": "CACDI",
"map": "Health Care Service Event.Event Start Date Time"
}
]
},
{
"id": "AllergyIntolerance.recorder",
"path": "AllergyIntolerance.recorder",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
]
},
{
"id": "AllergyIntolerance.asserter",
"path": "AllergyIntolerance.asserter",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
]
},
{
"id": "AllergyIntolerance.reaction",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction",
"mapping": [
{
"identity": "CACDI",
"map": "Patient Allergy-Intolerance Reaction"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction.manifestation",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode"
},
"mapping": [
{
"identity": "CACDI",
"map": "Allergy or Intolerance Reaction Manifestation"
}
]
},
{
"id": "AllergyIntolerance.reaction.manifestation.coding",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "AllergyIntolerance.reaction.manifestation.coding",
"mapping": [
{
"identity": "CACDI",
"map": "Allergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code"
}
]
}
]
}
}

Terminology bindings

PathConformanceValueSet
AllergyIntolerance.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode
AllergyIntolerance.reaction.manifestationpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/clinicalfindingcode

Additional Terminology Bindings

These bindings may be used in lieu of the primary bindings in the table above.

PathConformanceAdditionalValueSet
AllergyIntolerance.codecandidatehttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct

Mappings to CACDI

The following tables list how the data elements from CA Core+ map to CACDI. For more information visit Mapping Logic.

FHIR Profile ElementCACDI Element(s)
AllergyIntolerancePatient Allergy-Intolerance
AllergyIntolerance.codePatient Allergy or Intolerance.Allergy or Intolerance Code
AllergyIntolerance.patientPatient
AllergyIntolerance.recordedDateHealth Care Service Event.Event Start Date Time
AllergyIntolerance.reactionPatient Allergy-Intolerance Reaction
AllergyIntolerance.reaction.manifestationAllergy or Intolerance Reaction Manifestation
AllergyIntolerance.reaction.manifestation.codingAllergy or Intolerance Reaction Manifestation.Allergy or Intolerance Reaction Manifestation Code

IG © based on FHIR R4 | Package package:ca.infoway.io.core@1.1.0-dft-preballot
HL7® and FHIR® are the registered trademarks of Health Level Seven International