CH VACD (R4)
1.0.0 - STU 2 Ballot
CH VACD (R4)
1.0.0 - STU 2 Ballot
This page is part of the CH VACD (R4) (v1.0.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-allergyintolerances |
| Version: | 1.0.0 |
| Name: | CHVACDAllergyIntolerance |
| Title: | CH VACD AllergyIntolerance Profile |
| Status: | Draft as of 2021-06-18T09:34:15+02:00 |
| Definition: | Definition of the AllergyIntolerance part for vaccination record documents. |
| Publisher: | eHealth Suisse |
| Copyright: | CC-BY-SA-4.0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-allergyintolerances
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | 0..* | AllergyIntolerance | CH VACD Recommendation Allergy Intolerance | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  identifier | 0..* | Identifier | AllergyIntolerance item ID | |
 system | 0..1 | uri | The namespace for the identifier value | |
 value | 0..1 | string | The value that is unique | |
| code | 0..1 | CodeableConcept | Allergy Intolerance code Binding: Allergies and Intolerance values for immunization (extensible): The code for allergy. | |
 patient | 1..1 | Reference(CH Core Patient Profile) | Patient | |
| recorder | 0..1 | Reference(CH Core Practitioner Role Profile | CH Core Patient Profile) | Recorder | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | CH VACD Recommendation Allergy Intolerance |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | AllergyIntolerance item ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | Σ | 0..1 | CodeableConcept | Allergy Intolerance code Binding: Allergies and Intolerance values for immunization (extensible): The code for allergy. |
| patient | Σ | 1..1 | Reference(CH Core Patient Profile) | Patient |
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
 onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |
| recorder | 0..1 | Reference(CH Core Practitioner Role Profile | CH Core Patient Profile) | Recorder | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
 reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |
| manifestation | 1..* | CodeableConcept | Clinical 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..1 | string | Description of the event as a whole | |
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | CH VACD Recommendation Allergy Intolerance |
| Documentation for this format | ||||
This structure is derived from AllergyIntolerance
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | AllergyIntolerance | CH VACD Recommendation Allergy Intolerance | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| identifier | 0..* | Identifier | AllergyIntolerance item ID | |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | 0..1 | string | The value that is unique | |
| code | 0..1 | CodeableConcept | Allergy Intolerance code Binding: Allergies and Intolerance values for immunization (extensible): The code for allergy. | |
| patient | 1..1 | Reference(CH Core Patient Profile) | Patient | |
| recorder | 0..1 | Reference(CH Core Practitioner Role Profile | CH Core Patient Profile) | Recorder | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | I | 0..* | AllergyIntolerance | CH VACD Recommendation Allergy Intolerance |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | AllergyIntolerance item ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| verificationStatus | ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
| category | Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
| code | Σ | 0..1 | CodeableConcept | Allergy Intolerance code Binding: Allergies and Intolerance values for immunization (extensible): The code for allergy. |
| patient | Σ | 1..1 | Reference(CH Core Patient Profile) | Patient |
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
| onset[x] | 0..1 | When allergy or intolerance was identified | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |
| recorder | 0..1 | Reference(CH Core Practitioner Role Profile | CH Core Patient Profile) | Recorder | |
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| 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: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |
| manifestation | 1..* | CodeableConcept | Clinical 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..1 | string | Description of the event as a whole | |
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
| note | 0..* | Annotation | Text about event not captured in other fields | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| AllergyIntolerance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| AllergyIntolerance.identifier.use | required | IdentifierUse |
| AllergyIntolerance.identifier.type | extensible | Identifier Type Codes |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.type | required | AllergyIntoleranceType |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.code | extensible | AllergiesAndIntolerancesForImmunization |
| AllergyIntolerance.reaction.substance | example | SubstanceCode |
| AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
| Id | Path | Details | Requirements |
| ait-1 | 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 | 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 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | AllergyIntolerance.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.clinicalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.verificationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.criticality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.recordedDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.recorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.asserter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.lastOccurrence | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | AllergyIntolerance.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | AllergyIntolerance.reaction.substance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.manifestation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.onset | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.severity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.exposureRoute | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | AllergyIntolerance.reaction.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |