Generated Narrative: StructureDefinition ICRSupplyMovement Name Flags Card. Type Description & Constraints SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this movement belongs to URL: https://icr.healthcampaigns.org/StructureDefinition/campaign #xD; extension:recordOrigin S 1..1 code Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) #xD; extension:stockAccountability S 0..1 (Complex) Vial/commodity accountability & wastage — received/used/remaining/not-usable/returned, concordance, VVM (v0.20.0). A node's ledger reconciles as received = used + remaining + notUsable + returned URL: https://icr.healthcampaigns.org/StructureDefinition/stock-accountability #xD; extension:issuedToTeam S 0..1 Reference(ICR Care Team) The CareTeam this movement was issued to — one issuance per team per day plus its ledger is the field-team daily-stock pattern (R4 receiver cannot target a CareTeam) URL: https://icr.healthcampaigns.org/StructureDefinition/issued-to-team #xD; partOf S 0..* Reference(ICR Supply Movement) The upstream movement this one draws from — makes the supply chain an explicit, queryable sequence #xD; status S 0..1 code in-progress | completed | abandoned | entered-in-error #xD; suppliedItem S 0..1 BackboneElement The item that is delivered or supplied #xD; quantity S 0..1 SimpleQuantity(4.0.1) Amount dispensed #xD; Slices for item[x] S 0..1 CodeableConcept, Reference(Medication | Substance | Device) Drug commodity → WHO ATC (shares the ICRMedicationAdministration code); physical commodity → ICR commodity-class code, optionally with a GS1 GTIN coding; text as fallback Slice: Unordered, Open by type:$this #xD; item[x]:itemCodeableConcept 0..1 CodeableConcept Medication, Substance, or Device supplied Binding: ICR Supplied Item (extensible) #xD; supplier S 0..1 Reference(Practitioner | PractitionerRole | Organization) The sending party (organization / officer), where recorded #xD; destination S 0..1 Reference(Location) The receiving node (facility, staging post, settlement) #xD; Documentation for this format
A commodity movement between supply-chain nodes — receipt at a facility, issue to a distribution post or field team, return of unused stock. The STOCK-bearing supply event: carries the stock-accountability ledger (received/used/remaining/not-usable/returned, concordance, VVM) and never counts toward coverage. Chains via partOf → the upstream movement (central store → district → post → team). v1 scope is campaign-tied movements only; routine inter-warehouse logistics is out of scope (OpenLMIS territory).
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The campaign (round) this movement belongs to
The campaign round — the ICRCampaign CarePlan — this record belongs to. The uniform record→campaign join: delivery events (Immunization, MedicationAdministration, SupplyDelivery) and coverage reports (MeasureReport) all point AT their campaign, in the same direction as Task.basedOn — the CarePlan itself is never rewritten as records accumulate. Replaces the core event-basedOn extension previously used on the delivery profiles: its R4 context is Condition-only, so every use on a delivery resource was context-invalid, and MeasureReport needs the same link (a coverage report otherwise has no computable path back to its campaign).
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Whether this delivery event was recorded during a campaign or a routine facility visit. REQUIRED on all ICR delivery-event profiles — without it, SIA doses contaminate routine coverage analytics (working doc §4.4). Also valid on AdverseEvent so a campaign-context AEFI/side-effect stays separable from routine pharmacovigilance (v0.19.0).
Vial/commodity accountability & wastage — received/used/remaining/not-usable/returned, concordance, VVM (v0.20.0). A node's ledger reconciles as received = used + remaining + notUsable + returned
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).
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)
The CareTeam this movement was issued to — one issuance per team per day plus its ledger is the field-team daily-stock pattern (R4 receiver cannot target a CareTeam)
The CareTeam a supply movement was issued to. R4 SupplyDelivery.receiver targets only individual practitioners — the same gap (and same fix) as MeasureReport.reporter → reporter-team. One issuance per team per day, with its stock-accountability ledger, is the field-team daily-stock pattern (supply-split round).
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.
A plan, proposal or order that is fulfilled in whole or in part by this event.
Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
The upstream movement this one draws from — makes the supply chain an explicit, queryable sequence
A larger event of which this particular event is a component or step.
Not to be used to link an event to an Encounter - use Event.context for that. [The allowed reference resources may be adjusted as appropriate for the event resource].
E.g. Drug administration as part of a procedure, procedure as part of observation, etc.
in-progress | completed | abandoned | entered-in-error
A code specifying the state of the dispense event.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
.statusCode, also existence of fulfillment events
A link to a resource representing the person whom the delivered item is for.
Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
The item that is being delivered or has been supplied.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The amount of supply that has been dispensed. Includes unit of measure.
Drug commodity → WHO ATC (shares the ICRMedicationAdministration code); physical commodity → ICR commodity-class code, optionally with a GS1 GTIN coding; text as fallback
Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
Medication, Substance, or Device supplied
The date or time(s) the activity occurred.
[The list of types may be constrained as appropriate for the type of event].
The sending party (organization / officer), where recorded
The individual responsible for dispensing the medication, supplier or device.
The receiving node (facility, staging post, settlement)
Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
Identifies the person who picked up the Supply.