EHI Export Implementation Guide
0.1.0 - ci-build

EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Allergy Intolerance

Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/allergy-intolerance Version: 0.1.0
Draft as of 2025-12-10 Computable Name: EHIAllergyIntolerance

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri System URI for allergy identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string Unique value of the allergy record
Example General: 123456
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code Σ 0..1 CodeableConcept Substance, food, or medication that causes the reaction
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
... patient Σ 1..1 Reference(Patient) Patient who has the allergy or intolerance
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... text Σ 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... identifier 0..* Identifier Unique identifier for the allergy record
.... system 0..1 uri System URI for allergy identifier
.... value 0..1 string Unique value of the allergy record
... code 0..1 CodeableConcept Substance, food, or medication that causes the reaction
.... coding
..... system 0..1 uri Code system identifying the allergen
..... code 0..1 code Code identifying the allergen
..... display 0..1 string Display name of the allergen
... encounter 0..0 Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... asserter 0..0 Source of the information about the allergy
... lastOccurrence 0..0 Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... text 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
..... coding
...... system 0..1 uri System from which manifestation code is drawn
...... code 0..1 code Code identifying the manifestation
...... display 0..1 string Display text for manifestation
.... exposureRoute 0..0 How the subject was exposed to the substance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier for the allergy record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri System URI for allergy identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string Unique value of the allergy record
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Substance, food, or medication that causes the reaction
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Code system identifying the allergen
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Code identifying the allergen
..... display Σ 0..1 string Display name of the allergen
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) Patient who has the allergy or intolerance
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri System from which manifestation code is drawn
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Code identifying the manifestation
...... display Σ 0..1 string Display text for manifestation
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri System URI for allergy identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string Unique value of the allergy record
Example General: 123456
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code Σ 0..1 CodeableConcept Substance, food, or medication that causes the reaction
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
... patient Σ 1..1 Reference(Patient) Patient who has the allergy or intolerance
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... text Σ 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... identifier 0..* Identifier Unique identifier for the allergy record
.... system 0..1 uri System URI for allergy identifier
.... value 0..1 string Unique value of the allergy record
... code 0..1 CodeableConcept Substance, food, or medication that causes the reaction
.... coding
..... system 0..1 uri Code system identifying the allergen
..... code 0..1 code Code identifying the allergen
..... display 0..1 string Display name of the allergen
... encounter 0..0 Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... asserter 0..0 Source of the information about the allergy
... lastOccurrence 0..0 Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... text 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
..... coding
...... system 0..1 uri System from which manifestation code is drawn
...... code 0..1 code Code identifying the manifestation
...... display 0..1 string Display text for manifestation
.... exposureRoute 0..0 How the subject was exposed to the substance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedBy 0..1 string User or system who originally recorded the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RecordedBy.html
.... extension:revisionBy 0..1 string User or system who last revised the allergy
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionBy.html
.... extension:revisionDate 0..1 dateTime Date/time of last revision
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-RevisionDate.html
.... extension:resolvedDate 0..1 dateTime Date/time allergy resolved
URL: https://ehi-export.pointclickcare.com/site/StructureDefinition-ResolvedDate.html
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique identifier for the allergy record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri System URI for allergy identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string Unique value of the allergy record
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code Σ 0..1 CodeableConcept Substance, food, or medication that causes the reaction
Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Code system identifying the allergen
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Code identifying the allergen
..... display Σ 0..1 string Display name of the allergen
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) Patient who has the allergy or intolerance
... Slices for onset[x] 0..1 When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime When the allergy or intolerance was first identified
... recordedDate 0..1 dateTime Date and time the allergy record was entered
... recorder 0..1 Reference(Practitioner) Practitioner or system that recorded the allergy
... note 0..* Annotation Additional textual notes about the allergy or reaction
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Free-text details or comments about the allergy
... reaction 0..* BackboneElement Adverse reaction events linked to the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the reaction
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri System from which manifestation code is drawn
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Code identifying the manifestation
...... display Σ 0..1 string Display text for manifestation
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 error AllergyIntolerance 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 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron