SMART Product Catalog
0.1.0 - ci-build
SMART Product Catalog, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-pcmt/tree/draft-logical-model and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/pcmt/StructureDefinition/TradeItem | Version: 0.1.0 | |||
| Draft as of 2025-01-31 | Computable Name: TradeItem | |||
Trade item profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for the inventory item ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: InventoryItemStatusCodes (required): Status of the inventory item. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItemStatusCodes (preferred): Name types. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | code | The language used to express the item name Binding: CommonLanguages (required): Name languages. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | The name or designation of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item ele-1: All FHIR elements must have a @value or children | |
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
1..1 | The value of the attribute ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() |
url | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||
![]() ![]() ![]() ![]() ![]() |
Address | |||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute ele-1: All FHIR elements must have a @value or children | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InventoryItem.status | required | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0from the FHIR Standard | |
| InventoryItem.name.nameType | preferred | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-nametypefrom the FHIR Standard | |
| InventoryItem.name.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | InventoryItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | InventoryItem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | InventoryItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from InventoryItem
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows | |
![]() ![]() |
S | 1..* | Identifier | Business identifier for the inventory item |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error | unknown |
![]() ![]() |
S | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others |
![]() ![]() ![]() |
S | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
![]() ![]() ![]() |
S | 1..1 | string | The name or designation of the item |
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for the inventory item | ||||
![]() ![]() |
SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: InventoryItemStatusCodes (required): Status of the inventory item. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Category or class of the item | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Code designating the specific type of item | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItemStatusCodes (preferred): Name types. | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | The language used to express the item name Binding: CommonLanguages (required): Name languages. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The name or designation of the item | ||||
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item | |||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item | |||||
![]() ![]() |
0..1 | BackboneElement | Descriptive characteristics of the item | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | code | The language that is used in the item description Binding: CommonLanguages (required): Description languages. | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of the item | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The usage status like recalled, in use, discarded | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted | ||||
![]() ![]() |
Σ | 0..1 | SimpleQuantity | Net content or amount present in the item | ||||
![]() ![]() |
0..* | BackboneElement | Association with other items or products | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of association between the device and the other item | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) | The related item or product | ||||
![]() ![]() ![]() |
Σ | 1..1 | Ratio | The quantity of the product in this product | ||||
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined | |||||
![]() ![]() ![]() ![]() |
1..1 | The value of the attribute | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute | |||||
![]() ![]() |
0..1 | BackboneElement | Instances or occurrences of the product | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | Identifier | The identifier for the physical instance, typically a serial number | |||||
![]() ![]() ![]() |
0..1 | string | The lot or batch number of the item | |||||
![]() ![]() ![]() |
0..1 | dateTime | The expiry date or date and time for the product | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | Organization) | The subject that the item is associated with | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | The location that the item is associated with | |||||
![]() ![]() |
0..1 | Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) | Link to a product resource used in clinical workflows | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| InventoryItem.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| InventoryItem.status | required | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0from the FHIR Standard | |
| InventoryItem.name.nameType | preferred | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-nametypefrom the FHIR Standard | |
| InventoryItem.name.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard | |
| InventoryItem.description.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | InventoryItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | InventoryItem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | InventoryItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from InventoryItem
Summary
Mandatory: 5 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for the inventory item ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: InventoryItemStatusCodes (required): Status of the inventory item. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItemStatusCodes (preferred): Name types. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | code | The language used to express the item name Binding: CommonLanguages (required): Name languages. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | The name or designation of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item ele-1: All FHIR elements must have a @value or children | |
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
1..1 | The value of the attribute ele-1: All FHIR elements must have a @value or children | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() |
url | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||
![]() ![]() ![]() ![]() ![]() |
Address | |||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute ele-1: All FHIR elements must have a @value or children | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| InventoryItem.status | required | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0from the FHIR Standard | |
| InventoryItem.name.nameType | preferred | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-nametypefrom the FHIR Standard | |
| InventoryItem.name.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | InventoryItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | InventoryItem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | InventoryItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from InventoryItem
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows | |
![]() ![]() |
S | 1..* | Identifier | Business identifier for the inventory item |
![]() ![]() |
S | 1..1 | code | active | inactive | entered-in-error | unknown |
![]() ![]() |
S | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others |
![]() ![]() ![]() |
S | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' |
![]() ![]() ![]() |
S | 1..1 | string | The name or designation of the item |
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute | |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | InventoryItem | A functional description of an inventory item used in inventory and supply-related workflows | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for the inventory item | ||||
![]() ![]() |
SΣ | 1..1 | code | active | inactive | entered-in-error | unknown Binding: InventoryItemStatusCodes (required): Status of the inventory item. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Category or class of the item | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Code designating the specific type of item | ||||
![]() ![]() |
SΣ | 0..* | BackboneElement | The item name(s) - the brand name, or common name, functional name, generic name or others | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | The type of name e.g. 'brand-name', 'functional-name', 'common-name' Binding: InventoryItemStatusCodes (preferred): Name types. | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | The language used to express the item name Binding: CommonLanguages (required): Name languages. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The name or designation of the item | ||||
![]() ![]() |
1..* | BackboneElement | Organization(s) responsible for the product Slice: Unordered, Open by pattern:role | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item | |||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Organization(s) responsible for the product | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The role of the organization e.g. manufacturer, distributor, or other Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: manufacturer | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization) | An organization that is associated with the item | |||||
![]() ![]() |
0..1 | BackboneElement | Descriptive characteristics of the item | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | code | The language that is used in the item description Binding: CommonLanguages (required): Description languages. | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of the item | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The usage status like recalled, in use, discarded | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted | ||||
![]() ![]() |
Σ | 0..1 | SimpleQuantity | Net content or amount present in the item | ||||
![]() ![]() |
0..* | BackboneElement | Association with other items or products | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of association between the device and the other item | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) | The related item or product | ||||
![]() ![]() ![]() |
Σ | 1..1 | Ratio | The quantity of the product in this product | ||||
![]() ![]() |
1..* | BackboneElement | Characteristic of the item Slice: Unordered, Open by pattern:characteristicType | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined | |||||
![]() ![]() ![]() ![]() |
1..1 | The value of the attribute | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Characteristic of the item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: country-of-origin | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The value of the attribute | |||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Characteristic of the item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The characteristic that is being defined Required Pattern: At least the following | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: shelflife | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
1..1 | SimpleQuantity | The value of the attribute | |||||
![]() ![]() |
0..1 | BackboneElement | Instances or occurrences of the product | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | Identifier | The identifier for the physical instance, typically a serial number | |||||
![]() ![]() ![]() |
0..1 | string | The lot or batch number of the item | |||||
![]() ![]() ![]() |
0..1 | dateTime | The expiry date or date and time for the product | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | Organization) | The subject that the item is associated with | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | The location that the item is associated with | |||||
![]() ![]() |
0..1 | Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) | Link to a product resource used in clinical workflows | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| InventoryItem.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| InventoryItem.status | required | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0from the FHIR Standard | |
| InventoryItem.name.nameType | preferred | InventoryItemStatusCodeshttp://hl7.org/fhir/ValueSet/inventoryitem-nametypefrom the FHIR Standard | |
| InventoryItem.name.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard | |
| InventoryItem.description.language | required | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|5.0.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | InventoryItem | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | InventoryItem | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | InventoryItem | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | InventoryItem | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from InventoryItem
Summary
Mandatory: 5 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron