NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 1.0.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/ImmunizationIG/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: NG-Imm AllergyIntolerance

Nigeria Immunization Allergy Intolerance Profile

Usages:

• Use this Profile: Nigeria Immunization Bundle
• Examples for this Profile: AllergyIntolerance/FullExampleNgAllergyIntolerance and AllergyIntolerance/NgImmExampleAllergyIntolerance

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance			AllergyIntolerance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard

Constraints

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()
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	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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. Additional Bindings Purpose AllLanguages Max Binding
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
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes From the FHIR Standard

Constraints

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()
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:

• NG-Imm Patient (http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient)
• NG-Imm Encounter (http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-encounter)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-series

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance			AllergyIntolerance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard

Constraints

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()
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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. Additional Bindings Purpose AllLanguages Max Binding
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
extension:allergyReferenceDoseNumber	S	0..1	string	NG-Imm Allergy Dose Number URL: http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
extension:allergyReferenceDoseSeries	S	0..1	string	NG-Imm Dose Series URL: http://nphcda.gov.ng/ig/immunization/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	S	0..1	string	Description of the event as a whole
onset	S	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

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical From the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification From the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type From the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category From the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality From the FHIR Standard
AllergyIntolerance.code	extensible	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code From the FHIR Standard
AllergyIntolerance.reaction.substance	preferred	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code From the FHIR Standard
AllergyIntolerance.reaction.manifestation	extensible	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings From the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity From the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes From the FHIR Standard

Constraints

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()
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:

• NG-Imm Patient (http://nphcda.gov.ng/ig/immunization/StructureDefinition/NgImmPatient)
• NG-Imm Encounter (http://nphcda.gov.ng/ig/immunization/StructureDefinition/ng-imm-encounter)

Extensions

This structure refers to these extensions:

• http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-number
• http://nphcda.gov.ng/ig/immunization/StructureDefinition/allergy-reference-dose-series

Other representations of profile: CSV, Excel, Schematron