ImplementationGuide for Malaysia Core (MY Core)
0.0.1 - CI Build

ImplementationGuide for Malaysia Core (MY Core), published by Malaysia Healthcare Nexus (MHN). This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nhphong245/my-core-ig-r4/ and changes regularly. See the Directory of published versions

Resource Profile: AllergyIntolerance (MY Core)

Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/AllergyIntolerance-my-core Version: 0.0.1
Active as of 2024-03-13 Responsible: Malaysia Healthcare Nexus (MHN) Realm: International flag Computable Name: AllergyIntoleranceMyCore

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... category 1..1 code food | medication | environment | biologic
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded
... reaction
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ValueSetDrug (MY Core) (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: value-set-allergy-manifestation-my-core (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG
AllergyIntolerance.reaction.substanceexampleValueSetDrugMyCore (a valid code from CodeSystemDrug (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/drug-my-core
from this IG
AllergyIntolerance.reaction.manifestationexampleValueSetAllergyManifestationMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-manifestation-my-core
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... category Σ 1..1 code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... code Σ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: ValueSetAllergyCode (MY Core) (example)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category Σ 1..1 code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: ValueSetAllergyCode (MY Core) (example)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
.... 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: ValueSetDrug (MY Core) (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: value-set-allergy-manifestation-my-core (example)
.... 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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG
AllergyIntolerance.reaction.substanceexampleValueSetDrugMyCore (a valid code from CodeSystemDrug (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/drug-my-core
from this IG
AllergyIntolerance.reaction.manifestationexampleValueSetAllergyManifestationMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-manifestation-my-core
from this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 5 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... category 1..1 code food | medication | environment | biologic
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded
... reaction
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: ValueSetDrug (MY Core) (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: value-set-allergy-manifestation-my-core (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG
AllergyIntolerance.reaction.substanceexampleValueSetDrugMyCore (a valid code from CodeSystemDrug (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/drug-my-core
from this IG
AllergyIntolerance.reaction.manifestationexampleValueSetAllergyManifestationMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-manifestation-my-core
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... category Σ 1..1 code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... code Σ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: ValueSetAllergyCode (MY Core) (example)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance C 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category Σ 1..1 code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


... criticality Σ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

... code Σ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: ValueSetAllergyCode (MY Core) (example)
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 1..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... formulary 1..1 boolean An extension whether this Resource is based on a coded concept or is a non coded Resource
URL: http://fhir.hie.moh.gov.my/StructureDefinition/formulary-boolean-my-core
.... 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: ValueSetDrug (MY Core) (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: value-set-allergy-manifestation-my-core (example)
.... 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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1
from the FHIR Standard
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1
from the FHIR Standard
AllergyIntolerance.typerequiredAllergyIntoleranceType
http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1
from the FHIR Standard
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1
from the FHIR Standard
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1
from the FHIR Standard
AllergyIntolerance.codeexampleValueSetAllergyCodeMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-code-my-core
from this IG
AllergyIntolerance.reaction.substanceexampleValueSetDrugMyCore (a valid code from CodeSystemDrug (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/drug-my-core
from this IG
AllergyIntolerance.reaction.manifestationexampleValueSetAllergyManifestationMyCore
http://fhir.hie.moh.gov.my/ValueSet/allergy-manifestation-my-core
from this IG
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1
from the FHIR Standard
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ait-1errorAllergyIntoleranceAllergyIntolerance.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-2errorAllergyIntoleranceAllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
: verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2errorAllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAllergyIntoleranceIf 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-4errorAllergyIntoleranceIf 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-5errorAllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 5 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron