NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.
StructureDefinition-AllergyIntolerance
This profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It identifies the mandatory core elements, vocabularies and value sets which SHALL be present in the AllergyIntolerance resource when using this profile.
Examples
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is:
https://nrces.in/ndhm/fhir/r4/StructureDefinition/AllergyIntolerance
This profile builds on AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
  code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
 coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the 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 | |
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole) | Source of the information about the allergy | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | ΣI | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ΣI | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | ΣI | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | SΣI | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | SΣI | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣI | 0..1 | string | Plain text representation of the concept |
| patient | SΣI | 1..1 | Reference(Patient) | Who the sensitivity is for |
| encounter | I | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |
 onset[x] | I | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | I | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
| asserter | ΣI | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | I | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | I | 0..* | Annotation | Additional text not captured in other fields |
| reaction | I | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | I | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example) |
| manifestation | I | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example) |
| description | I | 0..1 | string | Description of the event as a whole |
| onset | I | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | I | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | I | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example) |
| note | I | 0..* | Annotation | Text about event not captured in other fields |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the 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 | |
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
| asserter | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole) | Source of the information about the allergy | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External ids for this item |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type | ΣI | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) |
| category | ΣI | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) |
| criticality | ΣI | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) |
| code | SΣI | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | SΣI | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣI | 0..1 | string | Plain text representation of the concept |
| patient | SΣI | 1..1 | Reference(Patient) | Who the sensitivity is for |
| encounter | I | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted |
| onset[x] | I | 0..1 | When allergy or intolerance was identified | |
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | I | 0..1 | dateTime | Date first version of the resource instance was recorded |
| recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
| asserter | ΣI | 0..1 | Reference(RelatedPerson | Patient | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | I | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction |
| note | I | 0..* | Annotation | Additional text not captured in other fields |
| reaction | I | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | I | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example) |
| manifestation | I | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example) |
| description | I | 0..1 | string | Description of the event as a whole |
| onset | I | 0..1 | dateTime | Date(/time) when manifestations showed |
| severity | I | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) |
| exposureRoute | I | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example) |
| note | I | 0..* | Annotation | Text about event not captured in other fields |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
