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

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **DAPL Immunization**

## Resource Profile: DAPL Immunization 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-immunization | *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*:DAPLImmunization |

 
The profile establishes the core elements, extensions, vocabularies and value sets for representing deidentified or anonymized immunizations. 

### Introduction

This profile is used to represent de-identified Immunization 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 Immunization.occurenceDateTime.

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 Immunization resource text element may contain information such as the Immunization date, 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 Immunization resource id should not be included in the De-identified Immunization 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 Immunization. All resource references to the Immunization 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 Data Submitter has to truncate the following dates to only have a precision of year

* occurence[x]
* recorded

**Usages:**

* Examples for this Profile: [Immunization/de-identified-example](Immunization-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-immunization)

### 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-immunization.csv), [Excel](StructureDefinition-dapl-immunization.xlsx), [Schematron](StructureDefinition-dapl-immunization.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "dapl-immunization",
  "meta" : {
    "versionId" : "12",
    "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-immunization",
  "version" : "1.0.0-ballot",
  "name" : "DAPLImmunization",
  "title" : "DAPL Immunization",
  "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 deidentified or anonymized immunizations.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "workflow",
    "uri" : "http://hl7.org/fhir/workflow",
    "name" : "Workflow Pattern"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "cda",
    "uri" : "http://hl7.org/v3/cda",
    "name" : "CDA (R2)"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Immunization",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Immunization",
      "path" : "Immunization",
      "short" : "DAPL Immunization",
      "definition" : "The profile establishes the core elements, extensions, vocabularies and value sets for representing deidentified or anonymized immunizations."
    },
    {
      "id" : "Immunization.id",
      "path" : "Immunization.id",
      "short" : "The Immunization identifier genderated by the DARTS deidentification or anonymization service.",
      "definition" : "DAPL resource identifier.",
      "mustSupport" : true
    },
    {
      "id" : "Immunization.text",
      "path" : "Immunization.text",
      "short" : "Cannot include any text in the resource as part of the deidentified or anonymized data.",
      "min" : 0,
      "max" : "0",
      "mustSupport" : false
    },
    {
      "id" : "Immunization.contained",
      "path" : "Immunization.contained",
      "short" : "Cannot include any contained resources in the resource as part of the deidentified or anonymized data.",
      "min" : 0,
      "max" : "0",
      "mustSupport" : false
    },
    {
      "id" : "Immunization.status",
      "path" : "Immunization.status",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Immunization.statusReason",
      "path" : "Immunization.statusReason",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Immunization.vaccineCode",
      "path" : "Immunization.vaccineCode",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Immunization.patient",
      "path" : "Immunization.patient",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/dapl/StructureDefinition/dapl-deidentified-patient"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Immunization.occurrence[x]",
      "path" : "Immunization.occurrence[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Immunization.recorded",
      "path" : "Immunization.recorded",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Immunization.primarySource",
      "path" : "Immunization.primarySource",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    }]
  }
}

```
