Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R2_AllergyIntolerance_R4B

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

This cross-version profile allows DSTU2 AllergyIntolerance content to be represented via FHIR R4B 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(4.3.0) 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:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
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.
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.3.0 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.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
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.exists() and ('#'+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(uri) = '#').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:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.patient, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient 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.3.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
.... modifierExtension:status 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.identifier
... category
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:category 0..1 code DSTU2: food | medication | environment | other - Category of Substance
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.category
Binding: R2AllergyIntoleranceCategoryForR4B (0.1.0) (required): Category of an identified Substance.
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recorder
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recorder 0..1 Reference(Resource) DSTU2: recorder additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... asserter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reporter 0..1 Reference(Resource) DSTU2: reporter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.note
... reaction
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:certainty 0..1 code DSTU2: unlikely | likely | confirmed - clinical certainty about the specific substance (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.certainty
Binding: AllergyIntoleranceCertainty (required): Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.
.... note
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.note

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
Constraints: ext-1
... identifier Σ 0..* Identifier External ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ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.
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
.... 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:category 0..1 code DSTU2: food | medication | environment | other - Category of Substance
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.category
Binding: R2AllergyIntoleranceCategoryForR4B (0.1.0) (required): Category of an identified Substance.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:recorder 0..1 Reference(Resource) DSTU2: recorder additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... 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 | PractitionerRole) Source of the information about the allergy
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reporter 0..1 Reference(Resource) DSTU2: reporter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 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
Constraints: ext-1
..... extension:certainty 0..1 code DSTU2: unlikely | likely | confirmed - clinical certainty about the specific substance (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.certainty
Binding: AllergyIntoleranceCertainty (required): Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.
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.
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.note
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.meta.​security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
AllergyIntolerance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
AllergyIntolerance.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.3.0 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 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.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning AllergyIntolerance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error AllergyIntolerance.meta, AllergyIntolerance.meta.extension, AllergyIntolerance.meta.extension:meta, AllergyIntolerance.meta.versionId, AllergyIntolerance.meta.lastUpdated, AllergyIntolerance.meta.source, AllergyIntolerance.meta.profile, AllergyIntolerance.meta.security, AllergyIntolerance.meta.tag, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.text.extension, AllergyIntolerance.text.extension:text, AllergyIntolerance.text.status, AllergyIntolerance.text.div, AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.identifier, AllergyIntolerance.identifier.extension, AllergyIntolerance.identifier.extension:identifier, AllergyIntolerance.identifier.use, AllergyIntolerance.identifier.type, AllergyIntolerance.identifier.system, AllergyIntolerance.identifier.value, AllergyIntolerance.identifier.period, AllergyIntolerance.identifier.assigner, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.category.extension, AllergyIntolerance.category.extension:category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient, AllergyIntolerance.patient.reference, AllergyIntolerance.patient.type, AllergyIntolerance.patient.identifier, AllergyIntolerance.patient.display, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.recorder.extension, AllergyIntolerance.recorder.extension:recorder, AllergyIntolerance.recorder.reference, AllergyIntolerance.recorder.type, AllergyIntolerance.recorder.identifier, AllergyIntolerance.recorder.display, AllergyIntolerance.asserter, AllergyIntolerance.asserter.extension, AllergyIntolerance.asserter.extension:reporter, AllergyIntolerance.asserter.reference, AllergyIntolerance.asserter.type, AllergyIntolerance.asserter.identifier, AllergyIntolerance.asserter.display, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.note.extension, AllergyIntolerance.note.extension:note, AllergyIntolerance.note.author[x], AllergyIntolerance.note.time, AllergyIntolerance.note.text, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.extension:certainty, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note, AllergyIntolerance.reaction.note.extension, AllergyIntolerance.reaction.note.extension:note, AllergyIntolerance.reaction.note.author[x], AllergyIntolerance.reaction.note.time, AllergyIntolerance.reaction.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.meta.extension, AllergyIntolerance.meta.extension:meta, AllergyIntolerance.text.extension, AllergyIntolerance.text.extension:text, AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.identifier.extension, AllergyIntolerance.identifier.extension:identifier, AllergyIntolerance.category.extension, AllergyIntolerance.category.extension:category, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient, AllergyIntolerance.recorder.extension, AllergyIntolerance.recorder.extension:recorder, AllergyIntolerance.asserter.extension, AllergyIntolerance.asserter.extension:reporter, AllergyIntolerance.note.extension, AllergyIntolerance.note.extension:note, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.extension:certainty, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.note.extension, AllergyIntolerance.reaction.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error AllergyIntolerance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error AllergyIntolerance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.3.0) 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:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
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.
... patient Σ 1..1 Reference(Patient) Who the sensitivity is for
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.3.0 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.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
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.exists() and ('#'+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(uri) = '#').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:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.patient, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient 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.3.0) Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
.... modifierExtension:status 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.identifier
... category
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:category 0..1 code DSTU2: food | medication | environment | other - Category of Substance
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.category
Binding: R2AllergyIntoleranceCategoryForR4B (0.1.0) (required): Category of an identified Substance.
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... recorder
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:recorder 0..1 Reference(Resource) DSTU2: recorder additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... asserter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reporter 0..1 Reference(Resource) DSTU2: reporter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.note
... reaction
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:certainty 0..1 code DSTU2: unlikely | likely | confirmed - clinical certainty about the specific substance (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.certainty
Binding: AllergyIntoleranceCertainty (required): Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.
.... note
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.note

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:recordedDate 0..1 dateTime DSTU2: When recorded (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.recordedDate
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code DSTU2: active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.status
Binding: AllergyIntoleranceClinicalStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.
Constraints: ext-1
... identifier Σ 0..* Identifier External ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!Σ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.
... type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
.... 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:category 0..1 code DSTU2: food | medication | environment | other - Category of Substance
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.category
Binding: R2AllergyIntoleranceCategoryForR4B (0.1.0) (required): Category of an identified Substance.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:recorder 0..1 Reference(Resource) DSTU2: recorder additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... 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 | PractitionerRole) Source of the information about the allergy
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reporter 0..1 Reference(Resource) DSTU2: reporter
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... reaction 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
Constraints: ext-1
..... extension:certainty 0..1 code DSTU2: unlikely | likely | confirmed - clinical certainty about the specific substance (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.certainty
Binding: AllergyIntoleranceCertainty (required): Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.
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.
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-AllergyIntolerance.reaction.note
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.meta.​security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
AllergyIntolerance.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
AllergyIntolerance.language Base preferred Common Languages 📍4.3.0 FHIR Std.
AllergyIntolerance.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
AllergyIntolerance.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📍4.3.0 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📍4.3.0 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.3.0 FHIR Std.
AllergyIntolerance.code Base example AllergyIntolerance Substance/Product, Condition and Negation Codes 📍4.3.0 FHIR Std.
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.3.0 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.3.0 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.exists() and verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code='entered-in-error').exists().not()) implies 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').exists()) implies clinicalStatus.exists().not()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning AllergyIntolerance.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error AllergyIntolerance.meta, AllergyIntolerance.meta.extension, AllergyIntolerance.meta.extension:meta, AllergyIntolerance.meta.versionId, AllergyIntolerance.meta.lastUpdated, AllergyIntolerance.meta.source, AllergyIntolerance.meta.profile, AllergyIntolerance.meta.security, AllergyIntolerance.meta.tag, AllergyIntolerance.implicitRules, AllergyIntolerance.language, AllergyIntolerance.text, AllergyIntolerance.text.extension, AllergyIntolerance.text.extension:text, AllergyIntolerance.text.status, AllergyIntolerance.text.div, AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.identifier, AllergyIntolerance.identifier.extension, AllergyIntolerance.identifier.extension:identifier, AllergyIntolerance.identifier.use, AllergyIntolerance.identifier.type, AllergyIntolerance.identifier.system, AllergyIntolerance.identifier.value, AllergyIntolerance.identifier.period, AllergyIntolerance.identifier.assigner, AllergyIntolerance.clinicalStatus, AllergyIntolerance.verificationStatus, AllergyIntolerance.type, AllergyIntolerance.category, AllergyIntolerance.category.extension, AllergyIntolerance.category.extension:category, AllergyIntolerance.criticality, AllergyIntolerance.code, AllergyIntolerance.patient, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient, AllergyIntolerance.patient.reference, AllergyIntolerance.patient.type, AllergyIntolerance.patient.identifier, AllergyIntolerance.patient.display, AllergyIntolerance.encounter, AllergyIntolerance.onset[x], AllergyIntolerance.recordedDate, AllergyIntolerance.recorder, AllergyIntolerance.recorder.extension, AllergyIntolerance.recorder.extension:recorder, AllergyIntolerance.recorder.reference, AllergyIntolerance.recorder.type, AllergyIntolerance.recorder.identifier, AllergyIntolerance.recorder.display, AllergyIntolerance.asserter, AllergyIntolerance.asserter.extension, AllergyIntolerance.asserter.extension:reporter, AllergyIntolerance.asserter.reference, AllergyIntolerance.asserter.type, AllergyIntolerance.asserter.identifier, AllergyIntolerance.asserter.display, AllergyIntolerance.lastOccurrence, AllergyIntolerance.note, AllergyIntolerance.note.extension, AllergyIntolerance.note.extension:note, AllergyIntolerance.note.author[x], AllergyIntolerance.note.time, AllergyIntolerance.note.text, AllergyIntolerance.reaction, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.extension:certainty, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.substance, AllergyIntolerance.reaction.manifestation, AllergyIntolerance.reaction.description, AllergyIntolerance.reaction.onset, AllergyIntolerance.reaction.severity, AllergyIntolerance.reaction.exposureRoute, AllergyIntolerance.reaction.note, AllergyIntolerance.reaction.note.extension, AllergyIntolerance.reaction.note.extension:note, AllergyIntolerance.reaction.note.author[x], AllergyIntolerance.reaction.note.time, AllergyIntolerance.reaction.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AllergyIntolerance.meta.extension, AllergyIntolerance.meta.extension:meta, AllergyIntolerance.text.extension, AllergyIntolerance.text.extension:text, AllergyIntolerance.extension, AllergyIntolerance.extension:recordedDate, AllergyIntolerance.modifierExtension, AllergyIntolerance.modifierExtension:status, AllergyIntolerance.identifier.extension, AllergyIntolerance.identifier.extension:identifier, AllergyIntolerance.category.extension, AllergyIntolerance.category.extension:category, AllergyIntolerance.patient.extension, AllergyIntolerance.patient.extension:patient, AllergyIntolerance.recorder.extension, AllergyIntolerance.recorder.extension:recorder, AllergyIntolerance.asserter.extension, AllergyIntolerance.asserter.extension:reporter, AllergyIntolerance.note.extension, AllergyIntolerance.note.extension:note, AllergyIntolerance.reaction.extension, AllergyIntolerance.reaction.extension:certainty, AllergyIntolerance.reaction.modifierExtension, AllergyIntolerance.reaction.note.extension, AllergyIntolerance.reaction.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error AllergyIntolerance.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error AllergyIntolerance.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron