Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status | Version: 0.1.0 | |||
| Draft as of 2026-08-07 | Computable Name: PriorDoseStatus | |||
The person's prior-dose status for this antigen at the time of the campaign contact: zero-dose (never received before), previously-received, or no-recall. The per-event carrier of the polio SIA tally's never/previously/no-recall split; aggregates to the dose-history coverage stratifier and feeds zero-dose reach / dropout measures. Distinct from Immunization.protocolApplied.doseNumber, which counts this series' doses, not prior status of the antigen (forms-v1 / jul3-form-analysis §Aggregate #1).
Context of Use
This extension may be used on the following element(s)
Immunization
MedicationAdministration
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Prior-dose Status (Zero-dose) | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status" | |
  value[x] |
0..1 | code | Value of extension Binding: ICR Dose History / Zero-dose Status (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Prior-dose Status (Zero-dose) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status" | |
| value[x] |
0..1 | code | Value of extension Binding: ICR Dose History / Zero-dose Status (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type code: The person's prior-dose status for this antigen at the time of the campaign contact: zero-dose (never received before), previously-received, or no-recall. The per-event carrier of the polio SIA tally's never/previously/no-recall split; aggregates to the dose-history coverage stratifier and feeds zero-dose reach / dropout measures. Distinct from Immunization.protocolApplied.doseNumber, which counts this series' doses, not prior status of the antigen (forms-v1 / jul3-form-analysis §Aggregate #1).
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Prior-dose Status (Zero-dose) | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status" | |
| value[x] |
0..1 | code | Value of extension Binding: ICR Dose History / Zero-dose Status (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Prior-dose Status (Zero-dose) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status" | |
| value[x] |
0..1 | code | Value of extension Binding: ICR Dose History / Zero-dose Status (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type code: The person's prior-dose status for this antigen at the time of the campaign contact: zero-dose (never received before), previously-received, or no-recall. The per-event carrier of the polio SIA tally's never/previously/no-recall split; aggregates to the dose-history coverage stratifier and feeds zero-dose reach / dropout measures. Distinct from Immunization.protocolApplied.doseNumber, which counts this series' doses, not prior status of the antigen (forms-v1 / jul3-form-analysis §Aggregate #1).
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | required | ICR Dose History / Zero-dose Status | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|