Uzbekistan Digital Health Platform
0.5.0 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core AllergyIntolerance ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-allergy-intolerance Version: 0.5.0
Active as of 2025-08-12 Computable Name: UZCoreAllergyIntolerance

Uzbekistan Core profile for AllergyIntolerance, representing clinical records of allergy or intolerance within the national health information exchange.

UZ Core AllergyIntolerance records a patient's allergy or intolerance on the Digital Health Platform, along with any reactions it has caused. It is anchored to the Patient it belongs to and to the Encounter where it was recorded. Allergy records are surfaced in the patient summary and in the emergency minimum data set - they remain visible even when consent restricts access to other clinical data - so keeping them current is important for patient safety.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.

Each UZ Core AllergyIntolerance Must Have

This profile adds no mandatory cardinality of its own. The only required element is the one inherited from the base resource: a patient (the person the allergy belongs to).

Each UZ Core AllergyIntolerance Must Support

  • an identifier;
  • a code identifying the allergen itself (extensible binding to the DHP allergen value set);
  • a type - allergy or intolerance (required binding);
  • a clinical status - active | inactive | resolved (required binding);
  • a verification status - how well the allergy has been confirmed (required binding);
  • a category - food, medication, environment, biologic (required binding);
  • the patient and the encounter it was recorded in;
  • the onset[x] timing and an abatement extension (0..1);
  • one or more reactions, each with a severity (required binding), manifestation (extensible), and the reaction substance (extensible).

The allergen code is the substance the patient reacts to; the per-reaction substance records the specific agent that triggered a particular reaction event - they are not the same field.

Building the JSON, step by step

Start from the record below - every value validates against this profile, so copy it and adapt. The two snippets after it show the small additions for a reaction and for marking the allergy resolved. The complete reference instance is the grass pollen allergy.

A realistic allergy record

The only strictly mandatory element is patient, but in practice you also send the allergen code, the clinicalStatus (active / inactive / resolved), the verificationStatus (how confirmed it is), the type (allergy or intolerance), the category (food / medication / environment / biologic), the encounter it was recorded in, and when it started (onset[x]). Every UZ Core resource also names the profile it claims in meta.profile. clinicalStatus, verificationStatus, and type are CodeableConcepts, each with its own HL7 system; category is a plain code list, so send the bare code:

{
  "resourceType": "AllergyIntolerance",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-allergy-intolerance"]
  },
  "clinicalStatus": {
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
      "code": "active"
    }]
  },
  "verificationStatus": {
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
      "code": "confirmed"
    }]
  },
  "type": {
    "coding": [{ "system": "http://hl7.org/fhir/allergy-intolerance-type", "code": "allergy" }]
  },
  "category": ["environment"],
  "code": {
    "coding": [{
      "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/allergen-codes-cs",
      "code": "aller-0010-00001",
      "display": "Grass pollen"
    }]
  },
  "patient": { "reference": "Patient/example-salim" },
  "encounter": { "reference": "Encounter/example-encounter" },
  "onsetDateTime": "2025-07-10"
}

Each of type, category, clinicalStatus, and verificationStatus uses a required binding - the value must come from the bound value set. The allergen code has an extensible binding to the DHP allergen value set. patient and encounter are plain References to a Patient and an Encounter.

Recording a reaction

When the allergy has caused a reaction, add a reaction entry: a severity (mild / moderate / severe - required binding), one or more manifestation entries (what was observed), and optionally the substance that triggered this event. Watch the shapes - manifestation is a CodeableReference, so its coded value sits under concept, whereas substance is a plain CodeableConcept. This array slots into the resource above:

{
  "reaction": [{
    "severity": "severe",
    "manifestation": [{
      "concept": {
        "coding": [{
          "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/allergy-reaction-manifestation-cs",
          "code": "aller-0006-00004",
          "display": "Shortness of breath"
        }]
      }
    }],
    "substance": {
      "coding": [{
        "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/allergy-reaction-substance-cs",
        "code": "aller-0010-00031",
        "display": "Walnut, pollen (Jug r_pollen)"
      }]
    }
  }]
}

The per-reaction substance is the specific agent that triggered this event - a separate field from the top-level allergen code.

When the allergy is no longer active

To mark an allergy as resolved, set clinicalStatus to resolved and add the allergyintolerance-abatement extension (0..1) - here as a free-text valueString. Send these in place of the active clinicalStatus on the record above:

{
  "clinicalStatus": {
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
      "code": "resolved"
    }]
  },
  "extension": [{
    "url": "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement",
    "valueString": "Symptoms resolved after antihistamine course"
  }]
}

See Missing & suppressed data and the terminology guidance for choosing the right coded values.

For example API calls and a sample payload, see the Quick Start at the bottom of this page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
Constraints: ext-1
... identifier SΣ 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus ?!SΣ 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... verificationStatus ?!SΣ 0..1 CodeableConcept This field reflects how well the reported allergy has been confirmed.
Binding: AllergyVerificationStatusVS (0.5.0) (required)
... type SΣ 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... code SΣ 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 AllergyIntolerance.implicitRules, AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.reaction, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.severity All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... identifier S 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus S 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... type S 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category S 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... code S 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient S 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... 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
... 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
Constraints: ext-1
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus ?!SΣ 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... verificationStatus ?!SΣ 0..1 CodeableConcept This field reflects how well the reported allergy has been confirmed.
Binding: AllergyVerificationStatusVS (0.5.0) (required)
... type SΣ 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... 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 SΣ 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 0..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 0..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function Σ 0..1 CodeableConcept Type of involvement
Binding: ParticipationRoleType (extensible)
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) Who or what participated in the activities related to the allergy or intolerance
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (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 exposure to a substance.
.... 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 required All Languages 📍5.0.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.criticality Base required Allergy Intolerance Criticality 📍5.0.0 FHIR Std.
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.participant.​function Base extensible Participation Role Type 📍5.0.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.participant, AllergyIntolerance.participant.extension, AllergyIntolerance.participant.modifierExtension, AllergyIntolerance.participant.function, AllergyIntolerance.participant.actor, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.participant.extension, AllergyIntolerance.participant.modifierExtension, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
Constraints: ext-1
... identifier SΣ 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus ?!SΣ 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... verificationStatus ?!SΣ 0..1 CodeableConcept This field reflects how well the reported allergy has been confirmed.
Binding: AllergyVerificationStatusVS (0.5.0) (required)
... type SΣ 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... code SΣ 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 AllergyIntolerance.implicitRules, AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.reaction, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.severity All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
... identifier S 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus S 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... type S 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category S 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... code S 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient S 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(5.0.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... 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
... 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
Constraints: ext-1
.... extension:abatement S 0..1 dateTime, Age, Period, Range, string When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier SΣ 0..* Identifier Identifier associated with this AllergyIntolerance
... clinicalStatus ?!SΣ 0..1 CodeableConcept This field indicates the current clinical status of the allergy or intolerance.
Binding: AllergyClinicalStatusVS (0.5.0) (required)
... verificationStatus ?!SΣ 0..1 CodeableConcept This field reflects how well the reported allergy has been confirmed.
Binding: AllergyVerificationStatusVS (0.5.0) (required)
... type SΣ 0..1 CodeableConcept The type field in the Uz DHP AllergyIntolerance resource indicates whether the patient's condition is an allergy or an intolerance.
Binding: AllergyTypesVS (0.5.0) (required)
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyCategoryVS (0.5.0) (required)
... 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 SΣ 0..1 CodeableConcept Code identifying the allergy or intolerance. This is the allergen itself, i.e., the substance to which the patient is allergic.
Binding: AllergenCodesVS (0.5.0) (extensible)
... patient SΣ 1..1 Reference(UZ Core Patient(0.5.0)) Who the allergy or intolerance is for
... encounter S 0..1 Reference(UZ Core Encounter(0.5.0)) Encounter when the allergy or intolerance was asserted
... onset[x] S 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 0..1 dateTime Date allergy or intolerance was first recorded
... participant Σ 0..* BackboneElement Who or what participated in the activities related to the allergy or intolerance and how they were involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function Σ 0..1 CodeableConcept Type of involvement
Binding: ParticipationRoleType (extensible)
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) Who or what participated in the activities related to the allergy or intolerance
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction S 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... substance S 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ReactionSubstanceVS (0.5.0) (extensible)
.... manifestation S 1..* CodeableReference(Observation) Clinical symptoms/signs associated with the Event
Binding: ReactionManifestationVS (0.5.0) (extensible)
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyReactionSeverityVS (0.5.0) (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 exposure to a substance.
.... 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 required All Languages 📍5.0.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required Allergy clinical status value set 📍0.5.0 This IG
AllergyIntolerance.verificationStatus Base required Allergy verification status value set 📍0.5.0 This IG
AllergyIntolerance.type Base required Allergy types value set 📍0.5.0 This IG
AllergyIntolerance.category Base required Allergy category value set 📍0.5.0 This IG
AllergyIntolerance.criticality Base required Allergy Intolerance Criticality 📍5.0.0 FHIR Std.
AllergyIntolerance.code Base extensible Allergen codes value set 📍0.5.0 This IG
AllergyIntolerance.participant.​function Base extensible Participation Role Type 📍5.0.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base extensible Allergy reaction substance value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy reaction manifestation value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​severity Base required Allergy reaction severity value set 📍0.5.0 This IG
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.participant, AllergyIntolerance.participant.extension, AllergyIntolerance.participant.modifierExtension, AllergyIntolerance.participant.function, AllergyIntolerance.participant.actor, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:abatement, AllergyIntolerance.modifierExtension, AllergyIntolerance.participant.extension, AllergyIntolerance.participant.modifierExtension, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates system from value and must be URL-encoded as %7C.

Read by server id

GET [base]/AllergyIntolerance/[id]

Find allergies and intolerances

GET [base]/AllergyIntolerance?patient=Patient/[id]
GET [base]/AllergyIntolerance?patient=Patient/[id]&clinical-status=active
GET [base]/AllergyIntolerance?patient=Patient/[id]&category=medication
GET [base]/AllergyIntolerance?patient=Patient/[id]&criticality=high
GET [base]/AllergyIntolerance?patient=Patient/[id]&verification-status=confirmed
GET [base]/AllergyIntolerance?patient=Patient/[id]&code=http://snomed.info/sct%7C256277009

Create

POST [base]/AllergyIntolerance
{
  "resourceType": "AllergyIntolerance",
  "meta": {
    "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-allergy-intolerance" ]
  },
  "clinicalStatus": { ... },
  "verificationStatus": { ... },
  "type": { "coding": [ { "code": "allergy" } ] },
  "category": [ "environment" ],
  "code": { ... },
  "patient": { "reference": "Patient/[id]" }
}

Update (e.g. mark resolved, or confirm a previously unconfirmed allergy) - PUT the full resource back with the new status:

PUT [base]/AllergyIntolerance/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since

See the CapabilityStatement for all supported search parameters.