WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: ANC AllergyIntolerance

Official URL: http://smart.who.int/anc/StructureDefinition/anc-allergyintolerance Version: 0.3.0
Draft as of 2026-10-16 Computable Name: ANCAllergyIntolerance

ANC AllergyIntolerance

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2, 1
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.Slices for extension Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:resolutionAge 0..1 Age Age that the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
AllergyIntolerance.Slices for extension.extension:reasonRefuted This element must be supported. C 0..1 CodeableConcept Explanation associated with refuted status
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..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.
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 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.
AllergyIntolerance.code This element must be supported. This element is included in summaries. 1..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.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter This element must be supported. 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 0..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder This element must be supported. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity
AllergyIntolerance.asserter This element must be supported. This element is included in summaries. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.Slices for extension Content/Rules for all slices
AllergyIntolerance.reaction.Slices for extension.extension:reaction-duration This element must be supported. 0..1 Duration How long Manifestations persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.manifestation This element must be supported. 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.
AllergyIntolerance.reaction.onset This element must be supported. 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍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.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
1 error AllergyIntolerance extension: reasonRefuted is only permitted if status is refuted verificationStatus.coding.code = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty()
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 WHOAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.patient 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recorder 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2, 1
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
AllergyIntolerance.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:resolutionAge 0..1 Age Age that the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
AllergyIntolerance.Slices for extension.extension:reasonRefuted This element must be supported. C 0..1 CodeableConcept Explanation associated with refuted status
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
AllergyIntolerance.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..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.
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 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.
AllergyIntolerance.code This element must be supported. This element is included in summaries. 1..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.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter This element must be supported. 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x] 0..1 When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime dateTime
AllergyIntolerance.onset[x].onsetAge Age
AllergyIntolerance.onset[x].onsetPeriod Period
AllergyIntolerance.onset[x].onsetRange Range
AllergyIntolerance.recordedDate This element must be supported. 0..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder This element must be supported. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity
AllergyIntolerance.asserter This element must be supported. This element is included in summaries. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Source of the information about the allergy
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.reaction This element must be supported. 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.reaction.Slices for extension.extension:reaction-duration This element must be supported. 0..1 Duration How long Manifestations persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.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).
AllergyIntolerance.reaction.manifestation This element must be supported. 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.
AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset This element must be supported. 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 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.
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍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.

Constraints

Id Grade Path(s) Description Expression
1 error AllergyIntolerance extension: reasonRefuted is only permitted if status is refuted verificationStatus.coding.code = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty()
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2, 1
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.Slices for extension Content/Rules for all slices
AllergyIntolerance.Slices for extension.extension:resolutionAge 0..1 Age Age that the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
AllergyIntolerance.Slices for extension.extension:reasonRefuted This element must be supported. C 0..1 CodeableConcept Explanation associated with refuted status
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..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.
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 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.
AllergyIntolerance.code This element must be supported. This element is included in summaries. 1..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.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter This element must be supported. 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recordedDate This element must be supported. 0..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder This element must be supported. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity
AllergyIntolerance.asserter This element must be supported. This element is included in summaries. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Source of the information about the allergy
AllergyIntolerance.reaction This element must be supported. 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.Slices for extension Content/Rules for all slices
AllergyIntolerance.reaction.Slices for extension.extension:reaction-duration This element must be supported. 0..1 Duration How long Manifestations persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.manifestation This element must be supported. 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.
AllergyIntolerance.reaction.onset This element must be supported. 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍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.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
1 error AllergyIntolerance extension: reasonRefuted is only permitted if status is refuted verificationStatus.coding.code = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty()
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 WHOAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
AllergyIntolerance.patient 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.recorder 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity
AllergyIntolerance.asserter 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Source of the information about the allergy

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AllergyIntolerance C 0..* WHOAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2, 1
AllergyIntolerance.id This element is included in summaries. 0..1 id Logical id of this artifact
AllergyIntolerance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AllergyIntolerance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AllergyIntolerance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AllergyIntolerance.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
AllergyIntolerance.contained 0..* Resource Contained, inline Resources
AllergyIntolerance.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.Slices for extension.extension:resolutionAge 0..1 Age Age that the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
AllergyIntolerance.Slices for extension.extension:reasonRefuted This element must be supported. C 0..1 CodeableConcept Explanation associated with refuted status
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
AllergyIntolerance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AllergyIntolerance.identifier This element must be supported. This element is included in summaries. 1..* Identifier External ids for this item
AllergyIntolerance.identifier.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AllergyIntolerance.identifier.use This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AllergyIntolerance.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
AllergyIntolerance.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AllergyIntolerance.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
AllergyIntolerance.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AllergyIntolerance.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
AllergyIntolerance.clinicalStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus This element is a modifier element. This element must be supported. This element is included in summaries. C 1..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.
AllergyIntolerance.type This element must be supported. This element is included in summaries. 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category This element must be supported. This element is included in summaries. 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality This element must be supported. This element is included in summaries. 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.
AllergyIntolerance.code This element must be supported. This element is included in summaries. 1..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.
AllergyIntolerance.patient This element must be supported. This element is included in summaries. 1..1 Reference(ANC Base Patient) Who the sensitivity is for
AllergyIntolerance.encounter This element must be supported. 0..1 Reference(ANC Base Encounter) Encounter when the allergy or intolerance was asserted
AllergyIntolerance.onset[x] 0..1 When allergy or intolerance was identified
AllergyIntolerance.onset[x].onsetDateTime dateTime
AllergyIntolerance.onset[x].onsetAge Age
AllergyIntolerance.onset[x].onsetPeriod Period
AllergyIntolerance.onset[x].onsetRange Range
AllergyIntolerance.recordedDate This element must be supported. 0..1 dateTime Date first version of the resource instance was recorded
AllergyIntolerance.recorder This element must be supported. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Who recorded the sensitivity
AllergyIntolerance.asserter This element must be supported. This element is included in summaries. 0..1 Reference(ANC Practitioner | ANC PractitionerRole | ANC Base Patient | ANC RelatedPerson) Source of the information about the allergy
AllergyIntolerance.lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
AllergyIntolerance.note 0..* Annotation Additional text not captured in other fields
AllergyIntolerance.reaction This element must be supported. 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id 0..1 string Unique id for inter-element referencing
AllergyIntolerance.reaction.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AllergyIntolerance.reaction.Slices for extension.extension:reaction-duration This element must be supported. 0..1 Duration How long Manifestations persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
AllergyIntolerance.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.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).
AllergyIntolerance.reaction.manifestation This element must be supported. 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.
AllergyIntolerance.reaction.description 0..1 string Description of the event as a whole
AllergyIntolerance.reaction.onset This element must be supported. 0..1 dateTime Date(/time) when manifestations showed
AllergyIntolerance.reaction.severity This element must be supported. 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.
AllergyIntolerance.reaction.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.
AllergyIntolerance.reaction.note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍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.

Constraints

Id Grade Path(s) Description Expression
1 error AllergyIntolerance extension: reasonRefuted is only permitted if status is refuted verificationStatus.coding.code = 'refuted' or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty()
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()

 

Other representations of profile: CSV, Excel, Schematron