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

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

Resource Profile: Profile_R4_AllergyIntolerance_R3

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

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 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
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 1..1 code unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (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
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... 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 AllergyIntoleranceClinicalStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntoleranceVerificationStatus 📍3.0.2 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='entered-in-error' or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... clinicalStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
... verificationStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (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
..... extension:recorder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: recorder
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... asserter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:asserter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: asserter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance 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
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 code active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
.... value 0..1 code Primitive value for code
... verificationStatus ?!ΣC 1..1 code unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... value 0..1 code Primitive value for code
... 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.
... 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: AllergyIntolerance Substance/Product, Condition and Negation Codes (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
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... assertedDate 0..1 dateTime Date record was believed accurate
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recorder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: recorder
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner) Source of the information about the allergy
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:asserter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: asserter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (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: SNOMED CT Route Codes (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 extensible Common Languages 📍3.0.2 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntoleranceClinicalStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntoleranceVerificationStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍3.0.2 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍3.0.2 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍3.0.2 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍3.0.2 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='entered-in-error' or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance 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
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!ΣC 1..1 code unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (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
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... 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 AllergyIntoleranceClinicalStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntoleranceVerificationStatus 📍3.0.2 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='entered-in-error' or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... clinicalStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
... verificationStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (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
..... extension:recorder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: recorder
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... asserter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:asserter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: asserter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance 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
.... extension:encounter 0..1 Reference(Cross-version Profile for R4.Encounter for use in FHIR STU3(0.1.0) | Encounter) R4: Encounter when the allergy or intolerance was asserted (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.encounter
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!ΣC 0..1 code active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:clinicalStatus 0..1 CodeableConcept R4: clinicalStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.clinicalStatus
Binding: AllergyIntoleranceClinicalStatus (required): The clinical status of the allergy or intolerance.
.... value 0..1 code Primitive value for code
... verificationStatus ?!ΣC 1..1 code unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:verificationStatus 0..1 CodeableConcept R4: verificationStatus additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-AllergyIntolerance.verificationStatus
Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
.... value 0..1 code Primitive value for code
... 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.
... 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: AllergyIntolerance Substance/Product, Condition and Negation Codes (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
... onset[x] 0..1 When allergy or intolerance was identified
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... assertedDate 0..1 dateTime Date record was believed accurate
... recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recorder 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: recorder
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner) Source of the information about the allergy
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:asserter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: asserter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: Substance Code (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMED CT Clinical Findings (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: SNOMED CT Route Codes (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 extensible Common Languages 📍3.0.2 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntoleranceClinicalStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntoleranceVerificationStatus 📍3.0.2 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍3.0.2 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍3.0.2 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍3.0.2 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍3.0.2 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍3.0.2 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='entered-in-error' or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus!='entered-in-error' or clinicalStatus.empty()
dom-1 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

 

Other representations of profile: CSV, Excel, Schematron