Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build
Supply of Products for Healthcare (SUPPLY), published by IHE Pharmacy Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-supply/ and changes regularly. See the Directory of published versions
Official URL: http://profiles.ihe.net/PHARM/supply/StructureDefinition/ProductModel | Version: 0.3.0 | |||
Draft as of 2024-06-18 | Computable Name: ProductModel | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
This is the logical model for a Product
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | 1..1 | The actual related product Slice: Unordered, Open by type:$this | ||
associatedProductCodeableConcept | CodeableConcept | |||
associatedProductReference | Reference(ProductModel | ItemModel) | |||
associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
This structure is derived from Element
Summary
Mandatory: 0 element(5 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | 1..1 | The actual related product Slice: Unordered, Open by type:$this | ||
associatedProductCodeableConcept | CodeableConcept | |||
associatedProductReference | Reference(ProductModel | ItemModel) | |||
associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ProductModel | 0..* | Element | Elements defined in Ancestors:@id, extension A functional description of a product’s functionality, used for counting Instances of this logical model can be the target of a Reference | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier | 0..* | Identifier | Business identifier for the product | |
baseUnitOfMeasure | 0..1 | CodeableConcept | The base unit of measure - the unit in which the product is used or counted. | |
description | 0..* | BackboneElement | The type of counting - whether it is a manual counting, automated data capture, estimate.. | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attributeType | 1..1 | CodeableConcept | The type of operation - add/subtract | |
attributeType[x] | 1..1 | The value of the attribute | ||
attributeTypeInteger | integer | |||
attributeTypeString | string | |||
attributeTypeBoolean | boolean | |||
association | 0..* | BackboneElement | For example, Product A (powder) should be mixed with product B '(saline)', or 'product A should be applied with device B' , or 'Product X applies to parent device Y | |
@id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
associationType | 1..1 | CodeableConcept | The type of association | |
Slices for associatedProduct[x] | Content/Rules for all slices | |||
Slices for associatedProduct[x]:associatedProductCodeableConcept | 0..1 | CodeableConcept | The actual related product Slice: Unordered, Open by type:$this Binding: Product association type Value Set (preferred) | |
quantity | 1..1 | Ratio | The quantity of the associated product in this product | |
classification | 0..* | CodeableConcept | The classification(s) of the product, e.g. ATC code, schedule, device class, ... | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ProductModel.association.associatedProduct[x]:associatedProductCodeableConcept | preferred | ProductAssociationType (a valid code from Product association type code system)http://profiles.ihe.net/PHARM/supply/ValueSet/vs-ihe-pharm-product-association-type from this IG |
This structure is derived from Element
Summary
Mandatory: 0 element(5 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: