Medtech ALEX® AU Implementation Guide
1.0.0 - Trial Use International flag

Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Allergy Intolerance IPS Profile

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-allergyintolerance-ips Version: 1.0.0
Active as of 2025-10-12 Computable Name: AlexAllergyIntoleranceIps

The allergy intolerance for IPS

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: Filtersdoco
.. AllergyIntolerance C 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2, allergyIntolerance-patient-display-validation, allergyIntolerance-reaction-manifestation-validation, allergyIntolerance-code-validation, allergyIntolerance-eliteSportsPerson-code-validation, allergyIntolerance-pregnant-code-validation, allergyIntolerance-noKnownAllergies-code-validation, allergyIntolerance-noteOnly-code-validation, allergyIntolerance-eliteSportsPerson-reaction-validation, allergyIntolerance-pregnant-reaction-validation, allergyIntolerance-noKnownAllergies-reaction-validation, allergyIntolerance-noteOnly-reaction-validation, allergyIntolerance-noteOnly-note-validation
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:allergyIntoleranceType S 1..1 Coding Allergy Intolerance Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type
Binding: Type of Allergy Intolerance (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive
Binding: Status for Allergy Intolerance (required)
.... coding Σ 0..* Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: confirmed
... code SΣ 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergy Intolerance Code (preferred)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
.... reference SΣC 1..1 string Reference to Patient resource
... Slices for onset[x] 1..1 dateTime When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S 1..1 dateTime When allergy or intolerance was identified
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... asserter SΣ 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... note S 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:reactionType S 0..1 (Complex) Allergy Intolerance Reaction Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type
...... extension 0..0
...... url 1..1 uri "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type"
...... value[x] 1..1 Coding Value of extension
Binding: Type of Allergy Intolerance Reaction (extensible)
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Intolerance Manifestation Code Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Status for Allergy Intolerance 📦1.0.0 This IG
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergy Intolerance Code 📦1.0.0 This IG
AllergyIntolerance.reaction.​extension:reactionType.​value[x] Base extensible Type of Allergy Intolerance Reaction 📦1.0.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy Intolerance Manifestation Code Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
allergyIntolerance-code-validation error AllergyIntolerance Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and code.coding.system = 'http://snomed.info/sct' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-eliteSportsPerson-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty()
allergyIntolerance-eliteSportsPerson-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and reaction.empty()
allergyIntolerance-noKnownAllergies-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty()
allergyIntolerance-noKnownAllergies-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and reaction.empty()
allergyIntolerance-noteOnly-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-noteOnly-note-validation error AllergyIntolerance Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and note.text.exists()
allergyIntolerance-noteOnly-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and reaction.empty()
allergyIntolerance-patient-display-validation error AllergyIntolerance Patient display must not exceed 35 characters patient.display.empty() or patient.display.length() <= 35
allergyIntolerance-pregnant-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty()
allergyIntolerance-pregnant-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and reaction.empty()
allergyIntolerance-reaction-manifestation-validation error AllergyIntolerance Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and reaction.exists() and reaction.manifestation.exists() or (extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'therapeutic' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'genericGroup' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'productCode' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'interactionClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'substanceClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'nonMedicinalSubstance')
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 AlexAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2, allergyIntolerance-patient-display-validation, allergyIntolerance-reaction-manifestation-validation, allergyIntolerance-code-validation, allergyIntolerance-eliteSportsPerson-code-validation, allergyIntolerance-pregnant-code-validation, allergyIntolerance-noKnownAllergies-code-validation, allergyIntolerance-noteOnly-code-validation, allergyIntolerance-eliteSportsPerson-reaction-validation, allergyIntolerance-pregnant-reaction-validation, allergyIntolerance-noKnownAllergies-reaction-validation, allergyIntolerance-noteOnly-reaction-validation, allergyIntolerance-noteOnly-note-validation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
.... extension:allergyIntoleranceType S 1..1 Coding Allergy Intolerance Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type
Binding: Type of Allergy Intolerance (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive
Binding: Status for Allergy Intolerance (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept confirmed
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... 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 Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: confirmed
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... code SΣ 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergy Intolerance Code (preferred)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Reference to Patient resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External Name of Patient
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 1..1 dateTime When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S 1..1 dateTime When allergy or intolerance was identified
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter SΣ 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note S 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reactionType S 0..1 (Complex) Allergy Intolerance Reaction Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type"
...... value[x] 1..1 Coding Value of extension
Binding: Type of Allergy Intolerance Reaction (extensible)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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: Adverse Reaction Agent . (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Intolerance Manifestation Code Value Set (extensible)
..... 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 Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-manifestation-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: Route of Administration (preferred)
.... 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.clinicalStatus Base required Status for Allergy Intolerance 📦1.0.0 This IG
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergy Intolerance Code 📦1.0.0 This IG
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​extension:reactionType.​value[x] Base extensible Type of Allergy Intolerance Reaction 📦1.0.0 This IG
AllergyIntolerance.reaction.​substance Base preferred Adverse Reaction Agent . ⏿1.1.1 tx.ontoserver.csiro.au
AllergyIntolerance.reaction.​manifestation Base extensible Allergy Intolerance Manifestation Code Value Set 📦1.0.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base preferred Route of Administration 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
allergyIntolerance-code-validation error AllergyIntolerance Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and code.coding.system = 'http://snomed.info/sct' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-eliteSportsPerson-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty()
allergyIntolerance-eliteSportsPerson-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and reaction.empty()
allergyIntolerance-noKnownAllergies-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty()
allergyIntolerance-noKnownAllergies-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and reaction.empty()
allergyIntolerance-noteOnly-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-noteOnly-note-validation error AllergyIntolerance Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and note.text.exists()
allergyIntolerance-noteOnly-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and reaction.empty()
allergyIntolerance-patient-display-validation error AllergyIntolerance Patient display must not exceed 35 characters patient.display.empty() or patient.display.length() <= 35
allergyIntolerance-pregnant-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty()
allergyIntolerance-pregnant-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and reaction.empty()
allergyIntolerance-reaction-manifestation-validation error AllergyIntolerance Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and reaction.exists() and reaction.manifestation.exists() or (extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'therapeutic' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'genericGroup' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'productCode' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'interactionClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'substanceClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'nonMedicinalSubstance')
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 AlexAllergyIntolerance

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2, allergyIntolerance-patient-display-validation, allergyIntolerance-reaction-manifestation-validation, allergyIntolerance-code-validation, allergyIntolerance-eliteSportsPerson-code-validation, allergyIntolerance-pregnant-code-validation, allergyIntolerance-noKnownAllergies-code-validation, allergyIntolerance-noteOnly-code-validation, allergyIntolerance-eliteSportsPerson-reaction-validation, allergyIntolerance-pregnant-reaction-validation, allergyIntolerance-noKnownAllergies-reaction-validation, allergyIntolerance-noteOnly-reaction-validation, allergyIntolerance-noteOnly-note-validation
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:allergyIntoleranceType S 1..1 Coding Allergy Intolerance Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type
Binding: Type of Allergy Intolerance (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive
Binding: Status for Allergy Intolerance (required)
.... coding Σ 0..* Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: confirmed
... code SΣ 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergy Intolerance Code (preferred)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
.... reference SΣC 1..1 string Reference to Patient resource
... Slices for onset[x] 1..1 dateTime When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S 1..1 dateTime When allergy or intolerance was identified
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
... asserter SΣ 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... note S 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... Slices for extension Content/Rules for all slices
..... extension:reactionType S 0..1 (Complex) Allergy Intolerance Reaction Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type
...... extension 0..0
...... url 1..1 uri "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type"
...... value[x] 1..1 Coding Value of extension
Binding: Type of Allergy Intolerance Reaction (extensible)
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Intolerance Manifestation Code Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required Status for Allergy Intolerance 📦1.0.0 This IG
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergy Intolerance Code 📦1.0.0 This IG
AllergyIntolerance.reaction.​extension:reactionType.​value[x] Base extensible Type of Allergy Intolerance Reaction 📦1.0.0 This IG
AllergyIntolerance.reaction.​manifestation Base extensible Allergy Intolerance Manifestation Code Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
allergyIntolerance-code-validation error AllergyIntolerance Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and code.coding.system = 'http://snomed.info/sct' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-eliteSportsPerson-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty()
allergyIntolerance-eliteSportsPerson-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and reaction.empty()
allergyIntolerance-noKnownAllergies-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty()
allergyIntolerance-noKnownAllergies-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and reaction.empty()
allergyIntolerance-noteOnly-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-noteOnly-note-validation error AllergyIntolerance Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and note.text.exists()
allergyIntolerance-noteOnly-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and reaction.empty()
allergyIntolerance-patient-display-validation error AllergyIntolerance Patient display must not exceed 35 characters patient.display.empty() or patient.display.length() <= 35
allergyIntolerance-pregnant-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty()
allergyIntolerance-pregnant-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and reaction.empty()
allergyIntolerance-reaction-manifestation-validation error AllergyIntolerance Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and reaction.exists() and reaction.manifestation.exists() or (extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'therapeutic' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'genericGroup' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'productCode' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'interactionClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'substanceClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'nonMedicinalSubstance')
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 AlexAllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AlexAllergyIntolerance An allergy or intolerance statement in an Australian healthcare context
Constraints: ait-1, ait-2, allergyIntolerance-patient-display-validation, allergyIntolerance-reaction-manifestation-validation, allergyIntolerance-code-validation, allergyIntolerance-eliteSportsPerson-code-validation, allergyIntolerance-pregnant-code-validation, allergyIntolerance-noKnownAllergies-code-validation, allergyIntolerance-noteOnly-code-validation, allergyIntolerance-eliteSportsPerson-reaction-validation, allergyIntolerance-pregnant-reaction-validation, allergyIntolerance-noKnownAllergies-reaction-validation, allergyIntolerance-noteOnly-reaction-validation, allergyIntolerance-noteOnly-note-validation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
.... extension:allergyIntoleranceType S 1..1 Coding Allergy Intolerance Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type
Binding: Type of Allergy Intolerance (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive
Binding: Status for Allergy Intolerance (required)
... verificationStatus ?!SΣC 1..1 CodeableConcept confirmed
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... 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 Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: confirmed
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... code SΣ 0..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergy Intolerance Code (preferred)
... patient SΣ 1..1 Reference(Patient) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Reference to Patient resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External Name of Patient
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 1..1 dateTime When allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S 1..1 dateTime When allergy or intolerance was identified
... recordedDate S 0..1 dateTime Date first version of the resource instance was recorded
... recorder S 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter SΣ 1..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note S 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reactionType S 0..1 (Complex) Allergy Intolerance Reaction Type Extension
URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type"
...... value[x] 1..1 Coding Value of extension
Binding: Type of Allergy Intolerance Reaction (extensible)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... 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: Adverse Reaction Agent . (preferred)
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Intolerance Manifestation Code Value Set (extensible)
..... 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 Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-manifestation-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: Route of Administration (preferred)
.... 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.clinicalStatus Base required Status for Allergy Intolerance 📦1.0.0 This IG
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergy Intolerance Code 📦1.0.0 This IG
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​extension:reactionType.​value[x] Base extensible Type of Allergy Intolerance Reaction 📦1.0.0 This IG
AllergyIntolerance.reaction.​substance Base preferred Adverse Reaction Agent . ⏿1.1.1 tx.ontoserver.csiro.au
AllergyIntolerance.reaction.​manifestation Base extensible Allergy Intolerance Manifestation Code Value Set 📦1.0.0 This IG
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base preferred Route of Administration 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
allergyIntolerance-code-validation error AllergyIntolerance Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and code.coding.system = 'http://www.mims.com.au/codes' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and code.coding.system = 'http://snomed.info/sct' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-eliteSportsPerson-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and code.empty()
allergyIntolerance-eliteSportsPerson-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='eliteSportsPerson' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'eliteSportsPerson' and reaction.empty()
allergyIntolerance-noKnownAllergies-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and code.empty()
allergyIntolerance-noKnownAllergies-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noKnownAllergies' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noKnownAllergies' and reaction.empty()
allergyIntolerance-noteOnly-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and code.empty()
allergyIntolerance-noteOnly-note-validation error AllergyIntolerance Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and note.text.exists()
allergyIntolerance-noteOnly-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='noteOnly' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'noteOnly' and reaction.empty()
allergyIntolerance-patient-display-validation error AllergyIntolerance Patient display must not exceed 35 characters patient.display.empty() or patient.display.length() <= 35
allergyIntolerance-pregnant-code-validation error AllergyIntolerance Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and code.empty()
allergyIntolerance-pregnant-reaction-validation error AllergyIntolerance Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code !='pregnant' or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'pregnant' and reaction.empty()
allergyIntolerance-reaction-manifestation-validation error AllergyIntolerance Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').empty() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'therapeutic' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'genericGroup' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'productCode' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'interactionClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'substanceClass' and reaction.exists() and reaction.manifestation.exists() or extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code = 'nonMedicinalSubstance' and reaction.exists() and reaction.manifestation.exists() or (extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'therapeutic' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'genericGroup' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'productCode' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'interactionClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'substanceClass' and extension.where(url='https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type').valueCoding.code != 'nonMedicinalSubstance')
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 AlexAllergyIntolerance

Summary

 

Other representations of profile: CSV, Excel, Schematron