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

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

A profile that allows for the submission of Medicinal Product information to the FDA.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductDefinition 0..* MedicinalProductDefinition Detailed definition of a 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
... 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
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:NDCCode SΣ 1..1 Identifier Business identifier for this product. Could be an MPID
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://hl7.org/fhir/sid/ndc
..... value SΣC 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!Σ 0..1 CodeableConcept The status within the lifecycle of this product record
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... route SΣ 0..* CodeableConcept The path by which the product is taken into or makes contact with the body
Binding: SPL Route of Administration (required)
ele-1: All FHIR elements must have a @value or children
... specialMeasures SΣ 0..* CodeableConcept Whether the Medicinal Product is subject to special measures for regulatory reasons
Binding: SPL Special Measures (required)
ele-1: All FHIR elements must have a @value or children
... marketingStatus SΣ 0..1 MarketingStatus Marketing status of the medicinal product, in contrast to marketing authorization
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
... contact SΣ 0..* BackboneElement A product specific contact, person (in a role), or an organization
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Σ 0..1 CodeableConcept Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information
Binding: Top-Level Organization Types (required)
ele-1: All FHIR elements must have a @value or children
.... contact SΣ 1..1 Reference(IdentifiedEstablishment | IdentifiedEstablishmentRegistrant) A product specific contact, person (in a role), or an organization
ele-1: All FHIR elements must have a @value or children
... Slices for name SΣ 2..* BackboneElement The product's name, including full name and possibly coded parts
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... name: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
..... productName SΣ 1..1 string The full product name
ele-1: All FHIR elements must have a @value or children
..... type SΣ 1..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary
Binding: ProductNameType (example): Type of a name for a Medicinal Product.


ele-1: All FHIR elements must have a @value or children
.... name:Proprietary Σ 1..1 BackboneElement The product's name, including full name and possibly coded parts
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
..... productName SΣ 1..1 string The full product name
ele-1: All FHIR elements must have a @value or children
..... type SΣ 1..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary
Binding: ProductNameType (example): Type of a name for a Medicinal Product.


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-submittedMedicinalProductNameTypes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PROPRIETARY
..... Slices for part SΣ 0..* BackboneElement Coding words or phrases of the name
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
...... part: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
....... part SΣ 1..1 string A fragment of a product name
ele-1: All FHIR elements must have a @value or children
....... type SΣ 1..1 CodeableConcept Identifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


ele-1: All FHIR elements must have a @value or children
...... part:Suffix Σ 0..1 BackboneElement Coding words or phrases of the name
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
....... part SΣ 1..1 string A fragment of a product name
ele-1: All FHIR elements must have a @value or children
....... type SΣ 1..1 CodeableConcept Identifying type for this part of the name (e.g. strength part)
Binding: ProductNamePartType (example): Type of part of a name for a Medicinal Product.


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://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: SFX
.... name:NonProprietary Σ 1..* BackboneElement The product's name, including full name and possibly coded parts
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
..... productName SΣ 1..1 string The full product name
ele-1: All FHIR elements must have a @value or children
..... type SΣ 1..1 CodeableConcept Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary
Binding: ProductNameType (example): Type of a name for a Medicinal Product.


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-submittedMedicinalProductNameTypes
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: NONPROPRIETARY
... crossReference SΣ 0..1 BackboneElement Reference to another product, e.g. for linking authorised to investigational 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
.... product SΣ 1..1 CodeableReference(MedicinalProductDefinition) Reference to another product, e.g. for linking authorised to investigational product
Binding: All NDC Products (required)
ele-1: All FHIR elements must have a @value or children
..... concept SΣ 1..1 CodeableConcept Reference to a concept (by class)
ele-1: All FHIR elements must have a @value or children
.... type SΣ 1..1 CodeableConcept The type of relationship, for instance branded to generic or virtual to actual product
Binding: ProductCrossReferenceType (example): Extra measures defined for a Medicinal Product, such as heightened reporting requirements.


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://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: C64637
... operation SΣ 0..* BackboneElement A manufacturing or administrative process for the medicinal 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
.... type Σ 0..1 CodeableReference(ActivityDefinition | PlanDefinition) The type of manufacturing operation e.g. manufacturing itself, re-packaging
Binding: SPL Operation Type (required)
ele-1: All FHIR elements must have a @value or children
..... concept SΣ 1..1 CodeableConcept Reference to a concept (by class)
ele-1: All FHIR elements must have a @value or children
.... organization SΣ 1..1 Reference(IdentifiedEstablishment) The organization responsible for the particular process, e.g. the manufacturer or importer
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicinalProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
MedicinalProductDefinition.identifier:NDCCode.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
MedicinalProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
MedicinalProductDefinition.routerequiredSPLRouteOfAdministration
http://hl7.org/fhir/us/spl/ValueSet/valueset-splRouteOfAdministration
from this IG
MedicinalProductDefinition.specialMeasuresrequiredSPLSpecialMeasures
http://hl7.org/fhir/us/spl/ValueSet/valueset-splSpecialMeasures
from this IG
MedicinalProductDefinition.marketingStatus.statusrequiredSPLMarketingStatuses (a valid code from SPL Marketing Statuses CodeSystem)
http://hl7.org/fhir/us/spl/ValueSet/valueset-splMarketingStatuses
from this IG
MedicinalProductDefinition.contact.typerequiredTopLevelOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-topLevelOrganizationTypes
from this IG
MedicinalProductDefinition.name.typeexampleProductNameType
http://hl7.org/fhir/ValueSet/medicinal-product-name-type
from the FHIR Standard
MedicinalProductDefinition.name:Proprietary.typeexamplePattern: PROPRIETARY
http://hl7.org/fhir/ValueSet/medicinal-product-name-type
from the FHIR Standard
MedicinalProductDefinition.name:Proprietary.part.typeexampleProductNamePartType
http://hl7.org/fhir/ValueSet/medicinal-product-name-part-type
from the FHIR Standard
MedicinalProductDefinition.name:Proprietary.part:Suffix.typeexamplePattern: SFX
http://hl7.org/fhir/ValueSet/medicinal-product-name-part-type
from the FHIR Standard
MedicinalProductDefinition.name:NonProprietary.typeexamplePattern: NONPROPRIETARY
http://hl7.org/fhir/ValueSet/medicinal-product-name-type
from the FHIR Standard
MedicinalProductDefinition.crossReference.productrequiredAllNDCProducts
http://hl7.org/fhir/us/spl/ValueSet/valueset-AllNDCProducts
from this IG
MedicinalProductDefinition.crossReference.typeexamplePattern: C64637
http://hl7.org/fhir/ValueSet/medicinal-product-cross-reference-type
from the FHIR Standard
MedicinalProductDefinition.operation.typerequiredSPLOperationType
http://hl7.org/fhir/us/spl/ValueSet/valueset-splOperationType
from this IG

Constraints

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