This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure | Maturity Level: 1 | Informative |
Detailed Descriptions for the elements in the Product pattern.
Product | |
Definition | A pattern to be followed by resources that represent a product used in healthcare, for clinical or operational purposes. |
Short Display | Product Pattern |
Cardinality | 0..* |
Type | Logical |
Product.status | |
Definition | The current state of the product. |
Short Display | active | inactive | entered-in-error |
Cardinality | 1..1 |
Terminology Binding | ProductStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) |
Summary | true |
Comments | Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
Product.category | |
Definition | A category of the product. For example drug class, or device type. A product can have one or several categories. The categories can be from an official / regulatory source, or internal categorization or classification schemes. Categories are useful in search and retrieval of products, or can be used for determining authorizations, e.g. who can order which kinds of products. |
Short Display | A category or class of the product |
Cardinality | 0..* |
Type | CodeableConcept |
Alternate Names | class |
Summary | true |
Product.code | |
Definition | The code assigned to the product, for example a catalog number, Device DI, Drug Code or other. Can be an internally assigned or an official product code such as the manufacturer-assigned code. There may be different codes for a product, having different levels of granularity. For example "0123456789" corresponding to "CompuHyper GlobalMed, UltraImplantable 2.25 x 8 mm". |
Short Display | A code designating a specific type of product |
Cardinality | 0..1 |
Type | CodeableConcept |
Alternate Names | type |
Summary | true |
To Do | To discuss - what if a product has two codes? |
Product.manufacturer | |
Definition | The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device. |
Short Display | Manufacturer, representative or officially responsible for the product |
Cardinality | 0..* |
Type | Reference(Organization) |
Summary | true |
Product.instance | |
Definition | Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product. |
Short Display | One or several physical instances or occurrences of the product |
Cardinality | 0..1 |
Product.instance.quantity | |
Definition | For products that represent a particular quantity of a substance or type of item, indicates how 'much' of the product (by weight, volume, count, etc.) is represented by this resource instance. |
Short Display | The amount of items |
Cardinality | 0..1 |
Type | SimpleQuantity |
Product.instance.identifier | |
Definition | The identifier for the physical instance, typically a serial number. |
Short Display | The identifier for the physical instance, typically a serial number |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Alternate Names | serialNumber |
Product.instance.lotNumber | |
Definition | The identification of the batch or lot of the product. |
Short Display | The identification of the batch or lot of the product |
Cardinality | 0..1 |
Type | string |
Product.instance.expiry | |
Definition | The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed. |
Short Display | The expiry date or date and time for the product |
Cardinality | 0..1 |
Type | dateTime |
Product.instance.subject | |
Definition | Individual the product is associated with, or which has used the product. |
Short Display | Individual the product is associated with, or which has used the product |
Cardinality | 0..1 |
Type | Reference(Patient | Group) |
Requirements | Links the product to the Patient context. |
Alternate Names | patient |
Summary | true |
Comments | [For resources that aren't patient-specific, the set of allowed resources may be extended to include other things. Group should generally be retained unless there's certainty this resource won't be used for veterinary, research or public health settings where Group may be necessary (e.g. this cage of rats/crate of chickens, group of people in a 5 mile radious of the incident, etc.)]. |
Product.note | |
Definition | Comments made about the product. |
Short Display | Comments made about the product |
Cardinality | 0..* |
Type | Annotation |