De-identified, Anonymized FHIR Profiles Library
1.0.0-ballot - STU 1 Ballot United States of America flag

This page is part of the De-identified, Anonymized FHIR Profiles Library (DAPL) IG (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: DAPL De-identified AllergyIntolerance

Official URL: http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-deidentified-allergyintolerance Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: DAPLDeidentifiedAllergyIntolerance

The profile establishes the core elements, extensions, vocabularies and value sets for representing de-identified Allergies and Intolerances.

Introduction

This profile is used to represent de-identified AllergyIntolerance information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

According to the HHS guidance, dates should not have a precision of more than the year. This means month and day cannot be included. This includes AllergyIntolerance.recorded and onset elements.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a AllergyIntolerance resource text element may contain information such as the AllergyIntolerance dates, patient information. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original AllergyIntolerance resource id should not be included in the De-identified AllergyIntolerance instance. Instead a new id should be created and provided as part of the FHIR resource. The Data Submitter should be capable of using the generated id to relink the data to the original AllergyIntolerance. All resource references to the AllergyIntolerance submitted as part of the data exchange should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

  • patient

Date Truncation

The DARTS Service Provider has to truncate the following dates to only have a precision of year

  • onset
  • recordedDate

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 DAPL AllergyIntolerance
Constraints: ait-1, ait-2
... id SΣ 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient SΣ 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

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.
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 extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24
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.

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()
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance DAPL AllergyIntolerance
... id S 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... text 0..0 Cannot include any text in the resource as part of the de-identified or anonymized data.
... contained 0..0 Cannot include any contained resources in the resource as part of the de-identified or anonymized data.
... verificationStatus S 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
... type S 0..1 code allergy | intolerance - Underlying mechanism (if known)
... category S 0..* code food | medication | environment | biologic
... criticality S 0..1 code low | high | unable-to-assess
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient S 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
.... display 0..0 Text alternative for the resource
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... recorder
.... display 0..0 Text alternative for the resource
... asserter
.... display 0..0 Text alternative for the resource
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... note 0..0 Additional text not captured in other fields
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
.... note 0..0 Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.code Base extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24

Constraints

Id Grade Path(s) Description Expression
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance DAPL AllergyIntolerance
Constraints: ait-1, ait-2
... id SΣ 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient SΣ 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
.... description 0..1 string Description of the event as a whole
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
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 extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍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()
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance DAPL AllergyIntolerance
Constraints: ait-1, ait-2
... id SΣ 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient SΣ 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

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.
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 extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24
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.

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()
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AllergyIntolerance

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* AllergyIntolerance DAPL AllergyIntolerance
... id S 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... text 0..0 Cannot include any text in the resource as part of the de-identified or anonymized data.
... contained 0..0 Cannot include any contained resources in the resource as part of the de-identified or anonymized data.
... verificationStatus S 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
... type S 0..1 code allergy | intolerance - Underlying mechanism (if known)
... category S 0..* code food | medication | environment | biologic
... criticality S 0..1 code low | high | unable-to-assess
... code S 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient S 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
.... display 0..0 Text alternative for the resource
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... recorder
.... display 0..0 Text alternative for the resource
... asserter
.... display 0..0 Text alternative for the resource
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... note 0..0 Additional text not captured in other fields
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
.... note 0..0 Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AllergyIntolerance.code Base extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24

Constraints

Id Grade Path(s) Description Expression
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* AllergyIntolerance DAPL AllergyIntolerance
Constraints: ait-1, ait-2
... id SΣ 0..1 id The AllergyIntolerance identifier generated by the DARTS de-identification service
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
... type SΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
... category SΣ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
... criticality SΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
... code SΣ 1..1 CodeableConcept Code that identifies the allergy or intolerance
Binding: CommonSubstancesForAllergyAndIntoleranceDocumentationIncludingRefutations (20240625) . (extensible): The set of codes indicating the allergy or intolerance
... patient SΣ 1..1 Reference(DAPL De-identified Patient) Who the sensitivity is for
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] SC 0..1 When allergy or intolerance was identified
Constraints: dapl-date-1, dapl-date-1a
.... onsetDateTime dateTime
.... onsetAge Age
... recordedDate SC 0..1 dateTime Date first version of the resource instance was recorded
Constraints: dapl-date-2, dapl-date-2a
... recorder 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the sensitivity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Source of the information about the allergy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... lastOccurrence C 0..1 dateTime Date(/time) of last known occurrence of a reaction
Constraints: dapl-date-3, dapl-date-3a
... reaction S 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation S 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
.... description 0..1 string Description of the event as a whole
.... onset C 0..1 dateTime Date(/time) when manifestations showed
Constraints: dapl-date-4, dapl-date-4a
.... severity S 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
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 extensible Common substances for allergy and intolerance documentation including refutations . 📍20240625 VSAC v0.24
AllergyIntolerance.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.recorder.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AllergyIntolerance.asserter.​type Base extensible ResourceType 📍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()
dapl-date-1 error AllergyIntolerance.onset[x] All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-1a error AllergyIntolerance.onset[x] All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-2 error AllergyIntolerance.recordedDate All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-2a error AllergyIntolerance.recordedDate All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-3 error AllergyIntolerance.lastOccurrence All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-3a error AllergyIntolerance.lastOccurrence All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dapl-date-4 error AllergyIntolerance.reaction.onset All dateTime data elements should be truncated to a year only for de-identified resources. $this is dateTime implies $this.toString().length() = 4
dapl-date-4a error AllergyIntolerance.reaction.onset All dateTime data elements should have valid year > 1900 $this is dateTime implies $this.toString() >= '1900'
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron