US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.identifier:va-IEN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.identifier:va-CDW.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | |
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | |
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | |
AllergyIntolerance.code | extensible | Common 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.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true | |
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 USCoreAllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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) | |
![]() ![]() ![]() |
0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() ![]() |
0..1 | Identifier | External ids for this item | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/120.8 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..1 | Identifier | External ids for this item | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive | |
![]() ![]() ![]() |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError | |
![]() ![]() ![]() |
S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism |
![]() ![]() ![]() |
S | 0..* | code | food | medication | environment | biologic Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory |
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Who the sensitivity is for | |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Individual responsible for the annotation |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.840.1.113883.6.233 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | |
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | |
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | |
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG |
Id | Grade | Path(s) | Details | Requirements |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/120.8 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive | ||||
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | food | medication | environment | biologic Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations ![]() | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
![]() ![]() ![]() |
0..1 | When allergy or intolerance was identified | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Individual responsible for the annotation | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.840.1.113883.6.233 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
AllergyIntolerance.identifier:va-IEN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-IEN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-CDW.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-CDW.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | ||||
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | ||||
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | ||||
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.code | extensible | Common 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.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG | ||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true | |
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 USCoreAllergyIntolerance
Summary
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.identifier:va-IEN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.identifier:va-CDW.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | |
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | |
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | |
AllergyIntolerance.code | extensible | Common 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.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true | |
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 USCoreAllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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) | |
![]() ![]() ![]() |
0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() ![]() |
0..1 | Identifier | External ids for this item | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/120.8 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
0..1 | Identifier | External ids for this item | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive | |
![]() ![]() ![]() |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError | |
![]() ![]() ![]() |
S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism |
![]() ![]() ![]() |
S | 0..* | code | food | medication | environment | biologic Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory |
![]() ![]() ![]() |
1..1 | CodeableConcept | Code that identifies the allergy or intolerance | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Who the sensitivity is for | |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Individual responsible for the annotation |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.840.1.113883.6.233 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | |
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | |
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | |
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG |
Id | Grade | Path(s) | Details | Requirements |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/120.8 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | External ids for this item | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/CDWSID/cdwwork.allergy.allergy | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: allergyActive FHIR (required): see mapping VF_allergyActive | ||||
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: allergyEnteredInError FHIR (required): see mapping VF_allergyEnteredInError | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: allergyMechanism FHIR (required): see mapping VF_allergyMechanism | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | food | medication | environment | biologic Binding: allergySubstanceCategory FHIR (required): see mapping VF_allergySubstanceCategory | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations ![]() | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
![]() ![]() ![]() |
0..1 | When allergy or intolerance was identified | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who recorded the sensitivity | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
![]() ![]() ![]() |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional text not captured in other fields | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Individual responsible for the annotation | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:2.16.840.1.113883.6.233 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: allergySeverity FHIR (required): see mapping VF_allergySeverity | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
AllergyIntolerance.identifier:va-IEN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-IEN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-CDW.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier:va-CDW.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.clinicalStatus | required | AllergyActivehttp://va.gov/fhir/ValueSet/allergyActive from this IG | ||||
AllergyIntolerance.verificationStatus | required | AllergyEnteredInErrorhttp://va.gov/fhir/ValueSet/allergyEnteredInError from this IG | ||||
AllergyIntolerance.type | required | AllergyMechanismhttp://va.gov/fhir/ValueSet/allergyMechanism from this IG | ||||
AllergyIntolerance.category | required | AllergySubstanceCategoryhttp://va.gov/fhir/ValueSet/allergySubstanceCategory from this IG | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.code | extensible | Common 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.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | extensible | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergySeverityhttp://va.gov/fhir/ValueSet/allergySeverity from this IG | ||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ai-18-1652 | warning | AllergyIntolerance.reaction.onset | If 6 OBSERVED/HISTORICAL = O then source value from (120.8-10 > 120.81-3) : true | |
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 USCoreAllergyIntolerance
Summary
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron