US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: AllergyIntolerance

Official URL: http://va.gov/fhir/StructureDefinition/AllergyIntolerance Version: 1.3.1
Active as of 2025-03-31 Computable Name: AllergyIntolerance

This StructureDefinition contains the maps for VistA file PATIENT ALLERGIES (120.8) to us-core-allergyintolerance.

See also the FHIR Shorthand.

Use Case Overview

Use Case: AllergyIntolerance«us-core-allergyintolerance»AllergyIntolerancepatientrecorderPatientPractitioner

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:va-IEN Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:va-CDW Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError


ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism


ele-1: All FHIR elements must have a @value or children
... category SΣ 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory


ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
ele-1: All FHIR elements must have a @value or children
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Additional text not captured in other fields
ele-1: All FHIR elements must have a @value or children
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString SΣ 0..1 string Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
ele-1: All FHIR elements must have a @value or children
..... coding Σ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system SΣ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... code SΣ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ele-1: All FHIR elements must have a @value or children
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.identifier:va-IEN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
... Slices for identifier 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
.... identifier:va-IEN 0..1 Identifier External ids for this item
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value S 0..1 string The value that is unique
.... identifier:va-CDW 0..1 Identifier External ids for this item
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value S 0..1 string The value that is unique
... clinicalStatus 0..1 CodeableConcept active | inactive | resolved
Binding: allergyActive FHIR (required): see mapping VF_allergyActive

... verificationStatus 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError

... category S 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory

... code 1..1 CodeableConcept Code that identifies the allergy or intolerance
.... text S 0..1 string Plain text representation of the concept
... patient 1..1 Reference(Patient) Who the sensitivity is for
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
... note
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorString S 0..1 string Individual responsible for the annotation
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)
... reaction
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
..... coding
...... system S 0..1 uri Identity of the terminology system
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... code S 0..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
.... identifier:va-IEN Σ 0..1 Identifier External ids for this item
..... 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 SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value SΣ 0..1 string The value that is unique
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)
.... identifier:va-CDW Σ 0..1 Identifier External ids for this item
..... 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 SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value SΣ 0..1 string The value that is unique
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 ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: allergyActive FHIR (required): see mapping VF_allergyActive

... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError

... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism

... category SΣ 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory


... 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 SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
.... 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
.... text SΣ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString SΣ 0..1 string Individual responsible for the annotation
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... 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 S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
..... 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 SΣ 0..1 uri Identity of the terminology system
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity

.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:va-IEN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-IEN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreAllergyIntolerance

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier
  • The element 1 is sliced based on the value of AllergyIntolerance.note.author[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:va-IEN Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:va-CDW Σ 0..1 Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError


ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism


ele-1: All FHIR elements must have a @value or children
... category SΣ 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory


ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
ele-1: All FHIR elements must have a @value or children
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Additional text not captured in other fields
ele-1: All FHIR elements must have a @value or children
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString SΣ 0..1 string Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
ele-1: All FHIR elements must have a @value or children
..... coding Σ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system SΣ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... code SΣ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
...... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ele-1: All FHIR elements must have a @value or children
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.identifier:va-IEN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from USCoreAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
... Slices for identifier 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
.... identifier:va-IEN 0..1 Identifier External ids for this item
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value S 0..1 string The value that is unique
.... identifier:va-CDW 0..1 Identifier External ids for this item
..... system S 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value S 0..1 string The value that is unique
... clinicalStatus 0..1 CodeableConcept active | inactive | resolved
Binding: allergyActive FHIR (required): see mapping VF_allergyActive

... verificationStatus 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError

... category S 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory

... code 1..1 CodeableConcept Code that identifies the allergy or intolerance
.... text S 0..1 string Plain text representation of the concept
... patient 1..1 Reference(Patient) Who the sensitivity is for
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
... note
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorString S 0..1 string Individual responsible for the annotation
.... time S 0..1 dateTime When the annotation was made
.... text S 1..1 markdown The annotation - text content (as markdown)
... reaction
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
..... coding
...... system S 0..1 uri Identity of the terminology system
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... code S 0..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... text S 0..1 string Plain text representation of the concept
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* USCoreAllergyIntolerance(5.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
This profile also complies with the profiles US Core AllergyIntolerance Profile (6.1.0) and US Core AllergyIntolerance Profile (7.0.0)
ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External ids for this item
Slice: Unordered, Open by value:$this
.... identifier:va-IEN Σ 0..1 Identifier External ids for this item
..... 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 SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/$Sta3n/120.8
..... value SΣ 0..1 string The value that is unique
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)
.... identifier:va-CDW Σ 0..1 Identifier External ids for this item
..... 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 SΣ 0..1 uri The namespace for the identifier value
Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy
..... value SΣ 0..1 string The value that is unique
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 ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: allergyActive FHIR (required): see mapping VF_allergyActive

... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError

... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism

... category SΣ 0..* code food | medication | environment | biologic
Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory


... 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 SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Common substances for allergy and intolerance documentation including refutations . (extensible)
.... 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
.... text SΣ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString SΣ 0..1 string Individual responsible for the annotation
.... time SΣ 0..1 dateTime When the annotation was made
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... 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 S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (extensible)
..... 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 SΣ 0..1 uri Identity of the terminology system
Required Pattern: urn:oid:2.16.840.1.113883.6.233
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset SC 0..1 dateTime Date(/time) when manifestations showed
ai-18-1652: If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity

.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.identifier:va-IEN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-IEN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AllergyIntolerance.identifier:va-CDW.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyActive
http://va.gov/fhir/ValueSet/allergyActive
from this IG
AllergyIntolerance.verificationStatusrequiredAllergyEnteredInError
http://va.gov/fhir/ValueSet/allergyEnteredInError
from this IG
AllergyIntolerance.typerequiredAllergyMechanism
http://va.gov/fhir/ValueSet/allergyMechanism
from this IG
AllergyIntolerance.categoryrequiredAllergySubstanceCategory
http://va.gov/fhir/ValueSet/allergySubstanceCategory
from this IG
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeextensibleCommon substances for allergy and intolerance documentation including refutations .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
AllergyIntolerance.reaction.substanceexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
AllergyIntolerance.reaction.manifestationextensibleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
AllergyIntolerance.reaction.severityrequiredAllergySeverity
http://va.gov/fhir/ValueSet/allergySeverity
from this IG
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.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()
ai-18-1652warningAllergyIntolerance.reaction.onsetIf 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3)
: true
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreAllergyIntolerance

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AllergyIntolerance.identifier
  • The element 1 is sliced based on the value of AllergyIntolerance.note.author[x]

 

Other representations of profile: CSV, Excel, Schematron