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

Extension: Stock Accountability

Official URL: https://icr.healthcampaigns.org/StructureDefinition/stock-accountability Version: 0.1.0
Draft as of 2026-08-20 Computable Name: StockAccountability

Vial/commodity accountability and wastage on a supply event — received / used / remaining / not-usable (expired/damaged) / returned, plus physical-vs-theoretical concordance and (vaccines) the VVM stage. Reusable for vaccines, drugs and ITNs; the ESPEN supervision Form 5 stock block (espen-v4 / §17.2 C2).

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Stock Accountability
Constraints: icr-stock-ledger
... Slices for extension Content/Rules for all slices
.... extension:received S 0..1 Extension Quantity received
..... extension 0..0 Extension
..... url 1..1 uri "received"
..... value[x] 0..1 Quantity Value of extension
.... extension:used S 0..1 Extension Quantity used/administered/distributed
..... extension 0..0 Extension
..... url 1..1 uri "used"
..... value[x] 0..1 Quantity Value of extension
.... extension:remaining S 0..1 Extension Quantity remaining in stock
..... extension 0..0 Extension
..... url 1..1 uri "remaining"
..... value[x] 0..1 Quantity Value of extension
.... extension:notUsable S 0..1 Extension Expired / damaged / otherwise not usable
..... extension 0..0 Extension
..... url 1..1 uri "notUsable"
..... value[x] 0..1 Quantity Value of extension
.... extension:returned S 0..1 Extension Quantity returned to the next level
..... extension 0..0 Extension
..... url 1..1 uri "returned"
..... value[x] 0..1 Quantity Value of extension
.... extension:concordant S 0..1 Extension Does physical stock match the theoretical/recorded stock?
..... extension 0..0 Extension
..... url 1..1 uri "concordant"
..... value[x] 0..1 boolean Value of extension
.... extension:vvmStage 0..1 Extension Vaccine vial monitor stage 1–4 (vaccines only)
..... extension 0..0 Extension
..... url 1..1 uri "vvmStage"
..... value[x] 0..1 integer Value of extension
... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/stock-accountability"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Stock Accountability
Constraints: icr-stock-ledger
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:received S 0..1 Extension Quantity received
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "received"
..... value[x] 0..1 Quantity Value of extension
.... extension:used S 0..1 Extension Quantity used/administered/distributed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "used"
..... value[x] 0..1 Quantity Value of extension
.... extension:remaining S 0..1 Extension Quantity remaining in stock
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "remaining"
..... value[x] 0..1 Quantity Value of extension
.... extension:notUsable S 0..1 Extension Expired / damaged / otherwise not usable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "notUsable"
..... value[x] 0..1 Quantity Value of extension
.... extension:returned S 0..1 Extension Quantity returned to the next level
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "returned"
..... value[x] 0..1 Quantity Value of extension
.... extension:concordant S 0..1 Extension Does physical stock match the theoretical/recorded stock?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "concordant"
..... value[x] 0..1 boolean Value of extension
.... extension:vvmStage 0..1 Extension Vaccine vial monitor stage 1–4 (vaccines only)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "vvmStage"
..... value[x] 0..1 integer Value of extension
... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/stock-accountability"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Vial/commodity accountability and wastage on a supply event — received / used / remaining / not-usable (expired/damaged) / returned, plus physical-vs-theoretical concordance and (vaccines) the VVM stage. Reusable for vaccines, drugs and ITNs; the ESPEN supervision Form 5 stock block (espen-v4 / §17.2 C2).

  • received: Quantity: An Extension
  • used: Quantity: An Extension
  • remaining: Quantity: An Extension
  • notUsable: Quantity: An Extension
  • returned: Quantity: An Extension
  • concordant: boolean: An Extension
  • vvmStage: integer: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Stock Accountability
Constraints: icr-stock-ledger
... Slices for extension Content/Rules for all slices
.... extension:received S 0..1 Extension Quantity received
..... extension 0..0 Extension
..... url 1..1 uri "received"
..... value[x] 0..1 Quantity Value of extension
.... extension:used S 0..1 Extension Quantity used/administered/distributed
..... extension 0..0 Extension
..... url 1..1 uri "used"
..... value[x] 0..1 Quantity Value of extension
.... extension:remaining S 0..1 Extension Quantity remaining in stock
..... extension 0..0 Extension
..... url 1..1 uri "remaining"
..... value[x] 0..1 Quantity Value of extension
.... extension:notUsable S 0..1 Extension Expired / damaged / otherwise not usable
..... extension 0..0 Extension
..... url 1..1 uri "notUsable"
..... value[x] 0..1 Quantity Value of extension
.... extension:returned S 0..1 Extension Quantity returned to the next level
..... extension 0..0 Extension
..... url 1..1 uri "returned"
..... value[x] 0..1 Quantity Value of extension
.... extension:concordant S 0..1 Extension Does physical stock match the theoretical/recorded stock?
..... extension 0..0 Extension
..... url 1..1 uri "concordant"
..... value[x] 0..1 boolean Value of extension
.... extension:vvmStage 0..1 Extension Vaccine vial monitor stage 1–4 (vaccines only)
..... extension 0..0 Extension
..... url 1..1 uri "vvmStage"
..... value[x] 0..1 integer Value of extension
... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/stock-accountability"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension C 0..* Extension Stock Accountability
Constraints: icr-stock-ledger
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:received S 0..1 Extension Quantity received
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "received"
..... value[x] 0..1 Quantity Value of extension
.... extension:used S 0..1 Extension Quantity used/administered/distributed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "used"
..... value[x] 0..1 Quantity Value of extension
.... extension:remaining S 0..1 Extension Quantity remaining in stock
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "remaining"
..... value[x] 0..1 Quantity Value of extension
.... extension:notUsable S 0..1 Extension Expired / damaged / otherwise not usable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "notUsable"
..... value[x] 0..1 Quantity Value of extension
.... extension:returned S 0..1 Extension Quantity returned to the next level
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "returned"
..... value[x] 0..1 Quantity Value of extension
.... extension:concordant S 0..1 Extension Does physical stock match the theoretical/recorded stock?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "concordant"
..... value[x] 0..1 boolean Value of extension
.... extension:vvmStage 0..1 Extension Vaccine vial monitor stage 1–4 (vaccines only)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "vvmStage"
..... value[x] 0..1 integer Value of extension
... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/stock-accountability"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Vial/commodity accountability and wastage on a supply event — received / used / remaining / not-usable (expired/damaged) / returned, plus physical-vs-theoretical concordance and (vaccines) the VVM stage. Reusable for vaccines, drugs and ITNs; the ESPEN supervision Form 5 stock block (espen-v4 / §17.2 C2).

  • received: Quantity: An Extension
  • used: Quantity: An Extension
  • remaining: Quantity: An Extension
  • notUsable: Quantity: An Extension
  • returned: Quantity: An Extension
  • concordant: boolean: An Extension
  • vvmStage: integer: An Extension

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
icr-stock-ledger warning Extension Stock ledger identity: received = used + remaining + notUsable + returned (absent parts count as zero). Warning severity — a reconciliation gap is a data-quality signal worth surfacing, not always a recording error. extension('received').exists() and extension('used').exists() and extension('remaining').exists() implies extension('received').value.ofType(Quantity).value = extension('used').value.ofType(Quantity).value + extension('remaining').value.ofType(Quantity).value + iif(extension('notUsable').exists(), extension('notUsable').value.ofType(Quantity).value, 0) + iif(extension('returned').exists(), extension('returned').value.ofType(Quantity).value, 0)