Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XIB AllergyIntolerance

Official URL: https://fhir.cumuluz.org/xib/StructureDefinition/xib-AllergyIntolerance Version: 0.1.0
Draft as of 2026-07-11 Computable Name: XibAllergyIntolerance

XIB allergy intolerance target profile based on EU Base AllergyIntolerance with implemented nl-core data points.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension Content/regels voor alle slices
.... extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
Url: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
..... extension 0..0 Extension
Slice: Zonder volgorde, Open op value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices voor value[x] 1..1 Value of extension
Slice: Zonder volgorde, Open op type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS . (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additionele bindingsDoel
eHDSI Allergen No Drug . Voorkeur
WHO ATC - IPS . Voorkeur
... patient SΣ 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
... Slices voor onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Zonder volgorde, Open op type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Onset date
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS . (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additionele bindingsDoel
eHDSI Reaction Allergy . Voorkeur


doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergies & Intolerances - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS . ⏿2.0.0 tx.hl7europe.eu

Constrains

Id Grade Pad(en) Omschrijving Expressie
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuCore

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S 0..1 CodeableConcept Current allergy or Intolerance status
... verificationStatus S 0..1 CodeableConcept Certainty
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
... recorder
.... Slices voor extension Content/regels voor alle slices
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... asserter
.... Slices voor extension Content/regels voor alle slices
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note
.... Slices voor author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Zonder volgorde, Open op type:$this
..... author[x]:authorReference 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
...... Slices voor extension Content/regels voor alle slices
....... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance

doco Documentatie voor dit formaat
NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
Url: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Zonder volgorde, Open op value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices voor value[x] 1..1 Value of extension
Slice: Zonder volgorde, Open op type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for the allergy or intolerance
... clinicalStatus ?!SΣC 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Criticality
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS . (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additionele bindingsDoel
eHDSI Allergen No Drug . Voorkeur
WHO ATC - IPS . Voorkeur
... patient SΣ 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices voor onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Zonder volgorde, Open op type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Onset date
... recordedDate 0..1 dateTime Date when the allergy or intolerance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the allergy or intolerance
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who asserts the allergy or intolerance
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
.... Slices voor author[x] Σ 0..1 Individual responsible for the annotation
Slice: Zonder volgorde, Open op type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorReference Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
...... id 0..1 string Unique id for inter-element referencing
...... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
....... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Additional information about the allergy or intolerance
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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: eHDSI Allergen No Drug . (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS . (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additionele bindingsDoel
eHDSI Reaction Allergy . Voorkeur

.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Reaction onset
.... severity 0..1 code Reaction severity
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 Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergies & Intolerances - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.note.​author[x]:authorReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example eHDSI Allergen No Drug . ⏿0.2.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuCore

Samenvatting

Moet-ondersteunen: 5 elements

Structuren

Deze structuur verwijst naar deze andere structuren:

Extensies

Deze structuur verwijst naar deze extensies:

Slices

Deze structuur definieert de volgende Slices:

  • Het element 1 is gesliced op de waarden van AllergyIntolerance.note.author[x]

Key Elements View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension Content/regels voor alle slices
.... extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
Url: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
..... extension 0..0 Extension
Slice: Zonder volgorde, Open op value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices voor value[x] 1..1 Value of extension
Slice: Zonder volgorde, Open op type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS . (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additionele bindingsDoel
eHDSI Allergen No Drug . Voorkeur
WHO ATC - IPS . Voorkeur
... patient SΣ 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
... Slices voor onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Zonder volgorde, Open op type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Onset date
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS . (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additionele bindingsDoel
eHDSI Reaction Allergy . Voorkeur


doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergies & Intolerances - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS . ⏿2.0.0 tx.hl7europe.eu

Constrains

Id Grade Pad(en) Omschrijving Expressie
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AllergyIntoleranceEuCore

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... clinicalStatus S 0..1 CodeableConcept Current allergy or Intolerance status
... verificationStatus S 0..1 CodeableConcept Certainty
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
... recorder
.... Slices voor extension Content/regels voor alle slices
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... asserter
.... Slices voor extension Content/regels voor alle slices
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note
.... Slices voor author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Zonder volgorde, Open op type:$this
..... author[x]:authorReference 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
...... Slices voor extension Content/regels voor alle slices
....... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance

doco Documentatie voor dit formaat

Snapshot View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntoleranceEuCore Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:abatement 0..1 (Complex) When the allergy or intolerance resolved
Url: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Zonder volgorde, Open op value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices voor value[x] 1..1 Value of extension
Slice: Zonder volgorde, Open op type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for the allergy or intolerance
... clinicalStatus ?!SΣC 0..1 CodeableConcept Current allergy or Intolerance status
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept Certainty
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type Σ 0..1 code Type of propensity
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality Σ 0..1 code Criticality
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: Allergies & Intolerances - IPS . (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy.
Additionele bindingsDoel
eHDSI Allergen No Drug . Voorkeur
WHO ATC - IPS . Voorkeur
... patient SΣ 1..1 Reference(Patient (EU core)) Who the allergy or intolerance concerns
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... Slices voor onset[x] 0..1 Date of onset of the allergy or intolerance
Slice: Zonder volgorde, Open op type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
.... onset[x]:onsetDateTime 0..1 dateTime Onset date
... recordedDate 0..1 dateTime Date when the allergy or intolerance was recorded
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the allergy or intolerance
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who asserts the allergy or intolerance
.... id 0..1 string Unique id for inter-element referencing
.... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
..... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
... note 0..* Annotation Additional text not captured in other fields
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
.... Slices voor author[x] Σ 0..1 Individual responsible for the annotation
Slice: Zonder volgorde, Open op type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorReference Σ 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization) Individual responsible for the annotation
...... id 0..1 string Unique id for inter-element referencing
...... Slices voor extension 0..* Extension Additional content defined by implementations
Slice: Zonder volgorde, Open op value:url
....... extension:practitionerRole 0..1 Reference(PractitionerRole) Dutch PractitionerRole Reference
Url: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Additional information about the allergy or intolerance
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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: eHDSI Allergen No Drug . (example)
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: Allergy Reaction - IPS . (preferred): Type of allergy or intolerance reaction expected to be used in MyHealth@EU
Additionele bindingsDoel
eHDSI Reaction Allergy . Voorkeur

.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Reaction onset
.... severity 0..1 code Reaction severity
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 Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred Allergies & Intolerances - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.note.​author[x]:authorReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example eHDSI Allergen No Drug . ⏿0.2.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​manifestation Base preferred Allergy Reaction - IPS . ⏿2.0.0 tx.hl7europe.eu
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntoleranceEuCore

Samenvatting

Moet-ondersteunen: 5 elements

Structuren

Deze structuur verwijst naar deze andere structuren:

Extensies

Deze structuur verwijst naar deze extensies:

Slices

Deze structuur definieert de volgende Slices:

  • Het element 1 is gesliced op de waarden van AllergyIntolerance.note.author[x]

 

Other representations of profile: CSV, Excel, Schematron