# DAPL De-identified AllergyIntolerance - De-identified, Anonymized FHIR Profiles Library v1.0.0-ballot

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **DAPL De-identified AllergyIntolerance**

## 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](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 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](https://www.hhs.gov/sites/default/files/ocr/privacy/hipaa/understanding/coveredentities/De-identification/hhs_deid_guidance.pdf) 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:**

* Examples for this Profile: [AllergyIntolerance/de-identified-example](AllergyIntolerance-de-identified-example.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.us.dapl|current/StructureDefinition/dapl-deidentified-allergyintolerance)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-dapl-deidentified-allergyintolerance.csv), [Excel](StructureDefinition-dapl-deidentified-allergyintolerance.xlsx), [Schematron](StructureDefinition-dapl-deidentified-allergyintolerance.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "dapl-deidentified-allergyintolerance",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2026-03-27T02:03:11.293+00:00"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cgp"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/dapl/ImplementationGuide/dapl"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/dapl/ImplementationGuide/dapl"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-deidentified-allergyintolerance",
  "version" : "1.0.0-ballot",
  "name" : "DAPLDeidentifiedAllergyIntolerance",
  "title" : "DAPL De-identified AllergyIntolerance",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-05-08T05:01:52+10:00",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/cgp"
    }]
  }],
  "description" : "The profile establishes the core elements, extensions, vocabularies and value sets for representing de-identified Allergies and Intolerances.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "AllergyIntolerance",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "AllergyIntolerance",
      "path" : "AllergyIntolerance",
      "short" : "DAPL AllergyIntolerance",
      "definition" : "The profile establishes the core elements, extensions, vocabularies and value sets for representing de-identified Allergies and Intolerances."
    },
    {
      "id" : "AllergyIntolerance.id",
      "path" : "AllergyIntolerance.id",
      "short" : "The AllergyIntolerance identifier generated by the DARTS de-identification service",
      "definition" : "DAPL resource identifier.",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.text",
      "path" : "AllergyIntolerance.text",
      "short" : "Cannot include any text in the resource as part of the de-identified or anonymized data.",
      "min" : 0,
      "max" : "0",
      "mustSupport" : false
    },
    {
      "id" : "AllergyIntolerance.contained",
      "path" : "AllergyIntolerance.contained",
      "short" : "Cannot include any contained resources in the resource as part of the de-identified or anonymized  data.",
      "min" : 0,
      "max" : "0",
      "mustSupport" : false
    },
    {
      "id" : "AllergyIntolerance.clinicalStatus",
      "path" : "AllergyIntolerance.clinicalStatus",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.verificationStatus",
      "path" : "AllergyIntolerance.verificationStatus",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.type",
      "path" : "AllergyIntolerance.type",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.category",
      "path" : "AllergyIntolerance.category",
      "min" : 0,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.criticality",
      "path" : "AllergyIntolerance.criticality",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.code",
      "path" : "AllergyIntolerance.code",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "description" : "The set of codes indicating the allergy or intolerance",
        "valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8|20240625"
      }
    },
    {
      "id" : "AllergyIntolerance.patient",
      "path" : "AllergyIntolerance.patient",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-deidentified-patient"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.patient.display",
      "path" : "AllergyIntolerance.patient.display",
      "min" : 0,
      "max" : "0",
      "mustSupport" : false
    },
    {
      "id" : "AllergyIntolerance.onset[x]",
      "path" : "AllergyIntolerance.onset[x]",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      },
      {
        "code" : "Age"
      }],
      "constraint" : [{
        "key" : "dapl-date-1",
        "severity" : "error",
        "human" : "All dateTime data elements should be truncated to a year only for de-identified resources.",
        "expression" : "$this is dateTime implies $this.toString().length() = 4"
      },
      {
        "key" : "dapl-date-1a",
        "severity" : "error",
        "human" : "All dateTime data elements should have valid year > 1900",
        "expression" : "$this is dateTime implies $this.toString() >= '1900'"
      }],
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.recordedDate",
      "path" : "AllergyIntolerance.recordedDate",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "constraint" : [{
        "key" : "dapl-date-2",
        "severity" : "error",
        "human" : "All dateTime data elements should be truncated to a year only for de-identified resources.",
        "expression" : "$this is dateTime implies $this.toString().length() = 4"
      },
      {
        "key" : "dapl-date-2a",
        "severity" : "error",
        "human" : "All dateTime data elements should have valid year > 1900",
        "expression" : "$this is dateTime implies $this.toString() >= '1900'"
      }],
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.recorder.display",
      "path" : "AllergyIntolerance.recorder.display",
      "min" : 0,
      "max" : "0"
    },
    {
      "id" : "AllergyIntolerance.asserter.display",
      "path" : "AllergyIntolerance.asserter.display",
      "min" : 0,
      "max" : "0"
    },
    {
      "id" : "AllergyIntolerance.lastOccurrence",
      "path" : "AllergyIntolerance.lastOccurrence",
      "constraint" : [{
        "key" : "dapl-date-3",
        "severity" : "error",
        "human" : "All dateTime data elements should be truncated to a year only for de-identified resources.",
        "expression" : "$this is dateTime implies $this.toString().length() = 4"
      },
      {
        "key" : "dapl-date-3a",
        "severity" : "error",
        "human" : "All dateTime data elements should have valid year > 1900",
        "expression" : "$this is dateTime implies $this.toString() >= '1900'"
      }]
    },
    {
      "id" : "AllergyIntolerance.note",
      "path" : "AllergyIntolerance.note",
      "min" : 0,
      "max" : "0"
    },
    {
      "id" : "AllergyIntolerance.reaction",
      "path" : "AllergyIntolerance.reaction",
      "min" : 0,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.reaction.manifestation",
      "path" : "AllergyIntolerance.reaction.manifestation",
      "min" : 1,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.reaction.onset",
      "path" : "AllergyIntolerance.reaction.onset",
      "constraint" : [{
        "key" : "dapl-date-4",
        "severity" : "error",
        "human" : "All dateTime data elements should be truncated to a year only for de-identified resources.",
        "expression" : "$this is dateTime implies $this.toString().length() = 4"
      },
      {
        "key" : "dapl-date-4a",
        "severity" : "error",
        "human" : "All dateTime data elements should have valid year > 1900",
        "expression" : "$this is dateTime implies $this.toString() >= '1900'"
      }]
    },
    {
      "id" : "AllergyIntolerance.reaction.severity",
      "path" : "AllergyIntolerance.reaction.severity",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "AllergyIntolerance.reaction.note",
      "path" : "AllergyIntolerance.reaction.note",
      "min" : 0,
      "max" : "0"
    }]
  }
}

```
