SupplyRequest

ResourceClinical · Request & ResponseTrial useMaturity 1

A record of a request for a medication, substance or device used in the healthcare setting.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

7 of 7 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business Identifier for SupplyRequest
status?!Σ	0..1	code	draft | active | suspended +Binding (required): supplyrequest-status
categoryΣ	0..1	CodeableConcept	The kind of supply (central, non-stock, etc.)Binding (example): supplyrequest-kind
priorityΣ	0..1	code	routine | urgent | asap | statBinding (required): request-priority
item[x]RequiredΣ	1..1	CodeableConcept | Reference(Medication | Substance | Device)	Medication, Substance, or Device requested to be suppliedBinding (example): supply-item
quantityRequiredΣ	1..1	Quantity	The requested amount of the item indicated
parameter	0..*	BackboneElement	Ordered item details
code	0..1	CodeableConcept	Item detail
value[x]	0..1	CodeableConcept | Quantity | Range | boolean	Value of detail
occurrence[x]Σ	0..1	dateTime | Period | Timing	When the request should be fulfilled
authoredOnΣ	0..1	dateTime	When the request was made
requesterΣ	0..1	Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)	Individual making the request
supplierΣ	0..*	Reference(Organization | HealthcareService)	Who is intended to fulfill the request
reasonCode	0..*	CodeableConcept	The reason why the supply item was requestedBinding (example): supplyrequest-reason
reasonReference	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	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)	The destination of the supply

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/SupplyRequest?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
category	token	The kind of supply (central, non-stock, etc.) SupplyRequest.category
date	date	When the request was made SupplyRequest.authoredOn
identifier	token	Business Identifier for SupplyRequest SupplyRequest.identifier
requester	reference	Individual making the request SupplyRequest.requester
status	token	draft | active | suspended + SupplyRequest.status
subject	reference	The destination of the supply SupplyRequest.deliverTo
supplier	reference	Who is intended to fulfill the request SupplyRequest.supplier

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition