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: SubmittedManufacturedItem

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

Details around the actual item, i.e tablet, solution, etc. that is packaged as part of the medicinal product.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedItemDefinition 0..* ManufacturedItemDefinition The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product
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
... 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:marketingStatusDates S 0..1 Period Manufactured Item Marketing Status Date Range
URL: http://hl7.org/fhir/us/spl/StructureDefinition/itemMarketingStatusDates
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
Required Pattern: active
... manufacturedDoseForm SΣ 1..1 CodeableConcept Dose form as manufactured (before any necessary transformation)
Binding: SPL Dose Form (required)
ele-1: All FHIR elements must have a @value or children
... Slices for property SΣ 0..* BackboneElement General characteristics of this item
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... property: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
..... type SΣ 1..1 CodeableConcept A code expressing the type of characteristic
Binding: SPL Product Characteristic Types ValueSet (required)
ele-1: All FHIR elements must have a @value or children
..... value[x] SΣ 1..1 A value for the characteristic
ele-1: All FHIR elements must have a @value or children
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueDate date
...... valueBoolean boolean
...... valueMarkdown markdown
...... valueAttachment Attachment
...... valueReference Reference(Binary)
.... property:Color Σ 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: SPL Product Characteristic Types ValueSet (required)
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: SPLCOLOR
..... value[x] SΣ 1..1 CodeableConcept A value for the characteristic
Binding: SPL Color (required)
ele-1: All FHIR elements must have a @value or children
.... property:Imprint Σ 0..1 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: SPL Product Characteristic Types ValueSet (required)
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: SPLIMPRINT
..... value[x] SΣ 1..1 CodeableConcept Text is only allowed as the imprint is a string.
ele-1: All FHIR elements must have a @value or children
...... text Σ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
.... property:Score Σ 0..1 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: SPL Product Characteristic Types ValueSet (required)
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: SPLSCORE
..... value[x] SΣ 1..1 Quantity A value for the characteristic
ele-1: All FHIR elements must have a @value or children
.... property:Shape Σ 0..1 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: SPL Product Characteristic Types ValueSet (required)
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: SPLSHAPE
..... value[x] SΣ 1..1 CodeableConcept A value for the characteristic
Binding: SPL Shape (required)
ele-1: All FHIR elements must have a @value or children
.... property:Size Σ 0..1 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: SPL Product Characteristic Types ValueSet (required)
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: SPLSIZE
..... value[x] SΣ 1..1 Quantity A value for the characteristic
ele-1: All FHIR elements must have a @value or children
.... property:Flavor Σ 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: SPL Product Characteristic Types ValueSet (required)
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: SPLFLAVOR
..... value[x] SΣ 1..1 CodeableConcept A value for the characteristic
Binding: SPL Flavor (required)
ele-1: All FHIR elements must have a @value or children
.... property:Image Σ 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: SPL Product Characteristic Types ValueSet (required)
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: SPLIMAGE
..... value[x] SΣ 1..1 Attachment A value for the characteristic
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ManufacturedItemDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ManufacturedItemDefinition.manufacturedDoseFormrequiredSPLDoseForm
http://hl7.org/fhir/us/spl/ValueSet/valueset-splDoseForm
from this IG
ManufacturedItemDefinition.property.typerequiredSubmittedMedicinalProductCharacteristicTypes (a valid code from SPL Product Characteristic Types CodeSystem)
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Color.typerequiredPattern: SPLCOLOR
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Color.value[x]requiredSPLColor
http://hl7.org/fhir/us/spl/ValueSet/valueset-splColor
from this IG
ManufacturedItemDefinition.property:Imprint.typerequiredPattern: SPLIMPRINT
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Score.typerequiredPattern: SPLSCORE
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Shape.typerequiredPattern: SPLSHAPE
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Shape.value[x]requiredSPLShape
http://hl7.org/fhir/us/spl/ValueSet/valueset-splShape
from this IG
ManufacturedItemDefinition.property:Size.typerequiredPattern: SPLSIZE
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Flavor.typerequiredPattern: SPLFLAVOR
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG
ManufacturedItemDefinition.property:Flavor.value[x]requiredSPLFlavor
http://hl7.org/fhir/us/spl/ValueSet/valueset-splFlavor
from this IG
ManufacturedItemDefinition.property:Image.typerequiredPattern: SPLIMAGE
http://hl7.org/fhir/us/spl/ValueSet/valueset-SubmittedMedicinalProductCharacteristicCodes
from this IG

Constraints

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