Implementation Guide CH VACD
4.0.1 - trial-use Switzerland flag

This page is part of the CH VACD (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH VACD AllergyIntolerance

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-allergyintolerances Version: 4.0.1
Draft as of 2023-12-28 Computable Name: CHVACDAllergyIntolerance

Copyright/Legal: CC0-1.0

Definition of the AllergyIntolerance part for vaccination record documents.

Duplicate Conflict

By aggregation of different Immunization Administration documents, dupplicates could be detected. If so, the entries in the Vaccination Record document (as result of the aggregation) should be completed with the extension CH VACD Extension Merging Conflict Entry Reference. The criterias of duplicate detection can be found here.

Usage:

Formal Views of Profile Content

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

This structure is derived from CHAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SC0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... abatement-datetime S0..1dateTimeAbatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierAllergyIntolerance item ID
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


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

... code SΣ1..1CodeableConceptAllergy Intolerance code
Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.

... patient SΣ1..1Reference(CH Core Patient)Patient
... Slices for onset[x] 0..1When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recorder S0..1Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson)Recorder
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... certainty 0..1CodeableConceptcertainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.


.... duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... location 0..1CodeableConceptThe anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality.


.... exposureDate 0..1dateTimeRecord of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
.... exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... management 0..1stringText description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible)
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleAllergiesAndIntolerancesForImmunization
AllergyIntolerance.reaction.substanceextensibleCHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestationextensibleCHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity

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 SC0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... abatement-datetime S0..1dateTimeAbatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... conflict 0..*(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierAllergyIntolerance item ID
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


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

... code SΣ1..1CodeableConceptAllergy Intolerance code
Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.

... patient SΣ1..1Reference(CH Core Patient)Patient
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder S0..1Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson)Recorder
... asserter Σ0..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... certainty 0..1CodeableConceptcertainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.


.... duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... location 0..1CodeableConceptThe anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality.


.... exposureDate 0..1dateTimeRecord of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
.... exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... management 0..1stringText description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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..1CodeableConceptHow 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..*AnnotationText about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleAllergiesAndIntolerancesForImmunization
AllergyIntolerance.reaction.substanceextensibleCHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestationextensibleCHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes

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()

Differential View

This structure is derived from CHAllergyIntolerance

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SC0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... abatement-datetime S0..1dateTimeAbatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierAllergyIntolerance item ID
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


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

... code SΣ1..1CodeableConceptAllergy Intolerance code
Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.

... patient SΣ1..1Reference(CH Core Patient)Patient
... Slices for onset[x] 0..1When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recorder S0..1Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson)Recorder
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... certainty 0..1CodeableConceptcertainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.


.... duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... location 0..1CodeableConceptThe anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality.


.... exposureDate 0..1dateTimeRecord of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
.... exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... management 0..1stringText description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible)
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleAllergiesAndIntolerancesForImmunization
AllergyIntolerance.reaction.substanceextensibleCHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestationextensibleCHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity

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 SC0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... abatement-datetime S0..1dateTimeAbatement datetime
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... conflict 0..*(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierAllergyIntolerance item ID
... clinicalStatus ?!SΣC0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣC0..1CodeableConceptunconfirmed | 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 SΣ0..1codeallergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.

... category SΣ0..*codefood | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.


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

... code SΣ1..1CodeableConceptAllergy Intolerance code
Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.

... patient SΣ1..1Reference(CH Core Patient)Patient
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1When allergy or intolerance was identified
Slice: Unordered, Open by type:$this
.... onsetDateTimedateTime
.... onsetAgeAge
.... onsetPeriodPeriod
.... onsetRangeRange
.... onsetStringstring
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder S0..1Reference(CH Core PractitionerRole | CH Core Patient | RelatedPerson)Recorder
... asserter Σ0..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)Source of the information about the allergy
... lastOccurrence 0..1dateTimeDate(/time) of last known occurrence of a reaction
... note 0..*AnnotationAdditional text not captured in other fields
... reaction S0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... certainty 0..1CodeableConceptcertainty: Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.


.... duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... location 0..1CodeableConceptThe anatomical location / body site(s) where the symptoms manifested
URL: http://hl7.org/fhir/StructureDefinition/openEHR-location
Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality.


.... exposureDate 0..1dateTimeRecord of the date and/or time of the first exposure to the Substance for this Reaction Event.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
.... exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... management 0..1stringText description about the clinical management provided.
URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance S0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: CHAllergyIntoleranceReactionSubstanceValueSet (extensible)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: CHAllergyIntoleranceReactionManifestationValueSet (extensible)
.... description 0..1stringDescription of the event as a whole
.... onset S0..1dateTimeDate(/time) when manifestations showed
.... severity S0..1codemild | 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..1CodeableConceptHow 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..*AnnotationText about event not captured in other fields

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleAllergiesAndIntolerancesForImmunization
AllergyIntolerance.reaction.substanceextensibleCHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestationextensibleCHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes

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()

 

Other representations of profile: CSV, Excel, Schematron