UnicomIG
0.1.0 - ci-build
UnicomIG, published by UNICOM. 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/hl7-eu/unicom-ig/ and changes regularly. See the Directory of published versions
Official URL: http://unicom-project.eu/fhir/StructureDefinition/CrossBorderProduct | Version: 0.1.0 | |||
Draft as of 2024-10-11 | Computable Name: CrossBorderProduct |
DRAFT. Crossborder eP/eD/PS medicinal product as a implementation-agnostic logical model
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
@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 |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
@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 |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
@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 |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
@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 |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
@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 |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
@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 |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 Base
Summary
Mandatory: 0 element(15 nested mandatory elements)
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CrossBorderProduct | 0..* | Base | DRAFT: Medicinal Product in crossborder eP/eD Instances of this logical model are not marked to be the target of a Reference | |
medicinalProductIdentifier | 0..* | II | MPID or national identifier | |
packagedProductIdentifier | 0..* | II | PCID or national | |
pharmaceuticalProductIdentifier | 0..* | II | PhPID | |
atc | 1..1 | CD | ATC code | |
packSize | 1..* | PQ | Overall amount of product (100ml; 20 tablets; 1 creme & 6 pessaries) | |
fullName | 0..* | ST | Name of the product | |
doseForm | 1..1 | CD | Authorised dose form for eD; authorised or pharmaceutical for eP | |
constitution | 1..* | Class | Content of the product - defines ingredients, manufactured items, or device | |
@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 |
ingredient | 0..* | Class | Ingredients, by default only active ingredients | |
@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 |
role | 1..1 | CD | (might not be needed if only active ingredients are expected) | |
substance | 1..1 | CD | Substance | |
strengthInfo | 1..* | Class | Concentration or presentation strength | |
@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 |
strength | 1..1 | RTO | Concentration or presentation strength of the precise active ingredient | |
referenceStrength | 0..* | Class | Reference strength; according to the substance+strength type above | |
@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 |
referenceSubstance | 1..1 | CD | Substance for reference strength | |
strength | 1..1 | RTO | Reference strength | |
manufacturedItem | 0..* | Class | Manufactured item if the prescription contains more than one type of items | |
@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 |
doseForm | 1..1 | CD | Manufactured item dose form | |
unitOfPresentation | 0..* | CD | Unit of presentation for the manufactured item | |
containedQuantity | 0..1 | PQ | Manufactured item quantity for liquids (3ml/vial) | |
manufacturedItemQuantity | 1..1 | PQ | Number of such manufactured items in this product (5 vials) | |
device | 0..* | Class | Administrative device included in the product | |
@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 |
deviceQuantity | 1..1 | PQ | Number of such devices | |
device | 1..1 | CD | Device coded | |
marketingAuthorisationHolder | 0..1 | ST | MAH name - do we need more? | |
routeOfAdministration | 1..* | CD | Route of Administration - if we need it on product level | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 Base
Summary
Mandatory: 0 element(15 nested mandatory elements)
Structures
This structure refers to these other structures: