PackagedProductDefinition
A medically related item or items, in a container or package.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/PackagedProductDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/PackagedProductDefinition/[id] |
| Vread | GET | /fhir/R5/PackagedProductDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/PackagedProductDefinition/[id] |
| Patch | PATCH | /fhir/R5/PackagedProductDefinition/[id] |
| Delete | DELETE | /fhir/R5/PackagedProductDefinition/[id] |
| Create | POST | /fhir/R5/PackagedProductDefinition |
| Search | GET | /fhir/R5/PackagedProductDefinition?... |
| History | GET | /fhir/R5/PackagedProductDefinition/[id]/_history |
| Type-history | GET | /fhir/R5/PackagedProductDefinition/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | A unique identifier for this package as whole - not for the content of the package |
name | string | 0..1 | A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc |
type | CodeableConcept | 0..1 | A high level category e.g. medicinal product, raw material, shipping container etc |
packageFor | Reference | 0..* | The product that this is a pack for |
status | CodeableConcept | 0..1 | The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status modifier |
statusDate | dateTime | 0..1 | The date at which the given status became applicable |
containedItemQuantity | Quantity | 0..* | 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) |
description | markdown | 0..1 | Textual description. Note that this is not the name of the package or product |
legalStatusOfSupply | BackboneElement | 0..* | The legal status of supply of the packaged item as classified by the regulator |
marketingStatus | MarketingStatus | 0..* | Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated |
copackagedIndicator | boolean | 0..1 | Identifies if the drug product is supplied with another item such as a diluent or adjuvant |
manufacturer | Reference | 0..* | Manufacturer of this package type (multiple means these are all possible manufacturers) |
attachedDocument | Reference | 0..* | Additional information or supporting documentation about the packaged product |
packaging | BackboneElement | 0..1 | A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap |
characteristic | — | 0..* | Allows the key features to be recorded, such as "hospital pack", "nurse prescribable" |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
biological | reference | A biologically derived product within this packaged product |
contained-item | reference | Any of the contained items within this packaged product |
device | reference | A device within this packaged product |
identifier | token | Unique identifier |
manufactured-item | reference | A manufactured item of medication within this packaged product |
medication | reference | A manufactured item of medication within this packaged product |
name | token | A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc. |
nutrition | reference | A nutrition product within this packaged product |
package | reference | A complete packaged product within this packaged product |
package-for | reference | The product that this is a pack for |
status | token | The 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
- Official FHIR R5 spec:
PackagedProductDefinition - Maturity: Trial Use 2 (FMM 2).