1.0.0 - ci-build

chvacd, published by eHealth Suisse. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/ehealthsuisse/ch-vacd/ and changes regularly. See the Directory of published versions

Resource Profile: CH VACD Recommendation AllergyIntolerances Profile

Defining URL:http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-allergyintolerances
Version:1.0.0
Name:CHVACDRecommendationAllergyIntolerances
Title:CH VACD Recommendation AllergyIntolerances Profile
Status:Draft as of 11/28/21, 9:23 PM
Definition:

Definition of the AllergyIntolerance part for immunization recommendation request and response documents.

Publisher:eHealth Suisse
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-allergyintolerances

Formal Views of Profile Content

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

This structure is derived from CHAllergyIntolerance

Summary

This structure is derived from CHAllergyIntolerance

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SI0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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-uv-ips S0..1dateTimeAbatement datetime
URL: http://fhir.ch/ig/ch-allergyintolerance/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣI0..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 Σ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 Σ1..1Reference(CH Core Patient Profile)Who the sensitivity is for
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1dateTimeWhen allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder 0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)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
.... allergyintolerance-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.


.... allergyintolerance-duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... openEHR-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.


.... openEHR-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
.... openEHR-exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... openEHR-exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... openEHR-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: CH Allergy Intolerance Substance Value Set (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.


.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance I0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... abatement-dateTime-uv-ips 0..1dateTimeAbatement datetime
URL: http://fhir.ch/ig/ch-allergyintolerance/StructureDefinition/abatement-dateTime-uv-ips
... clinicalStatus ?!ΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!ΣI0..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.

... criticality Σ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 Σ1..1CodeableConceptAllergy Intolerance code
Binding: Allergies and Intolerance values for immunization (extensible): The code for allergy.

... onset[x]:onsetDateTime 0..1dateTimeWhen allergy or intolerance was identified
... reaction 0..*BackboneElementAdverse Reaction Events linked to exposure to substance
.... substance 0..1CodeableConceptSpecific substance or pharmaceutical product considered to be responsible for event
Binding: CH Allergy Intolerance Substance Value Set (preferred)
.... manifestation 1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.


.... onset 0..1dateTimeDate(/time) when manifestations showed
.... severity 0..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

This structure is derived from CHAllergyIntolerance

Summary

Differential View

This structure is derived from CHAllergyIntolerance

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AllergyIntolerance SI0..*CHAllergyIntoleranceCH VACD Recommendation Allergy Intolerance
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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-uv-ips S0..1dateTimeAbatement datetime
URL: http://fhir.ch/ig/ch-allergyintolerance/StructureDefinition/abatement-dateTime-uv-ips
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal ids for this item
... clinicalStatus ?!SΣI0..1CodeableConceptactive | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.

... verificationStatus ?!SΣI0..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 Σ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 Σ1..1Reference(CH Core Patient Profile)Who the sensitivity is for
... encounter 0..1Reference(Encounter)Encounter when the allergy or intolerance was asserted
... Slices for onset[x] 0..1dateTimeWhen allergy or intolerance was identified
Slice: Unordered, Closed by type:$this
.... onset[x]:onsetDateTime S0..1dateTimeWhen allergy or intolerance was identified
... recordedDate 0..1dateTimeDate first version of the resource instance was recorded
... recorder 0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Who recorded the sensitivity
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)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
.... allergyintolerance-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.


.... allergyintolerance-duration 0..1DurationThe amount of time that the Adverse Reaction persisted
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
.... openEHR-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.


.... openEHR-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
.... openEHR-exposureDuration 0..1DurationThe amount of time the individual was exposed to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
.... openEHR-exposureDescription 0..1stringText description about exposure to the Substance
URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
.... openEHR-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: CH Allergy Intolerance Substance Value Set (preferred)
.... manifestation S1..*CodeableConceptClinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.


.... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
AllergyIntolerance.languagepreferredCommonLanguages
Max Binding: AllLanguages
AllergyIntolerance.clinicalStatusrequiredAllergyIntoleranceClinicalStatusCodes
AllergyIntolerance.verificationStatusrequiredAllergyIntoleranceVerificationStatusCodes
AllergyIntolerance.typerequiredAllergyIntoleranceType
AllergyIntolerance.categoryrequiredAllergyIntoleranceCategory
AllergyIntolerance.criticalityrequiredAllergyIntoleranceCriticality
AllergyIntolerance.codeextensibleAllergiesAndIntolerancesForImmunization
AllergyIntolerance.reaction.substancepreferredCHAllergyIntoleranceSubstanceValueSet
AllergyIntolerance.reaction.manifestationexampleSNOMEDCTClinicalFindings
AllergyIntolerance.reaction.severityrequiredAllergyIntoleranceSeverity
AllergyIntolerance.reaction.exposureRouteexampleSNOMEDCTRouteCodes

Constraints

IdPathDetailsRequirements
ait-1AllergyIntoleranceAllergyIntolerance.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-2AllergyIntoleranceAllergyIntolerance.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-2AllergyIntoleranceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3AllergyIntoleranceIf 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-4AllergyIntoleranceIf 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-5AllergyIntoleranceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6AllergyIntoleranceA resource should have narrative for robust management
: text.`div`.exists()
ele-1AllergyIntolerance.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.extension:abatement-datetimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.extension:abatement-datetimeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.clinicalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.verificationStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.criticalityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.onset[x]:onsetDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.recordedDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.recorderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.asserterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.lastOccurrenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:certaintyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:certaintyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:durationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:locationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:exposureDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:exposureDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:exposureDurationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:exposureDurationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:exposureDescriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:exposureDescriptionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.extension:managementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.extension:managementMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1AllergyIntolerance.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1AllergyIntolerance.reaction.substanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.manifestationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.onsetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.severityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.exposureRouteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1AllergyIntolerance.reaction.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())