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

Resource Profile: RegulatedTradeItem

Official URL: http://smart.who.int/pcmt/StructureDefinition/RegulatedTradeItem Version: 0.1.0
Draft as of 2025-01-31 Computable Name: RegulatedTradeItem

Regulated trade item profile - a product as is authorized by a regulatory authority for use in a jurisdiction

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 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
... status 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
... name 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
.... modifierExtension ?!Σ 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
.... nameType 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
.... language Σ 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
.... name SΣ 1..1 string The name or designation of the item
ele-1: All FHIR elements must have a @value or children
... Slices for responsibleOrganization 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
.... responsibleOrganization:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 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
..... role 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
..... organization 1..1 Reference(Organization) An organization that is associated with the item
ele-1: All FHIR elements must have a @value or children
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... role 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
..... organization 1..1 Reference(Organization) An organization that is associated with the item
ele-1: All FHIR elements must have a @value or children
... association S 0..* BackboneElement Association with other items or products
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 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
.... associationType Σ 1..1 CodeableConcept The type of association between the device and the other item
ele-1: All FHIR elements must have a @value or children
.... relatedItem Σ 1..1 Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
ele-1: All FHIR elements must have a @value or children
.... quantity Σ 1..1 Ratio The quantity of the product in this product
ele-1: All FHIR elements must have a @value or children
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
ele-1: All FHIR elements must have a @value or children
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 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
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
ele-1: All FHIR elements must have a @value or children
..... value[x] 1..1 The value of the attribute
ele-1: All FHIR elements must have a @value or children
...... valueString string
...... valueInteger integer
...... valueDecimal decimal
...... valueBoolean boolean
...... valueUrl url
...... valueDateTime dateTime
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueAnnotation Annotation
...... valueAddress Address
...... valueDuration Duration
...... valueCodeableConcept CodeableConcept
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... characteristicType 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
..... value[x] 1..1 CodeableConcept The value of the attribute
ele-1: All FHIR elements must have a @value or children
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... characteristicType 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
..... value[x] 1..1 dateTime The value of the attribute
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
InventoryItem.statusrequiredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0
from the FHIR Standard
InventoryItem.name.nameTypepreferredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-nametype
from the FHIR Standard
InventoryItem.name.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInventoryItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInventoryItemIf 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-4errorInventoryItemIf 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-5errorInventoryItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInventoryItemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InventoryItem

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... identifier S 1..* Identifier The regulatory authorization number or identifier for the item
... status S 1..1 code active | inactive | entered-in-error | unknown
... name S 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... nameType S 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... name S 1..1 string The name or designation of the item
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
... association S 0..* BackboneElement Association with other items or products
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
..... value[x] 1..1 CodeableConcept The value of the attribute
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
..... value[x] 1..1 dateTime The value of the attribute

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier The regulatory authorization number or identifier for the item
... status SΣ 1..1 code active | inactive | entered-in-error | unknown
Binding: InventoryItemStatusCodes (required): Status of the inventory item.

... category Σ 0..* CodeableConcept Category or class of the item
... code Σ 0..* CodeableConcept Code designating the specific type of item
... name SΣ 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType SΣ 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItemStatusCodes (preferred): Name types.

.... language Σ 1..1 code The language used to express the item name
Binding: CommonLanguages (required): Name languages.

.... name SΣ 1..1 string The name or designation of the item
... Slices for responsibleOrganization 1..* BackboneElement Organization(s) responsible for the product
Slice: Unordered, Open by pattern:role
.... responsibleOrganization:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
..... organization 1..1 Reference(Organization) An organization that is associated with the item
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... organization 1..1 Reference(Organization) An organization that is associated with the item
... description 0..1 BackboneElement Descriptive characteristics of the item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 0..1 code The language that is used in the item description
Binding: CommonLanguages (required): Description languages.

.... description 0..1 string Textual description of the item
... inventoryStatus Σ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit Σ 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted
... netContent Σ 0..1 SimpleQuantity Net content or amount present in the item
... association S 0..* BackboneElement Association with other items or products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... associationType Σ 1..1 CodeableConcept The type of association between the device and the other item
.... relatedItem Σ 1..1 Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
.... quantity Σ 1..1 Ratio The quantity of the product in this product
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
..... value[x] 1..1 The value of the attribute
...... valueString string
...... valueInteger integer
...... valueDecimal decimal
...... valueBoolean boolean
...... valueUrl url
...... valueDateTime dateTime
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueAnnotation Annotation
...... valueAddress Address
...... valueDuration Duration
...... valueCodeableConcept CodeableConcept
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept The value of the attribute
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 dateTime The value of the attribute
... instance 0..1 BackboneElement Instances or occurrences of the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier The identifier for the physical instance, typically a serial number
.... lotNumber 0..1 string The lot or batch number of the item
.... expiry 0..1 dateTime The expiry date or date and time for the product
.... subject 0..1 Reference(Patient | Organization) The subject that the item is associated with
.... location 0..1 Reference(Location) The location that the item is associated with
... productReference 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
InventoryItem.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
InventoryItem.statusrequiredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0
from the FHIR Standard
InventoryItem.name.nameTypepreferredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-nametype
from the FHIR Standard
InventoryItem.name.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard
InventoryItem.description.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInventoryItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInventoryItemIf 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-4errorInventoryItemIf 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-5errorInventoryItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInventoryItemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InventoryItem

Summary

Mandatory: 5 elements
Must-Support: 9 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InventoryItem.responsibleOrganization
  • The element 1 is sliced based on the value of InventoryItem.characteristic

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 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
... status 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
... name 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
.... modifierExtension ?!Σ 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
.... nameType 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
.... language Σ 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
.... name SΣ 1..1 string The name or designation of the item
ele-1: All FHIR elements must have a @value or children
... Slices for responsibleOrganization 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
.... responsibleOrganization:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 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
..... role 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
..... organization 1..1 Reference(Organization) An organization that is associated with the item
ele-1: All FHIR elements must have a @value or children
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... role 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
..... organization 1..1 Reference(Organization) An organization that is associated with the item
ele-1: All FHIR elements must have a @value or children
... association S 0..* BackboneElement Association with other items or products
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 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
.... associationType Σ 1..1 CodeableConcept The type of association between the device and the other item
ele-1: All FHIR elements must have a @value or children
.... relatedItem Σ 1..1 Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
ele-1: All FHIR elements must have a @value or children
.... quantity Σ 1..1 Ratio The quantity of the product in this product
ele-1: All FHIR elements must have a @value or children
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
ele-1: All FHIR elements must have a @value or children
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 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
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
ele-1: All FHIR elements must have a @value or children
..... value[x] 1..1 The value of the attribute
ele-1: All FHIR elements must have a @value or children
...... valueString string
...... valueInteger integer
...... valueDecimal decimal
...... valueBoolean boolean
...... valueUrl url
...... valueDateTime dateTime
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueAnnotation Annotation
...... valueAddress Address
...... valueDuration Duration
...... valueCodeableConcept CodeableConcept
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... characteristicType 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
..... value[x] 1..1 CodeableConcept The value of the attribute
ele-1: All FHIR elements must have a @value or children
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 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
..... characteristicType 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
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
..... value[x] 1..1 dateTime The value of the attribute
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
InventoryItem.statusrequiredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0
from the FHIR Standard
InventoryItem.name.nameTypepreferredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-nametype
from the FHIR Standard
InventoryItem.name.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInventoryItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInventoryItemIf 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-4errorInventoryItemIf 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-5errorInventoryItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInventoryItemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from InventoryItem

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... identifier S 1..* Identifier The regulatory authorization number or identifier for the item
... status S 1..1 code active | inactive | entered-in-error | unknown
... name S 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... nameType S 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
.... name S 1..1 string The name or designation of the item
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
... association S 0..* BackboneElement Association with other items or products
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
..... value[x] 1..1 CodeableConcept The value of the attribute
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
..... value[x] 1..1 dateTime The value of the attribute

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. InventoryItem 0..* InventoryItem A functional description of an inventory item used in inventory and supply-related workflows
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier The regulatory authorization number or identifier for the item
... status SΣ 1..1 code active | inactive | entered-in-error | unknown
Binding: InventoryItemStatusCodes (required): Status of the inventory item.

... category Σ 0..* CodeableConcept Category or class of the item
... code Σ 0..* CodeableConcept Code designating the specific type of item
... name SΣ 0..* BackboneElement The item name(s) - the brand name, or common name, functional name, generic name or others
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... nameType SΣ 1..1 Coding The type of name e.g. 'brand-name', 'functional-name', 'common-name'
Binding: InventoryItemStatusCodes (preferred): Name types.

.... language Σ 1..1 code The language used to express the item name
Binding: CommonLanguages (required): Name languages.

.... name SΣ 1..1 string The name or designation of the item
... Slices for responsibleOrganization 1..* BackboneElement Organization(s) responsible for the product
Slice: Unordered, Open by pattern:role
.... responsibleOrganization:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
..... organization 1..1 Reference(Organization) An organization that is associated with the item
.... responsibleOrganization:authorizationHolder S 1..1 BackboneElement Organization(s) responsible for the product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 1..1 CodeableConcept The role of the organization e.g. manufacturer, distributor, or other
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: authorizationHolder
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... organization 1..1 Reference(Organization) An organization that is associated with the item
... description 0..1 BackboneElement Descriptive characteristics of the item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 0..1 code The language that is used in the item description
Binding: CommonLanguages (required): Description languages.

.... description 0..1 string Textual description of the item
... inventoryStatus Σ 0..* CodeableConcept The usage status like recalled, in use, discarded
... baseUnit Σ 0..1 CodeableConcept The base unit of measure - the unit in which the product is used or counted
... netContent Σ 0..1 SimpleQuantity Net content or amount present in the item
... association S 0..* BackboneElement Association with other items or products
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... associationType Σ 1..1 CodeableConcept The type of association between the device and the other item
.... relatedItem Σ 1..1 Reference(InventoryItem | Medication | MedicationKnowledge | Device | DeviceDefinition | NutritionProduct | BiologicallyDerivedProduct) The related item or product
.... quantity Σ 1..1 Ratio The quantity of the product in this product
... Slices for characteristic 1..* BackboneElement Characteristic of the item
Slice: Unordered, Open by pattern:characteristicType
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
..... value[x] 1..1 The value of the attribute
...... valueString string
...... valueInteger integer
...... valueDecimal decimal
...... valueBoolean boolean
...... valueUrl url
...... valueDateTime dateTime
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueAnnotation Annotation
...... valueAddress Address
...... valueDuration Duration
...... valueCodeableConcept CodeableConcept
.... characteristic:region S 1..1 BackboneElement Characteristic of the item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: region
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept The value of the attribute
.... characteristic:validityPeriod S 0..1 BackboneElement Characteristic of the item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristicType 1..1 CodeableConcept The characteristic that is being defined
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 0..1 uri Identity of the terminology system
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: validityPeriod
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 dateTime The value of the attribute
... instance 0..1 BackboneElement Instances or occurrences of the product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier The identifier for the physical instance, typically a serial number
.... lotNumber 0..1 string The lot or batch number of the item
.... expiry 0..1 dateTime The expiry date or date and time for the product
.... subject 0..1 Reference(Patient | Organization) The subject that the item is associated with
.... location 0..1 Reference(Location) The location that the item is associated with
... productReference 0..1 Reference(Medication | Device | NutritionProduct | BiologicallyDerivedProduct) Link to a product resource used in clinical workflows

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
InventoryItem.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
InventoryItem.statusrequiredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-status|5.0.0
from the FHIR Standard
InventoryItem.name.nameTypepreferredInventoryItemStatusCodes
http://hl7.org/fhir/ValueSet/inventoryitem-nametype
from the FHIR Standard
InventoryItem.name.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard
InventoryItem.description.languagerequiredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInventoryItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInventoryItemIf 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-4errorInventoryItemIf 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-5errorInventoryItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInventoryItemA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from InventoryItem

Summary

Mandatory: 5 elements
Must-Support: 9 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of InventoryItem.responsibleOrganization
  • The element 1 is sliced based on the value of InventoryItem.characteristic

 

Other representations of profile: CSV, Excel, Schematron