NPHCDA Immunization FHIR IG
0.9.0 - ci-build
NPHCDA Immunization FHIR IG
0.9.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.9.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
| Official URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-intolerance-profile | Version: 0.9.0 | |||
| Draft as of 2026-10-07 | Computable Name: NgImmAllergyIntolerance | |||
Nigeria Immunization Allergy Intolerance Profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |
 extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
 coding |
1..1 | Coding | The clinical status of the allergy or intolerance | |
| verificationStatus |
C | 0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |
 patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |
| encounter |
0..1 | Reference(NG-Imm Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate |
1..1 | dateTime | Date first version of the resource instance was recorded | |
 reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
 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 (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |
| description |
0..1 | string | Description of the event as a whole | |
| onset |
0..1 | dateTime | Date/time when manifestations showed | |
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
|
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
|
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |
| extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |
 clinicalStatus |
0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | |
| coding |
1..1 | Coding | The clinical status of the allergy or intolerance | |
| verificationStatus |
0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) | |
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |
| encounter |
0..1 | Reference(NG-Imm Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate |
1..1 | dateTime | Date first version of the resource instance was recorded | |
| reaction |
||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |
| description |
0..1 | string | Description of the event as a whole | |
| onset |
0..1 | dateTime | Date/time when manifestations showed | |
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |
| note |
0..0 | Text about event not captured in other fields | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |||||
| extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External ids for this item | |||||
| clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| 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 |
1..1 | Coding | The clinical status of the allergy or intolerance | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| verificationStatus |
C | 0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) | ||||
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |||||
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |||||
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |||||
| patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |||||
| encounter |
0..1 | Reference(NG-Imm 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 |
1..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | 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 | |||||
| reaction |
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 (preferred) | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date/time when manifestations showed | |||||
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |||||
| 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. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
|
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
|
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AllergyIntolerance
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |
| extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) |
| coding |
1..1 | Coding | The clinical status of the allergy or intolerance | |
| verificationStatus |
C | 0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) |
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |
| encounter |
0..1 | Reference(NG-Imm Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate |
1..1 | dateTime | Date first version of the resource instance was recorded | |
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| 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 (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |
| description |
0..1 | string | Description of the event as a whole | |
| onset |
0..1 | dateTime | Date/time when manifestations showed | |
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
|
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
|
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |
| extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |
| clinicalStatus |
0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | |
| coding |
1..1 | Coding | The clinical status of the allergy or intolerance | |
| verificationStatus |
0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) | |
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |
| encounter |
0..1 | Reference(NG-Imm Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate |
1..1 | dateTime | Date first version of the resource instance was recorded | |
| reaction |
||||
| substance |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (preferred) | |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |
| description |
0..1 | string | Description of the event as a whole | |
| onset |
0..1 | dateTime | Date/time when manifestations showed | |
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |
| note |
0..0 | Text about event not captured in other fields | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Constraints: ait-1, ait-2 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:allergyReferenceDoseNumber |
0..1 | integer | NG-Imm Allergy Dose Number URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-number | |||||
| extension:allergyReferenceDoseSeries |
0..1 | string | NG-Imm Dose Series URL: https://nphcda.gov.ng/ig/StructureDefinition/allergy-reference-dose-series | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External ids for this item | |||||
| clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required) | ||||
| 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 |
1..1 | Coding | The clinical status of the allergy or intolerance | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| verificationStatus |
C | 0..1 | CodeableConcept | Assertion about certainty associated with a propensity or potential risk of a reaction to the identified substance Binding: AllergyIntoleranceVerificationStatusCodes (required) | ||||
| type |
0..1 | code | Identification of the underlying physiological mechanism for a Reaction Risk Binding: AllergyIntoleranceType (required) | |||||
| category |
0..* | code | Category of an identified substance associated with allergies or intolerances Binding: AllergyIntoleranceCategory (required) | |||||
| criticality |
0..1 | code | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance Binding: AllergyIntoleranceCriticality (required) | |||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (extensible) | |||||
| patient |
1..1 | Reference(NG-Imm Patient) | Who the sensitivity is for | |||||
| encounter |
0..1 | Reference(NG-Imm 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 |
1..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | 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 | |||||
| reaction |
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 (preferred) | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (extensible) | |||||
| description |
0..1 | string | Description of the event as a whole | |||||
| onset |
0..1 | dateTime | Date/time when manifestations showed | |||||
| severity |
0..1 | code | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations Binding: AllergyIntoleranceSeverity (required) | |||||
| 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. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AllergyIntolerance.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.clinicalStatus | Base | required | AllergyIntolerance Clinical Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.verificationStatus | Base | required | AllergyIntolerance Verification Status Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.type | Base | required | AllergyIntoleranceType | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.category | Base | required | AllergyIntoleranceCategory | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.criticality | Base | required | AllergyIntoleranceCriticality | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.code | Base | extensible | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | preferred | Substance Code | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | extensible | SNOMED CT Clinical Findings | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📦4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.exposureRoute | Base | example | SNOMED CT Route Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
|
| ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error |
verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
|
| dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AllergyIntolerance
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron