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: Supply Request profile

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

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

Profile for a Supply / Resupply Request

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 SupplyRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... status S 0..1 code draft | active | suspended +

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.

... item Σ 1..1 CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.

... quantity Σ 1..1 Quantity The requested amount of the item indicated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SupplyRequest.statusrequiredSupplyRequestStatus
http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0
from the FHIR Standard
SupplyRequest.itemexampleSNOMEDCTSupplyItem
http://hl7.org/fhir/ValueSet/supply-item
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for SupplyRequest
... status ?!SΣ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.

... basedOn Σ 0..* Reference(Resource) What other request is fulfilled by this supply request
... category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Binding: SupplyType (example): Category of supply request.

... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... deliverFor 0..1 Reference(Patient) The patient for who the supply request is for
... item Σ 1..1 CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.

... quantity Σ 1..1 Quantity The requested amount of the item indicated
... parameter 0..* BackboneElement Ordered item details
.... 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
.... code 0..1 CodeableConcept Item detail
Binding: (unbound) (example): A code that identifies the device detail.

.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... occurrence[x] Σ 0..1 When the request should be fulfilled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime When the request was made
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) Individual making the request
... supplier Σ 0..* Reference(Organization | HealthcareService) Who is intended to fulfill the request
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) The reason why the supply item was requested
Binding: SupplyRequestReason (example): The reason why the supply item was requested.


... deliverFrom 0..1 Reference(Organization | Location) The origin of the supply
... deliverTo 0..1 Reference(Organization | Location | Patient | RelatedPerson) The destination of the supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SupplyRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SupplyRequest.statusrequiredSupplyRequestStatus
http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0
from the FHIR Standard
SupplyRequest.categoryexampleSupplyType
http://hl7.org/fhir/ValueSet/supplyrequest-kind
from the FHIR Standard
SupplyRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
SupplyRequest.itemexampleSNOMEDCTSupplyItem
http://hl7.org/fhir/ValueSet/supply-item
from the FHIR Standard
SupplyRequest.parameter.codeexample
SupplyRequest.reasonexampleSupplyRequestReason
http://hl7.org/fhir/ValueSet/supplyrequest-reason
from the FHIR Standard

This structure is derived from SupplyRequest

Summary

Must-Support: 1 element

Differential View

This structure is derived from SupplyRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... status S 0..1 code draft | active | suspended +

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.

... item Σ 1..1 CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.

... quantity Σ 1..1 Quantity The requested amount of the item indicated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SupplyRequest.statusrequiredSupplyRequestStatus
http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0
from the FHIR Standard
SupplyRequest.itemexampleSNOMEDCTSupplyItem
http://hl7.org/fhir/ValueSet/supply-item
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SupplyRequest 0..* SupplyRequest Request for a medication, substance or device
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for SupplyRequest
... status ?!SΣ 0..1 code draft | active | suspended +
Binding: SupplyRequestStatus (required): Status of the supply request.

... basedOn Σ 0..* Reference(Resource) What other request is fulfilled by this supply request
... category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Binding: SupplyType (example): Category of supply request.

... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... deliverFor 0..1 Reference(Patient) The patient for who the supply request is for
... item Σ 1..1 CodeableReference(Medication | Substance | Device | DeviceDefinition | BiologicallyDerivedProduct | NutritionProduct | InventoryItem) Medication, Substance, or Device requested to be supplied
Binding: SNOMEDCTSupplyItem (example): The item that was requested.

... quantity Σ 1..1 Quantity The requested amount of the item indicated
... parameter 0..* BackboneElement Ordered item details
.... 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
.... code 0..1 CodeableConcept Item detail
Binding: (unbound) (example): A code that identifies the device detail.

.... value[x] 0..1 Value of detail
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueBoolean boolean
... occurrence[x] Σ 0..1 When the request should be fulfilled
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn Σ 0..1 dateTime When the request was made
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | CareTeam) Individual making the request
... supplier Σ 0..* Reference(Organization | HealthcareService) Who is intended to fulfill the request
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) The reason why the supply item was requested
Binding: SupplyRequestReason (example): The reason why the supply item was requested.


... deliverFrom 0..1 Reference(Organization | Location) The origin of the supply
... deliverTo 0..1 Reference(Organization | Location | Patient | RelatedPerson) The destination of the supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SupplyRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SupplyRequest.statusrequiredSupplyRequestStatus
http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0
from the FHIR Standard
SupplyRequest.categoryexampleSupplyType
http://hl7.org/fhir/ValueSet/supplyrequest-kind
from the FHIR Standard
SupplyRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
from the FHIR Standard
SupplyRequest.itemexampleSNOMEDCTSupplyItem
http://hl7.org/fhir/ValueSet/supply-item
from the FHIR Standard
SupplyRequest.parameter.codeexample
SupplyRequest.reasonexampleSupplyRequestReason
http://hl7.org/fhir/ValueSet/supplyrequest-reason
from the FHIR Standard

This structure is derived from SupplyRequest

Summary

Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron