Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-allergyintolerance-ips | Version: 0.0.1 | |||
Active as of 2025-01-20 | Computable Name: AlexAllergyIntoleranceIps |
The allergy intolerance for IPS
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management allergyIntolerance-patient-display-validation: Patient display must not exceed 35 characters allergyIntolerance-reaction-manifestation-validation: Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected allergyIntolerance-code-validation: Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected allergyIntolerance-eliteSportsPerson-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-eliteSportsPerson-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-noteOnly-note-validation: Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Allergy Intolerance Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type Binding: Type of Allergy Intolerance (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive Binding: Status for Allergy Intolerance (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: confirmed |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergy Intolerance Code (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..1 | dateTime | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Allergy Intolerance Reaction Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: Type of Allergy Intolerance Reaction (extensible) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Allergy Intolerance Manifestation Code Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatushttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-clinical-status from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceCodehttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-code from this IG | |
AllergyIntolerance.reaction.extension:reactionType.value[x] | extensible | AllergyIntoleranceReactionTypeVshttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-reaction-type from this IG | |
AllergyIntolerance.reaction.manifestation | extensible | AllergyIntoleranceManifestationCode (a valid code from Allergy Intolerance Manifestation Code)https://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-manifestation-code from this IG |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error allergyIntolerance-patient-display-validation: Patient display must not exceed 35 characters allergyIntolerance-reaction-manifestation-validation: Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected allergyIntolerance-code-validation: Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected allergyIntolerance-eliteSportsPerson-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-eliteSportsPerson-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-noteOnly-note-validation: Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Allergy Intolerance Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type Binding: Type of Allergy Intolerance (required) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive Binding: Status for Allergy Intolerance (required) |
![]() ![]() ![]() |
?!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. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: confirmed |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergy Intolerance Code (preferred) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
![]() ![]() ![]() |
1..1 | dateTime | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..* | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Allergy Intolerance Reaction Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: Type of Allergy Intolerance Reaction (extensible) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent ![]() | |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Allergy Intolerance Manifestation Code Value Set (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) | |
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatushttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-clinical-status from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceCodehttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-code from this IG | |
AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.recorder.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.asserter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.reaction.extension:reactionType.value[x] | extensible | AllergyIntoleranceReactionTypeVshttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-reaction-type from this IG | |
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent ![]() https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | |
AllergyIntolerance.reaction.manifestation | extensible | AllergyIntoleranceManifestationCode (a valid code from Allergy Intolerance Manifestation Code)https://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-manifestation-code from this IG | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | |
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministrationhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 from this IG |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
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
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management allergyIntolerance-patient-display-validation: Patient display must not exceed 35 characters allergyIntolerance-reaction-manifestation-validation: Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected allergyIntolerance-code-validation: Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected allergyIntolerance-eliteSportsPerson-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-eliteSportsPerson-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-noteOnly-note-validation: Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Allergy Intolerance Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type Binding: Type of Allergy Intolerance (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive Binding: Status for Allergy Intolerance (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: confirmed |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergy Intolerance Code (preferred) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..1 | dateTime | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Allergy Intolerance Reaction Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: Type of Allergy Intolerance Reaction (extensible) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Allergy Intolerance Manifestation Code Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatushttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-clinical-status from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceCodehttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-code from this IG | |
AllergyIntolerance.reaction.extension:reactionType.value[x] | extensible | AllergyIntoleranceReactionTypeVshttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-reaction-type from this IG | |
AllergyIntolerance.reaction.manifestation | extensible | AllergyIntoleranceManifestationCode (a valid code from Allergy Intolerance Manifestation Code)https://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-manifestation-code from this IG |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | AlexAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error allergyIntolerance-patient-display-validation: Patient display must not exceed 35 characters allergyIntolerance-reaction-manifestation-validation: Allergy intolerance reaction.manifestation must be provided for the allergy intolerance type selected allergyIntolerance-code-validation: Allergy intolerance code.coding.system is not valid for the allergy intolerance type selected allergyIntolerance-eliteSportsPerson-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-code-validation: Allergy intolerance code is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-eliteSportsPerson-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'eliteSportsPerson' allergyIntolerance-pregnant-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'pregnant' allergyIntolerance-noKnownAllergies-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noKnownAllergies' allergyIntolerance-noteOnly-reaction-validation: Allergy intolerance reaction is not supported for the allergy intolerance type 'noteOnly' allergyIntolerance-noteOnly-note-validation: Allergy intolerance note.text is mandatory for the allergy intolerance type 'noteOnly' |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Allergy Intolerance Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-type Binding: Type of Allergy Intolerance (required) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External ids for this item |
![]() ![]() ![]() |
?!SΣC | 0..1 | CodeableConcept | active | inactive Binding: Status for Allergy Intolerance (required) |
![]() ![]() ![]() |
?!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. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: confirmed |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Allergy Intolerance Code (preferred) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
![]() ![]() ![]() |
1..1 | dateTime | When allergy or intolerance was identified Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | When allergy or intolerance was identified |
![]() ![]() ![]() |
S | 0..1 | dateTime | Date first version of the resource instance was recorded |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
Σ | 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). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..* | Annotation | Additional text not captured in other fields |
![]() ![]() ![]() |
0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Allergy Intolerance Reaction Type Extension URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/allergyintolerance-reaction-type" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: Type of Allergy Intolerance Reaction (extensible) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: https://alexapi.medtechglobal.com.au/fhir/CodeSystem/allergyintolerance-reaction-type |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent ![]() | |
![]() ![]() ![]() ![]() |
S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Allergy Intolerance Manifestation Code Value Set (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Description of the event as a whole | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date(/time) when manifestations showed | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) | |
![]() ![]() ![]() ![]() |
0..* | Annotation | Text about event not captured in other fields | |
![]() |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatushttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-clinical-status from this IG | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | preferred | AllergyIntoleranceCodehttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-code from this IG | |
AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.recorder.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.asserter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
AllergyIntolerance.reaction.extension:reactionType.value[x] | extensible | AllergyIntoleranceReactionTypeVshttps://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-reaction-type from this IG | |
AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent ![]() https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | |
AllergyIntolerance.reaction.manifestation | extensible | AllergyIntoleranceManifestationCode (a valid code from Allergy Intolerance Manifestation Code)https://alexapi.medtechglobal.com.au/fhir/ValueSet/allergyintolerance-manifestation-code from this IG | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | |
AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministrationhttps://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 from this IG |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
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
Other representations of profile: CSV, Excel, Schematron