SMART Base Clinical
1.0.0 - ci-build
SMART Base Clinical, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base-clinical/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/base-clinical/StructureDefinition/sg-allergyintolerance | Version: 1.0.0 | |||
Draft as of 2024-12-02 | Computable Name: SGAllergyIntolerance |
The WHO SMART Guidelines AllergyIntolerance profile defines conformance requirements and exchange expectations for AllergyIntolerance resources in WHO Smart Guidelines content.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ali-1: extension: reasonRefuted is only permitted if status is refuted |
Slices for extension | Content/Rules for all slices | |||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
identifier | S | 1..* | Identifier | External ids for this item |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
category | S | 0..* | code | food | medication | environment | biologic |
criticality | S | 0..1 | code | low | high | unable-to-assess |
code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
patient | S | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for |
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity |
asserter | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Source of the information about the allergy |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
Slices for extension | Content/Rules for all slices | |||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error ali-1: extension: reasonRefuted is only permitted if status is refuted |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External ids for this item |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
criticality | SΣ | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for |
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity |
asserter | SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Source of the information about the allergy |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
Slices for extension | Content/Rules for all slices | |||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
manifestation | S | 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. |
onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | S | 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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | |
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error ali-1: extension: reasonRefuted is only permitted if status is refuted | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | ||||
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | External ids for this item | ||||
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 | ?!SΣ | 1..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 | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..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 | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
criticality | SΣ | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. | ||||
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for | ||||
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||||||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded | ||||
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity | ||||
asserter | SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | 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 | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | ||||
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 | S | 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 | S | 0..1 | dateTime | Date(/time) when manifestations showed | ||||
severity | S | 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 |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').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 AllergyIntolerance
Summary
Mandatory: 6 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ali-1: extension: reasonRefuted is only permitted if status is refuted |
Slices for extension | Content/Rules for all slices | |||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
identifier | S | 1..* | Identifier | External ids for this item |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
clinicalStatus | S | 0..1 | CodeableConcept | active | inactive | resolved |
verificationStatus | S | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error |
type | S | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) |
category | S | 0..* | code | food | medication | environment | biologic |
criticality | S | 0..1 | code | low | high | unable-to-assess |
code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
patient | S | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for |
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity |
asserter | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Source of the information about the allergy |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
Slices for extension | Content/Rules for all slices | |||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').empty() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error ali-1: extension: reasonRefuted is only permitted if status is refuted |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge |
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External ids for this item |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. |
category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
criticality | SΣ | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for |
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded |
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity |
asserter | SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Source of the information about the allergy |
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
Slices for extension | Content/Rules for all slices | |||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
manifestation | S | 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. |
onset | S | 0..1 | dateTime | Date(/time) when manifestations showed |
severity | S | 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. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | |
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | |
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | |
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard | |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | SC | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error ali-1: extension: reasonRefuted is only permitted if status is refuted | ||||
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
resolutionAge | S | 0..1 | Age | Age that the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge | ||||
reasonRefuted | SC | 0..1 | CodeableConcept | Explanation associated with refuted status URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | External ids for this item | ||||
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 | ?!SΣ | 1..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 | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..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 | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
type | SΣ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | SΣ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
criticality | SΣ | 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 | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. | ||||
patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who the sensitivity is for | ||||
encounter | S | 0..1 | Reference(WHO SMART Guidelines 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 | |||||||
recordedDate | S | 0..1 | dateTime | Date first version of the resource instance was recorded | ||||
recorder | S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who recorded the sensitivity | ||||
asserter | SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | 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 | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
reaction-duration | S | 0..1 | Duration | How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration | ||||
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 | S | 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 | S | 0..1 | dateTime | Date(/time) when manifestations showed | ||||
severity | S | 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 |
Path | Conformance | ValueSet | URI | |||
AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
AllergyIntolerance.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
ali-1 | error | AllergyIntolerance | extension: reasonRefuted is only permitted if status is refuted : verificationStatus.coding.code.contains('refuted') or extension.where(url='http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted').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 AllergyIntolerance
Summary
Mandatory: 6 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron