SupplyDelivery - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
basedOntrueReference Fulfills plan, proposal or order
destinationfalseReference Where the Supply was sent
identifierfalseIdentifier External identifier
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
occurrenceTimingfalseTiming "occurrenceTiming" : { Timing },
partOftrueReference Part of referenced event
patientfalseReference Patient for whom the item is supplied
receivertrueReference Who collected the Supply
statusfalsecode in-progress | completed | abandoned | entered-in-error
suppliedItemfalseData Type The item that is delivered or supplied
supplierfalseReference Dispenser
typefalseCodeableConcept Category of dispense event

SupplyDelivery Example

{
  "status": "completed",
  "resourceType": "SupplyDelivery",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: simpledelivery</p><p><b>identifier</b>: Order10284</p><p><b>basedOn</b>: <a>SupplyRequest/simpleorder</a></p><p><b>partOf</b>: Central Supply Restock</p><p><b>status</b>: completed</p><p><b>type</b>: Blood collect tubes blue cap <span>(Details : {http://hl7.org/fhir/supply-item-type code 'device' = 'Device)</span></p><h3>SuppliedItems</h3><table><tr><td>-</td><td><b>Quantity</b></td><td><b>Item[x]</b></td></tr><tr><td>*</td><td>10</td><td>Blood collect tubes blue cap <span>(Details : {[not stated] code 'BlueTubes' = 'BlueTubes', given as 'Blood collect tubes blue cap'})</span></td></tr></table><p><b>occurrence</b>: 31/12/2016</p><p><b>supplier</b>: Vendor1</p><p><b>destination</b>: Location 1</p></div>"
  },
  "destination": {
    "display": "Location 1"
  },
  "basedOn": [
    {
      "reference": "SupplyRequest/simpleorder"
    }
  ],
  "supplier": {
    "display": "Vendor1"
  },
  "occurrenceDateTime": "2016-12-31",
  "identifier": {
    "value": "Order10284"
  },
  "type": {
    "text": "Blood collect tubes blue cap",
    "coding": [
      {
        "code": "device",
        "system": "http://hl7.org/fhir/supply-item-type"
      }
    ]
  },
  "id": "simpledelivery",
  "partOf": [
    {
      "display": "Central Supply Restock"
    }
  ],
  "suppliedItem": {
    "itemCodeableConcept": {
      "coding": [
        {
          "code": "BlueTubes",
          "display": "Blood collect tubes blue cap"
        }
      ]
    },
    "quantity": {
      "value": 10
    }
  }
}

SupplyDelivery Structure


  
{
  "resourceType" : "SupplyDelivery",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // External identifier
  "basedOn" : [{ Reference(SupplyRequest) }], // Fulfills plan, proposal or order
  "partOf" : [{ Reference(SupplyDelivery|Contract) }], // Part of referenced event
  "status" : "<code>", // in-progress | completed | abandoned | entered-in-error
  "patient" : { Reference(Patient) }, // Patient for whom the item is supplied
  "type" : { CodeableConcept }, // Category of dispense event
  "suppliedItem" : { // The item that is delivered or supplied
    "quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
    // item[x]: Medication, Substance, or Device supplied. One of these 2:
    "itemCodeableConcept" : { CodeableConcept }
    "itemReference" : { Reference(Medication|Substance|Device) }
  },
  // occurrence[x]: When event occurred. One of these 3:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "occurrenceTiming" : { Timing },
  "supplier" : { Reference(Practitioner|Organization) }, // Dispenser
  "destination" : { Reference(Location) }, // Where the Supply was sent
  "receiver" : [{ Reference(Practitioner) }] // Who collected the Supply
}


 

SupplyDelivery Search Parameters

The following search parameters can be used to query SupplyDelivery resources. Just submit the like so:

https://api.1up.health/fhir/stu3/SupplyDelivery?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
identifiertextidentifier
patientreferencepatient
receiverreferencereceiver
statustextstatus
supplierreferencesupplier