NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-allergyintolerance | Version: 1.0.0 | ||||
| Active as of 2026-10-14 | Computable Name: NPCoreAllergyIntolerance | ||||
Sets minimum expectations for recording a patient's allergies and adverse reactions in Nepal.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| 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 | |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
 clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| ||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||
| category |
0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
| |||||||||
| criticality |
0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
| |||||||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
| |||||||||
 patient |
1..1 | Reference(NP Core Patient) | Who the sensitivity is for
| |||||||||
| recorder |
0..1 | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Patient | NP Core RelatedPerson) | Who recorded the sensitivity
| |||||||||
 reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
| |||||||||
 severity |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
| |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| 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 | example | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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 | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
 clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| Documentation for this format | |||
| 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 | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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): The clinical status of the allergy or intolerance.
| ||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| ||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||
| category |
0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
| |||||||||
| criticality |
0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
| |||||||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
| |||||||||
| patient |
1..1 | Reference(NP Core Patient) | Who the sensitivity is for
| |||||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
  onset[x] |
0..1 | When allergy or intolerance was identified | ||||||||||
 onsetDateTime |
dateTime | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||
| recorder |
0..1 | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Patient | NP Core 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 (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
| |||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
| |||||||||
| exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| 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 | example | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| Documentation for this format | |||
This structure is derived from AllergyIntolerance
Summary
Must-Support: 11 elements
Structures
This structure refers to these other structures:
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 | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| clinicalStatus |
C | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
| ||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| ||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||
| category |
0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
| |||||||||
| criticality |
0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
| |||||||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
| |||||||||
| patient |
1..1 | Reference(NP Core Patient) | Who the sensitivity is for
| |||||||||
| recorder |
0..1 | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Patient | NP Core RelatedPerson) | Who recorded the sensitivity
| |||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
| |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
| |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| 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 | example | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| 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) | |||||||||
| clinicalStatus |
0..1 | CodeableConcept | active | inactive | resolved
| |||||||||
| verificationStatus |
0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
| |||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known)
| |||||||||
| category |
0..* | code | food | medication | environment | biologic
| |||||||||
| criticality |
0..1 | code | low | high | unable-to-assess
| |||||||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance
| |||||||||
| patient |
1..1 | Reference(NP Core Patient) | Who the sensitivity is for
| |||||||||
| recorder |
0..1 | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Patient | NP Core RelatedPerson) | Who recorded the sensitivity
| |||||||||
| reaction |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
| |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event
| |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole)
| |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| Documentation for this format | |||
Snapshot ViewView
| 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 | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| 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): The clinical status of the allergy or intolerance.
| ||||||||
| verificationStatus |
C | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
| ||||||||
| type |
0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
| |||||||||
| category |
0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
| |||||||||
| criticality |
0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
| |||||||||
| code |
0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.
| |||||||||
| patient |
1..1 | Reference(NP Core Patient) | Who the sensitivity is for
| |||||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
| onset[x] |
0..1 | When allergy or intolerance was identified | ||||||||||
| onsetDateTime |
dateTime | |||||||||||
| onsetAge |
Age | |||||||||||
| onsetPeriod |
Period | |||||||||||
| onsetRange |
Range | |||||||||||
| onsetString |
string | |||||||||||
| recordedDate |
0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||
| recorder |
0..1 | Reference(NP Core Practitioner | NP Core PractitionerRole | NP Core Patient | NP Core 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 (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
| |||||||||
| description |
0..1 | string | Description of the event as a whole | |||||||||
| onset |
0..1 | dateTime | Date(/time) when manifestations showed | |||||||||
| severity |
0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
| |||||||||
| exposureRoute |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||||||
| note |
0..* | Annotation | Text about event not captured in other fields | |||||||||
| Documentation for this format | ||||||||||||
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| 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 | example | AllergyIntolerance Substance/Product, Condition and Negation Codes | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.manifestation | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| AllergyIntolerance.reaction.severity | Base | required | AllergyIntoleranceSeverity | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | NP Core Server | NP Core Consumer | NP Core Creator |
|---|---|---|---|
| AllergyIntolerance |
|||
| clinicalStatus |
|
|
|
| verificationStatus |
|
|
|
| type |
|
|
|
| category |
|
|
|
| criticality |
|
|
|
| code |
|
|
|
| patient |
|
|
|
| recorder |
|
|
|
| reaction |
|
|
|
| manifestation |
|
|
|
| severity |
|
|
|
| Documentation for this format | |||
This structure is derived from AllergyIntolerance
Summary
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron