SPL Mapping FHIR R5 Implementation Guide
0.2.5 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: SubmittedMedicinalPackaging

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicinalPackaging Version: 0.2.5
Standards status: Trial-use Maturity Level: 1 Computable Name: SubmittedMedicinalPackaging

Details around the packaging of submitted medicinal products.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
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 ?!Σ 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... marketingStatus SΣ 0..1 MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
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
.... status SΣ 1..1 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: SPL Marketing Statuses ValueSet (required)
ele-1: All FHIR elements must have a @value or children
.... dateRange SΣ 1..1 Period The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
ele-1: All FHIR elements must have a @value or children
... packaging SΣ 1..1 BackboneElement A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:packageInstanceOf S 0..1 Reference(SubmittedMedicinalPackaging) Packaged Product Reference
URL: http://hl7.org/fhir/us/spl/StructureDefinition/packageInstanceOf
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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
.... identifier SΣ 0..* Identifier An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
ele-1: All FHIR elements must have a @value or children
.... type SΣ 1..1 CodeableConcept The physical type of the container of the items
Binding: SPL Package Types (required)
ele-1: All FHIR elements must have a @value or children
.... quantity SΣ 0..1 integer The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
ele-1: All FHIR elements must have a @value or children
.... property SΣ 0..* BackboneElement General characteristics of this 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
..... type SΣ 1..1 CodeableConcept A code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.


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)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-characteristicTypes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SPLCMBPRDTP
..... value[x] SΣ 1..1 CodeableConcept A value for the characteristic
Binding: SPL Combo Product Type (required)
ele-1: All FHIR elements must have a @value or children
.... containedItem SΣ 0..* BackboneElement The item(s) within the packaging
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
..... item SΣ 1..1 CodeableReference(SubmittedManufacturedItem) The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
ele-1: All FHIR elements must have a @value or children
..... amount SΣ 1..1 Quantity The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition)
ele-1: All FHIR elements must have a @value or children
.... packaging SΣ 0..* See packaging (PackagedProductDefinition) Allows containers (and parts of containers) within containers, still as a part of single packaged product
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
PackagedProductDefinition.marketingStatus.statusrequiredSPLMarketingStatuses (a valid code from SPL Marketing Statuses CodeSystem)
http://hl7.org/fhir/us/spl/ValueSet/valueset-splMarketingStatuses
from this IG
PackagedProductDefinition.packaging.typerequiredSPLPackageTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-splPackageTypes
from this IG
PackagedProductDefinition.packaging.property.typeexamplePattern: SPLCMBPRDTP
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
PackagedProductDefinition.packaging.property.value[x]requiredSPLComboProductType
http://hl7.org/fhir/us/spl/ValueSet/valueset-splComboProductType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPackagedProductDefinitionIf 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-4errorPackagedProductDefinitionIf 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-5errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePackagedProductDefinitionA 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()

 

Other representations of profile: CSV, Excel, Schematron