Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build International flag

Supply of Products for Healthcare (SUPPLY), published by IHE Pharmacy Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-supply/ and changes regularly. See the Directory of published versions

Resource Profile: Profile - Supply Shipment Notice

Official URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/DispatchNotice Version: 0.3.0
Active as of 2024-06-18 Computable Name: IHESupplyDispatchNotice

Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property

A notification of shipment or beginning of transport of supply items.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from SupplyDelivery

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... value[x] 0..1 CodeableConcept Value of extension
Fixed Value: As shown (Shipment)
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
... identifier S 0..* Identifier External identifier

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... extension 0..0
..... url 1..1 uri "http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Supply delivery stage value set (required)
Fixed Value: As shown (Shipment)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier External identifier
... status ?!Σ 0..1 code in-progress | completed | abandoned | entered-in-error
Binding: SupplyDeliveryStatus (required): Status of the supply delivery.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SupplyDelivery.extension:deliveryStage.value[x]requiredFixed Value: shipment
http://profiles.ihe.net/PHARM/supply/ValueSet/IHEDeliveryStageVS
from this IG
SupplyDelivery.statusrequiredSupplyDeliveryStatus
http://hl7.org/fhir/ValueSet/supplydelivery-status|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Supply delivery stage value set (required)
Fixed Value: As shown (Shipment)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier External identifier
... basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
... status ?!Σ 0..1 code in-progress | completed | abandoned | entered-in-error
Binding: SupplyDeliveryStatus (required): Status of the supply delivery.

... patient 0..1 Reference(Patient) Patient for whom the item is supplied
... type 0..1 CodeableConcept Category of supply event
Binding: SupplyDeliverySupplyItemType (required): The type of supply dispense.

... suppliedItem 0..* BackboneElement The item that is delivered or supplied
.... 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
.... quantity 0..1 SimpleQuantity Amount supplied
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: SupplyDeliverySupplyItemType (example): The item that was delivered.

..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem)
... occurrence[x] Σ 0..1 When event occurred
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... supplier 0..1 Reference(Practitioner | PractitionerRole | Organization) The item supplier
... destination 0..1 Reference(Location) Where the delivery was sent
... receiver 0..* Reference(Practitioner | PractitionerRole | Organization) Who received the delivery

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SupplyDelivery.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SupplyDelivery.extension:deliveryStage.value[x]requiredFixed Value: shipment
http://profiles.ihe.net/PHARM/supply/ValueSet/IHEDeliveryStageVS
from this IG
SupplyDelivery.statusrequiredSupplyDeliveryStatus
http://hl7.org/fhir/ValueSet/supplydelivery-status|5.0.0
from the FHIR Standard
SupplyDelivery.typerequiredSupplyDeliverySupplyItemType
http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0
from the FHIR Standard
SupplyDelivery.suppliedItem.item[x]exampleSupplyDeliverySupplyItemType
http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype
from the FHIR Standard

This structure is derived from SupplyDelivery

Summary

Mandatory: 2 elements
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from SupplyDelivery

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... value[x] 0..1 CodeableConcept Value of extension
Fixed Value: As shown (Shipment)
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
... identifier S 0..* Identifier External identifier

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... extension 0..0
..... url 1..1 uri "http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Supply delivery stage value set (required)
Fixed Value: As shown (Shipment)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier External identifier
... status ?!Σ 0..1 code in-progress | completed | abandoned | entered-in-error
Binding: SupplyDeliveryStatus (required): Status of the supply delivery.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SupplyDelivery.extension:deliveryStage.value[x]requiredFixed Value: shipment
http://profiles.ihe.net/PHARM/supply/ValueSet/IHEDeliveryStageVS
from this IG
SupplyDelivery.statusrequiredSupplyDeliveryStatus
http://hl7.org/fhir/ValueSet/supplydelivery-status|5.0.0
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyDelivery 0..* SupplyDelivery Delivery of bulk Supplies
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryStage 1..1 (Complex) Supply delivery stage extension
URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://profiles.ihe.net/PHARM/supply/StructureDefinition/IHEDeliveryStageExt"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: Supply delivery stage value set (required)
Fixed Value: As shown (Shipment)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://profiles.ihe.net/PHARM/supply/CodeSystem/DeliveryStageCS
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shipment
....... display 0..0 string Representation defined by the system
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier External identifier
... basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
... status ?!Σ 0..1 code in-progress | completed | abandoned | entered-in-error
Binding: SupplyDeliveryStatus (required): Status of the supply delivery.

... patient 0..1 Reference(Patient) Patient for whom the item is supplied
... type 0..1 CodeableConcept Category of supply event
Binding: SupplyDeliverySupplyItemType (required): The type of supply dispense.

... suppliedItem 0..* BackboneElement The item that is delivered or supplied
.... 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
.... quantity 0..1 SimpleQuantity Amount supplied
.... item[x] 0..1 Medication, Substance, Device or Biologically Derived Product supplied
Binding: SupplyDeliverySupplyItemType (example): The item that was delivered.

..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Medication | Substance | Device | BiologicallyDerivedProduct | NutritionProduct | InventoryItem)
... occurrence[x] Σ 0..1 When event occurred
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... supplier 0..1 Reference(Practitioner | PractitionerRole | Organization) The item supplier
... destination 0..1 Reference(Location) Where the delivery was sent
... receiver 0..* Reference(Practitioner | PractitionerRole | Organization) Who received the delivery

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
SupplyDelivery.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SupplyDelivery.extension:deliveryStage.value[x]requiredFixed Value: shipment
http://profiles.ihe.net/PHARM/supply/ValueSet/IHEDeliveryStageVS
from this IG
SupplyDelivery.statusrequiredSupplyDeliveryStatus
http://hl7.org/fhir/ValueSet/supplydelivery-status|5.0.0
from the FHIR Standard
SupplyDelivery.typerequiredSupplyDeliverySupplyItemType
http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype|5.0.0
from the FHIR Standard
SupplyDelivery.suppliedItem.item[x]exampleSupplyDeliverySupplyItemType
http://hl7.org/fhir/ValueSet/supplydelivery-supplyitemtype
from the FHIR Standard

This structure is derived from SupplyDelivery

Summary

Mandatory: 2 elements
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron