Skip to main content

SupplyRequest

PropertyValue
Publisher
NameSupplyRequest
URLhttp://hl7.org/fhir/StructureDefinition/SupplyRequest
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
SupplyRequest0..*SupplyRequestA record of a request for a medication, substance or device used in the healthcare setting.
SupplyRequest.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
SupplyRequest.meta0..1MetaThe 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.
SupplyRequest.implicitRules0..1uriA 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.
SupplyRequest.language0..1codeThe base language in which the resource is written.
SupplyRequest.text0..1NarrativeA 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.
SupplyRequest.contained0..*ResourceThese 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.
SupplyRequest.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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.
SupplyRequest.modifierExtension0..*ExtensionMay 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).
SupplyRequest.identifier0..*IdentifierBusiness identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
SupplyRequest.status0..1codeStatus of the supply request.
SupplyRequest.category0..1CodeableConceptCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
SupplyRequest.priority0..1codeIndicates how quickly this SupplyRequest should be addressed with respect to other requests.
SupplyRequest.item[x]1..1CodeableConceptThe item that is requested to be supplied. 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.
SupplyRequest.quantity1..1QuantityThe amount that is being ordered of the indicated item.
SupplyRequest.parameter0..*BackboneElementSpecific parameters for the ordered item. For example, the size of the indicated item.
SupplyRequest.parameter.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SupplyRequest.parameter.extension0..*ExtensionMay 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.
SupplyRequest.parameter.modifierExtension0..*ExtensionMay 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).
SupplyRequest.parameter.code0..1CodeableConceptA code or string that identifies the device detail being asserted.
SupplyRequest.parameter.value[x]0..1CodeableConceptThe value of the device detail.
SupplyRequest.occurrence[x]0..1dateTimeWhen the request should be fulfilled.
SupplyRequest.authoredOn0..1dateTimeWhen the request was made.
SupplyRequest.requester0..1ReferenceThe device, practitioner, etc. who initiated the request.
SupplyRequest.supplier0..*ReferenceWho is intended to fulfill the request.
SupplyRequest.reasonCode0..*CodeableConceptThe reason why the supply item was requested.
SupplyRequest.reasonReference0..*ReferenceThe reason why the supply item was requested.
SupplyRequest.deliverFrom0..1ReferenceWhere the supply is expected to come from.
SupplyRequest.deliverTo0..1ReferenceWhere the supply is destined to go.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
datedateMultiple 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 madeAllergyIntolerance.recordedDate / CarePlan.period / CareTeam.period / ClinicalImpression.date / Composition.date / Consent.dateTime / DiagnosticReport.effective / Encounter.period / EpisodeOfCare.period / FamilyMemberHistory.date / Flag.period / (Immunization.occurrence.ofType(dateTime)) / List.date / Observation.effective / Procedure.performed / (RiskAssessment.occurrence.ofType(dateTime)) / SupplyRequest.authoredOn
identifiertokenMultiple 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 identifierAllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier
categorytokenThe kind of supply (central, non-stock, etc.)SupplyRequest.category
requesterreferenceIndividual making the requestSupplyRequest.requester
statustokendraft / active / suspended +SupplyRequest.status
subjectreferenceThe destination of the supplySupplyRequest.deliverTo
supplierreferenceWho is intended to fulfill the requestSupplyRequest.supplier