SupplyRequest
A record of a request for a medication, substance or device used in the healthcare setting.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/SupplyRequest/[id] |
| Vread | GET | /fhir/R4/SupplyRequest/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/SupplyRequest/[id] |
| Patch | PATCH | /fhir/R4/SupplyRequest/[id] |
| Delete | DELETE | /fhir/R4/SupplyRequest/[id] |
| Create | POST | /fhir/R4/SupplyRequest |
| Search | GET | /fhir/R4/SupplyRequest |
| History | GET | /fhir/R4/SupplyRequest/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Business Identifier for SupplyRequest |
status | code | 0..1 | draft | active | suspended + |
category | CodeableConcept | 0..1 | The kind of supply (central, non-stock, etc.) |
priority | code | 0..1 | routine | urgent | asap | stat |
item[x] | CodeableConcept, Reference | 1..1 | Medication, Substance, or Device requested to be supplied |
quantity | Quantity | 1..1 | The requested amount of the item indicated |
parameter | BackboneElement | 0..* | Ordered item details |
occurrence[x] | dateTime, Period, Timing | 0..1 | When the request should be fulfilled |
authoredOn | dateTime | 0..1 | When the request was made |
requester | Reference | 0..1 | Individual making the request |
supplier | Reference | 0..* | Who is intended to fulfill the request |
reasonCode | CodeableConcept | 0..* | The reason why the supply item was requested |
reasonReference | Reference | 0..* | The reason why the supply item was requested |
deliverFrom | Reference | 0..1 | The origin of the supply |
deliverTo | Reference | 0..1 | The destination of the supply |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
category | token | The kind of supply (central, non-stock, etc.) |
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
requester | reference | Individual making the request |
status | token | draft | active | suspended + |
subject | reference | The destination of the supply |
supplier | reference | Who is intended to fulfill the request |
Reference
Official FHIR R4 spec: SupplyRequest.
Maturity: Trial Use 1 (FMM 1).