Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_AllergyIntolerance_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-AllergyIntolerance Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_AllergyIntolerance_R4

This cross-version profile allows R5 AllergyIntolerance content to be represented via FHIR R4 AllergyIntolerance resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... verificationStatus ?!Σ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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
... verificationStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
.... manifestation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:manifestation 0..* Reference(Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation) R5: manifestation additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.reaction.manifestation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ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.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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 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 Σ 1..1 Reference(Patient) Who the sensitivity is for
... 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(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:manifestation 1..* Reference(Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation) R5: manifestation additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.reaction.manifestation
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.extension:participant, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.verificationStatus.extension, AllergyIntolerance.verificationStatus.extension:verificationStatus, AllergyIntolerance.verificationStatus.coding, AllergyIntolerance.verificationStatus.text, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.asserter, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.manifestation.extension, AllergyIntolerance.reaction.manifestation.extension:manifestation, AllergyIntolerance.reaction.manifestation.coding, AllergyIntolerance.reaction.manifestation.text, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:participant, AllergyIntolerance.modifierExtension, AllergyIntolerance.verificationStatus.extension, AllergyIntolerance.verificationStatus.extension:verificationStatus, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.manifestation.extension, AllergyIntolerance.reaction.manifestation.extension:manifestation Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... verificationStatus ?!Σ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.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
... verificationStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
.... manifestation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:manifestation 0..* Reference(Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation) R5: manifestation additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.reaction.manifestation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.0.1) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Constraints: ait-1, ait-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:participant 0..* (Complex) R5: Who or what participated in the activities related to the allergy or intolerance and how they were involved (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.participant
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!Σ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.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:verificationStatus 0..1 CodeableConcept R5: unconfirmed | presumed | confirmed | refuted | entered-in-error
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.type
Binding: AllergyIntoleranceType (preferred): Identification of the underlying physiological mechanism for a Reaction Risk.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... 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 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 Σ 1..1 Reference(Patient) Who the sensitivity is for
... 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(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:manifestation 1..* Reference(Cross-version Profile for R5.Observation for use in FHIR R4(0.1.0) | Observation) R5: manifestation additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AllergyIntolerance.reaction.manifestation
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error AllergyIntolerance.meta, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.extension, AllergyIntolerance.extension:participant, AllergyIntolerance.modifierExtension, AllergyIntolerance.identifier, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.verificationStatus.extension, AllergyIntolerance.verificationStatus.extension:verificationStatus, AllergyIntolerance.verificationStatus.coding, AllergyIntolerance.verificationStatus.text, AllergyIntolerance.type, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.asserter, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.manifestation.extension, AllergyIntolerance.reaction.manifestation.extension:manifestation, AllergyIntolerance.reaction.manifestation.coding, AllergyIntolerance.reaction.manifestation.text, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:participant, AllergyIntolerance.modifierExtension, AllergyIntolerance.verificationStatus.extension, AllergyIntolerance.verificationStatus.extension:verificationStatus, AllergyIntolerance.type.extension, AllergyIntolerance.type.extension:type, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.manifestation.extension, AllergyIntolerance.reaction.manifestation.extension:manifestation Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron