Skip to main content

PackagedProductDefinition

Trial Use 2 Specialized — Medication Definition

A medically related item or items, in a container or package.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/PackagedProductDefinition
InteractionMethodPath
ReadGET/fhir/R5/PackagedProductDefinition/[id]
VreadGET/fhir/R5/PackagedProductDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R5/PackagedProductDefinition/[id]
PatchPATCH/fhir/R5/PackagedProductDefinition/[id]
DeleteDELETE/fhir/R5/PackagedProductDefinition/[id]
CreatePOST/fhir/R5/PackagedProductDefinition
SearchGET/fhir/R5/PackagedProductDefinition?...
HistoryGET/fhir/R5/PackagedProductDefinition/[id]/_history
Type-historyGET/fhir/R5/PackagedProductDefinition/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*A unique identifier for this package as whole - not for the content of the package
namestring0..1A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
typeCodeableConcept0..1A high level category e.g. medicinal product, raw material, shipping container etc
packageForReference0..*The product that this is a pack for
statusCodeableConcept0..1The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status modifier
statusDatedateTime0..1The date at which the given status became applicable
containedItemQuantityQuantity0..*A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. See also packaging.containedItem.amount (especially the long definition)
descriptionmarkdown0..1Textual description. Note that this is not the name of the package or product
legalStatusOfSupplyBackboneElement0..*The legal status of supply of the packaged item as classified by the regulator
marketingStatusMarketingStatus0..*Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
copackagedIndicatorboolean0..1Identifies if the drug product is supplied with another item such as a diluent or adjuvant
manufacturerReference0..*Manufacturer of this package type (multiple means these are all possible manufacturers)
attachedDocumentReference0..*Additional information or supporting documentation about the packaged product
packagingBackboneElement0..1A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
characteristic0..*Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"

Resource-specific search parameters

ParameterTypeDescription
biologicalreferenceA biologically derived product within this packaged product
contained-itemreferenceAny of the contained items within this packaged product
devicereferenceA device within this packaged product
identifiertokenUnique identifier
manufactured-itemreferenceA manufactured item of medication within this packaged product
medicationreferenceA manufactured item of medication within this packaged product
nametokenA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
nutritionreferenceA nutrition product within this packaged product
packagereferenceA complete packaged product within this packaged product
package-forreferenceThe product that this is a pack for
statustokenThe status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status

Reference