Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

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

Resource Profile: ICR Medication Administration

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRMedicationAdministration Version: 0.1.0
Draft as of 2026-08-19 Computable Name: ICRMedicationAdministration

An MDA treatment event: ATC-coded preventive chemotherapy with directly-observed consumption, dosage derived from a dose-pole height Observation, and the required record origin.

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
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] Σ 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... subject SΣ 1..1 Reference(Patient | ICR Delivery Unit (Household / Community / School Cohort)) The treated person, or the delivery-unit Group (household, community, or school cohort) for register-level capture
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dosage SC 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation
Constraints: mad-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... medication[x] 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... dosage S 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
... medication[x] Σ 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... subject SΣ 1..1 Reference(Patient | ICR Delivery Unit (Household / Community / School Cohort)) The treated person, or the delivery-unit Group (household, community, or school cohort) for register-level capture
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who performed the medication administration and what they did
.... 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
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation
Constraints: mad-1
.... 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
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route 0..1 CodeableConcept Path of substance into body
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.
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... dose 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] Σ 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... subject SΣ 1..1 Reference(Patient | ICR Delivery Unit (Household / Community / School Cohort)) The treated person, or the delivery-unit Group (household, community, or school cohort) for register-level capture
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dosage SC 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation
Constraints: mad-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... medication[x] 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] S 1..1 dateTime, Period Start and end time of administration
... dosage S 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this treatment belongs to; per-round queries stay independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:directlyObserved S 0..1 boolean Directly Observed Consumption
URL: https://icr.healthcampaigns.org/StructureDefinition/directly-observed-consumption
.... extension:dosePoleBand S 0..1 CodeableConcept The measured dose-pole height band that set the tablet count (machine-readable height-band → dose, v0.19.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/dose-pole-band
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... instantiates Σ 0..* uri Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
... status ?!SΣ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration.
... statusReason 0..* CodeableConcept Reason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.
... medication[x] Σ 1..1 CodeableConcept WHO ATC-coded (albendazole, ivermectin, praziquantel, azithromycin…)
Binding: ICR MDA Medication (extensible)
... subject SΣ 1..1 Reference(Patient | ICR Delivery Unit (Household / Community / School Cohort)) The treated person, or the delivery-unit Group (household, community, or school cohort) for register-level capture
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
... supportingInformation S 0..* Reference(Resource) e.g. the dose-pole Observation the dosage was derived from
... effective[x] SΣ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who performed the medication administration and what they did
.... 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
.... function 0..1 CodeableConcept Type of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration
... reasonCode 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* Reference(Device) Device used to administer
... note 0..* Annotation Information about the administration
... dosage SC 0..1 BackboneElement Tablet count — in the field usually derived from a dose-pole height band Observation
Constraints: mad-1
.... 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
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route 0..1 CodeableConcept Path of substance into body
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.
.... method 0..1 CodeableConcept How drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... dose 0..1 SimpleQuantity(4.0.1) Amount of medication per dose
.... rate[x] 0..1 Dose quantity per unit of time
..... rateRatio Ratio
..... rateQuantity Quantity(SimpleQuantity)
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationAdministration.​status Base required Medication administration status codes 📍4.0.1 FHIR Std.
MedicationAdministration.​statusReason Base example SNOMED CT Reason Medication Not Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​category Base preferred Medication administration category codes 📍4.0.1 FHIR Std.
MedicationAdministration.​medication[x] Base extensible ICR MDA Medication 📦0.1.0 This IG
MedicationAdministration.​performer.function Base example Medication administration performer function codes 📍4.0.1 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.route Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron