Profile: Medicinal Product

The Medicinal Product resource represents medicinal products authorised to be marketed in Norway and has been adapted to the needs of the Norwegian healthcare services.

Definition by EDQM:
Any substance or combination of substances, which may be administered to human beings or animals for treating or preventing disease, with the view to making a medical diagnosis or to restore, correct or modify physiological functions.
NOTE: A medicinal product may consist of one or more manufactured items and one or more pharmaceutical products.

nametypestatusversionurl
MedicinalProductNOMAMedicinalProductactive2.0.0https://example.org/fhir/StructureDefinition/2.0.0/MedicinalProductNOMA

The Medicinal Product FHIR Information Model

The Medicinal Product FHIR Pofile Structure

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1string
extensionC0..0Extension
url1..1uriFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
id0..1string
extensionC0..*Extension
coding
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical
valueCodecode
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactDetailContactDetail
valueContactPointContactPoint
valueContributorContributor
valueCountCount
valueDataRequirementDataRequirement
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueDistanceDistance
valueDosageDosage
valueDurationDuration
valueExpressionExpression
valueHumanNameHumanName
valueIdid
valueIdentifierIdentifier
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueMetaMeta
valueMoneyMoney
valueOidoid
valueParameterDefinitionParameterDefinition
valuePeriodPeriod
valuePositiveIntpositiveInt
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueReferenceReference
valueRelatedArtifactRelatedArtifact
valueSampledDataSampledData
valueSignatureSignature
valueStringstring
valueTimetime
valueTimingTiming
valueTriggerDefinitionTriggerDefinition
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUsageContextUsageContext
valueUuiduuid
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..0Reference(Organization)
id0..1string
extensionC0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ C0..1Period
assignerΣ C0..0Reference(Organization)
typeΣ0..0CodeableConcept
domainΣ0..0Coding
combinedPharmaceuticalDoseFormΣ0..0CodeableConcept
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..1string
additionalMonitoringIndicatorΣ0..0CodeableConcept
specialMeasuresΣ0..0string
paediatricUseIndicatorΣ0..0CodeableConcept
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..1string
marketingStatusΣ0..0MarketingStatus
pharmaceuticalProductΣ C0..0Reference(MedicinalProductPharmaceutical)
id0..1string
extensionC0..*Extension
referenceΣ C1..1string
typeΣ1..1uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
attachedDocumentΣ C0..0Reference(DocumentReference)
masterFileΣ C0..0Reference(DocumentReference)
contactΣ C0..0Reference(Organization | PractitionerRole)
clinicalTrialΣ C0..0Reference(ResearchStudy)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
productNameΣ1..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
partΣ1..1string
id0..1string
extensionC0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
crossReferenceΣ0..0Identifier
MedicinalProduct
ShortDetailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use) TEST TESST
Definition

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If 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-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
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
MedicinalProduct.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.implicitRules
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
MedicinalProduct.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
MedicinalProduct.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm
ShortThe Medicinal Product's Authorized Pharmaceutical Dose form
Definition

Representing the Authorized Pharmaceutical Dose form for the medicinal product. This may be one of the following types, each defined by a separate Code System. All codes are EDQM codes, except local Norwegian codes not present in EDQM, which are published as supplement. All Urls are preliminary and will be changed in the near future.

Pharmaceutical Dose Form

In this case, the Authorized Pharmaceutical Dose Form is equal to the Manufactured Dose Form on the Manufactured Item Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/c32a474c-be97-4e15-8977-5d0ae6acfaf8
Supplement Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/fca77bf0-11be-4c33-970e-735453b9da1c

Combined pharmaceutical dose form

Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/5e4998a0-9012-4989-95fc-4efc225c331a
Supplement Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/d46985c5-0709-48a9-b0e5-45bb6c6954bf

Combined Term

Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/4e05e38c-ff04-4706-ade1-1365d996b63a
Supplement Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1c30e3f2-869a-4edf-8212-0fdcf322c76f

Combination Pack

Url: https://api.legemiddelverket.no/FHIR-R4/CodeSystem/91fc1aaf-d702-495d-8841-ea2014b04e7e
Supplement Url: N/A

Cardinality0..1
TypeExtension(CodeableConcept)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-authorized-pharmaceutical-dose-form-safest
Mappings
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x]
ShortSpecifies the dose form
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
TypeCodeableConcept
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality0..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.code
ShortThe code of the dose form
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.display
ShortThe name of the dose form
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
MedicinalProduct.extension:nutritionDoseForm
ShortA Medicinal Product's Nutrition Dose Form.
Definition

A Medicinal Product's Nutrition Dose Form, in case it is representing a Nutrition Product.
The URL points to national Nowegian code system used to classify the nutrition dose form.
Utl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/ac8e8700-2554-48eb-af05-d1b8e3e54e9f

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Meaning when missing

When missing, the Medicinal Product is not a nutritional product

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:nutritionDoseForm.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.extension:nutritionDoseForm.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:nutritionDoseForm.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-nutrition-dose-form
Mappings
  • rim: N/A
MedicinalProduct.extension:nutritionDoseForm.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
TypeAddress | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:nutritionDoseForm.value[x].id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.extension:nutritionDoseForm.value[x].extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.extension:nutritionDoseForm.value[x].coding
MedicinalProduct.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.identifier
ShortBusiness identifier for this product. Could be an MPID
Definition

Business identifier for this product. Could be an MPID.

Cardinality0..*
TypeIdentifier
SummaryTrue
AliasMPID
Slicing

Unordered, Open, by

Sliced

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.identifier:nomaMedicinalProductID
ShortEqual to the element's ID
Definition

Equal to the element's ID, specific to NoMA's FHIR API Url (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestMedicinalProductID

Cardinality1..1
TypeIdentifier
SummaryTrue
AliasMPID
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.identifier:nomaMedicinalProductID.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.identifier:nomaMedicinalProductID.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.identifier:nomaMedicinalProductID.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
MedicinalProduct.identifier:nomaMedicinalProductID.type
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
MedicinalProduct.identifier:nomaMedicinalProductID.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicinalProduct.identifier:nomaMedicinalProductID.value
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicinalProduct.identifier:nomaMedicinalProductID.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicinalProduct.identifier:nomaMedicinalProductID.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..0
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
MedicinalProduct.identifier:legemiddelmerkevareId
ShortThe medicinal product's FEST (legemiddelMerkevare) ID
Definition

Ensures referential integrity with the medicinal product's representation in the FEST master data.
Url (preliminary): http://legemiddelverket.no/FEST/LegemiddelMerkevareID There are cases in which two Medicinal Products (temporarily) reference to the same FEST legemiddekMerkevareId, if there is a change in the medicinal product's invented name.

Cardinality0..1
TypeIdentifier
SummaryTrue
AliasMPID
Meaning when missing

When missing, the medicinal product is not represented as a product in the FEST master data. For example if the medicinal product represents a combinationpack or a multi strength package which are not represented as a product in FEST.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.identifier:legemiddelmerkevareId.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.identifier:legemiddelmerkevareId.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.identifier:legemiddelmerkevareId.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
MedicinalProduct.identifier:legemiddelmerkevareId.type
ShortDescription of identifier
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality0..0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
MedicinalProduct.identifier:legemiddelmerkevareId.system
ShortThe namespace for the identifier value
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
MedicinalProduct.identifier:legemiddelmerkevareId.value
ShortThe value that is unique
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality1..1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ExamplesGeneral
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
MedicinalProduct.identifier:legemiddelmerkevareId.period
ShortTime period when id is/was valid for use
Definition

Time period during which identifier is/was valid for use.

Cardinality0..1
TypePeriod
SummaryTrue
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
MedicinalProduct.identifier:legemiddelmerkevareId.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..0
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
MedicinalProduct.type
ShortRegulatory type, e.g. Investigational or Authorized
Definition

Regulatory type, e.g. Investigational or Authorized.

Cardinality0..0
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.domain
ShortIf this medicine applies to human or veterinary uses
Definition

If this medicine applies to human or veterinary uses.

Cardinality0..0
TypeCoding
SummaryTrue
Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
MedicinalProduct.combinedPharmaceuticalDoseForm
ShortThe dose form for a single part product, or combined form of a multiple part product
Definition

The dose form for a single part product, or combined form of a multiple part product.

Cardinality0..0
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.legalStatusOfSupply
ShortThe legal status of supply of the medicinal product as classified by the regulator
Definition

Contains the legal status of supply of the medicinal product if every package connected to it has the same status. If there is one or more packages with different statuses, then the legal status of supply will be defined on the package and this element will be empty.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Details on the Norwegian code system for Legal Status of Supply: Finnkode Reseptgruppe Usually, only the code (e.g. "C") and not the display text (e.g. "Reseptgruppe C") is used by the consumers.

Meaning when missing

When missing, the underlying packages do not all have the same legal status of suppply.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.legalStatusOfSupply.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.legalStatusOfSupply.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.legalStatusOfSupply.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicinalProduct.legalStatusOfSupply.coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.legalStatusOfSupply.coding.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.legalStatusOfSupply.coding.system
ShortIdentity of the terminology system
Definition

(preliminary) https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7421

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicinalProduct.legalStatusOfSupply.coding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicinalProduct.legalStatusOfSupply.coding.code
ShortSymbol in syntax defined by the system
Definition

The letter code for the legal status of supply - A, B, C, F or K

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicinalProduct.legalStatusOfSupply.coding.display
ShortRepresentation defined by the system
Definition

E.g. "Reseptgruppe C"

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicinalProduct.legalStatusOfSupply.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicinalProduct.legalStatusOfSupply.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
MedicinalProduct.additionalMonitoringIndicator
ShortWhether the Medicinal Product is subject to additional monitoring for regulatory reasons
Definition

Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.

Cardinality0..0
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.specialMeasures
ShortWhether the Medicinal Product is subject to special measures for regulatory reasons
Definition

Whether the Medicinal Product is subject to special measures for regulatory reasons.

Cardinality0..0
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.paediatricUseIndicator
ShortIf authorised for use in children
Definition

If authorised for use in children.

Cardinality0..0
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.productClassification
ShortAllows the product to be classified by various systems
Definition

Allows the product to be classified by various systems such as ATC.

Cardinality0..*
TypeCodeableConcept
SummaryTrue
Comments
Published (optional) classification categorie for the Medicinal Product::
Medicinal Product Type (Preparattype)

The medicinal product type Finnkode Preparattype Legemidler.
Cardinality: 0..1
Code: The medicinal product type code
Display: The medicinal product type such as "Legemiddel" or "Enteral ernæring"
Url (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7424

XEVMPD Medicinal Product Type (Søknadstype)

The SPOR RMS classification of a medicinal product according to how itt is authorised. Only used if the medicinal product has been Parallel imported
Cardinality: 0..1
Code: The SPOR RMS code for the classification
Display: THe SPOR RMS name for the classification
Url (preliminary): https://spor.ema.europa.eu/rmswi/#/lists/200000000324/terms

Søknadstype godkjenningsfritak

Whether dispensing the medicinal product requires individual authorisation by the Norwegian Medicinal Agency, is at the discretion of the dispenser or can be dispensed without any further considerations. Code system published at Finnkode Søknadstyper
Cardinality: 0..1
Code: According to the code system
Display: According to the code system
Url (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7422

Har utvidet ernæringsinformasjon

Whether the Medicinal Product has expanded nutritional information such as vitamins and minerals. Used for paranteral nutrition.
Cardinality: 0..1
Code: "true"
Display: "Har utvidet ernæringsinformasjon"
Url (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/81153ebc-9be0-468b-8676-44152dcb04d5

ATC codes

All the medicinal product's ATC code(s). One entry per code. May represent combination of substances according to the medicinal product's ingredients.
Cardinality: 0..*
Code: The ATC code
Display: The (substances) name
Urls (preliminary), one per first-level ATC:

First-level ATC category Url
Alimentary tract and metabolism https://api.legemiddelverket.no/FHIR-R4/CodeSystem/dcedfe5f-d7dd-43f4-a351-8744395249dd
Blood and blood forming organs https://api.legemiddelverket.no/FHIR-R4/CodeSystem/127f5448-fa44-4da4-9589-438749da0158
Cardiovascular system https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e104a7eb-e832-4d57-946d-d402b71ecc22
Dermatologicals https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f5a60497-f1c5-4163-ad34-a3c614d2f6b4
Genito urinary system and sex hormones https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1fd6dad4-6b05-44ee-9a61-9409927bf195
Systemic hormonal preparations, excl. sex hormones and insulins https://api.legemiddelverket.no/FHIR-R4/CodeSystem/bd343711-ab45-4ebd-9f2c-b128f422645e
Antiinfectives for systemic use https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e9f15a26-d384-48c2-a74d-3fa95f44a9dc
Antineoplastic and immunomodulating agents https://api.legemiddelverket.no/FHIR-R4/CodeSystem/849bc27b-a66d-49ad-9389-d8f19d63b480
Musculo-skeletal system https://api.legemiddelverket.no/FHIR-R4/CodeSystem/82311936-f7e3-4c24-8821-229f055f7c64
Nervous system https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f7949a93-d26e-4235-ac5d-d2b898a7aad4
Antiparasitic products, insecticides and repellents https://api.legemiddelverket.no/FHIR-R4/CodeSystem/a9a04ea3-c412-4c27-b191-fddb4ae4d162
Respiratory system https://api.legemiddelverket.no/FHIR-R4/CodeSystem/451f509c-f18b-48e1-ac75-d1852b846eee
Sensory organs https://api.legemiddelverket.no/FHIR-R4/CodeSystem/2949f36e-6b6f-496a-96c8-c61429e75797
Various https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e5390228-1602-4bef-8ca9-fca1771de4d1
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.productClassification.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.productClassification.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.productClassification.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
MedicinalProduct.productClassification.coding.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.productClassification.coding.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.productClassification.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicinalProduct.productClassification.coding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicinalProduct.productClassification.coding.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicinalProduct.productClassification.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicinalProduct.productClassification.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicinalProduct.productClassification.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
MedicinalProduct.marketingStatus
ShortMarketing status of the medicinal product, in contrast to marketing authorizaton
Definition

Marketing status of the medicinal product, in contrast to marketing authorizaton.

Cardinality0..0
TypeMarketingStatus
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.pharmaceuticalProduct
ShortPharmaceutical aspects of product
Definition

Pharmaceutical aspects of product.

Cardinality0..0
TypeReference(MedicinalProductPharmaceutical)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.packagedMedicinalProduct
ShortPackage representation for the product
Definition

Package representation for the product.

Cardinality1..*
TypeReference(MedicinalProductPackaged)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.packagedMedicinalProduct.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.packagedMedicinalProduct.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.packagedMedicinalProduct.reference
ShortLiteral reference, Relative, internal or absolute URL
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Cardinality1..1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, ref-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.packagedMedicinalProduct.type
ShortType the reference refers to (e.g. "Patient")
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Cardinality1..1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.packagedMedicinalProduct.identifier
ShortLogical reference, when literal reference is not known
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Cardinality0..0
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
MedicinalProduct.packagedMedicinalProduct.display
ShortText alternative for the resource
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality0..0
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.attachedDocument
ShortSupporting documentation, typically for regulatory submission
Definition

Supporting documentation, typically for regulatory submission.

Cardinality0..0
TypeReference(DocumentReference)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.masterFile
ShortA master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
Definition

A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).

Cardinality0..0
TypeReference(DocumentReference)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.contact
ShortA product specific contact, person (in a role), or an organization
Definition

A product specific contact, person (in a role), or an organization.

Cardinality0..0
TypeReference(Organization | PractitionerRole)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.clinicalTrial
ShortClinical trials or studies that this product is involved in
Definition

Clinical trials or studies that this product is involved in.

Cardinality0..0
TypeReference(ResearchStudy)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.name
ShortThe product's name, including full name and possibly coded parts
Definition

The product's name, including full name and possibly coded parts. For now, only the "intended name" part is being published.

Cardinality1..*
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.name.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.name.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.productName
ShortThe full product name
Definition

The full product name.

Cardinality1..1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.name.namePart
ShortCoding words or phrases of the name
Definition

Coding words or phrases of the name.

Cardinality0..*
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.name.namePart.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.name.namePart.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.namePart.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.namePart.part
ShortA fragment of a product name
Definition

A fragment of a product name.

Cardinality1..1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.name.namePart.type
ShortIdenifying type for this part of the name (e.g. strength part)
Definition

Idenifying type for this part of the name (e.g. strength part).

Cardinality1..1
TypeCoding
SummaryTrue
Comments

Name part types are coded using SPOR RMS

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
MedicinalProduct.name.namePart.type.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.name.namePart.type.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.namePart.type.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Name part types are coded using SPOR RMS.
Url (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/b9ab9d4b-d268-42cc-82bc-0d4d0d5d3a41

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
MedicinalProduct.name.namePart.type.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
MedicinalProduct.name.namePart.type.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality1..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
MedicinalProduct.name.namePart.type.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
MedicinalProduct.name.namePart.type.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
MedicinalProduct.name.countryLanguage
ShortCountry where the name applies
Definition

Country where the name applies.

Cardinality0..0
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.name.countryLanguage.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.name.countryLanguage.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.countryLanguage.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.name.countryLanguage.country
ShortCountry code for where this name applies
Definition

Country code for where this name applies.

Cardinality1..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.name.countryLanguage.jurisdiction
ShortJurisdiction code for where this name applies
Definition

Jurisdiction code for where this name applies.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.name.countryLanguage.language
ShortLanguage code for this name
Definition

Language code for this name.

Cardinality1..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.crossReference
ShortReference to another product, e.g. for linking authorised to investigational product
Definition

Reference to another product, e.g. for linking authorised to investigational product.

Cardinality0..0
TypeIdentifier
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.manufacturingBusinessOperation
ShortAn operation applied to the product, for manufacturing or adminsitrative purpose
Definition

An operation applied to the product, for manufacturing or adminsitrative purpose.

Cardinality0..0
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.manufacturingBusinessOperation.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.manufacturingBusinessOperation.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.manufacturingBusinessOperation.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.manufacturingBusinessOperation.operationType
ShortThe type of manufacturing operation
Definition

The type of manufacturing operation.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber
ShortRegulatory authorization reference number
Definition

Regulatory authorization reference number.

Cardinality0..1
TypeIdentifier
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.manufacturingBusinessOperation.effectiveDate
ShortRegulatory authorization date
Definition

Regulatory authorization date.

Cardinality0..1
TypedateTime
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator
ShortTo indicate if this proces is commercially confidential
Definition

To indicate if this proces is commercially confidential.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.manufacturingBusinessOperation.manufacturer
ShortThe manufacturer or establishment associated with the process
Definition

The manufacturer or establishment associated with the process.

Cardinality0..*
TypeReference(Organization)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.manufacturingBusinessOperation.regulator
ShortA regulator which oversees the operation
Definition

A regulator which oversees the operation.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
MedicinalProduct.specialDesignation
ShortIndicates if the medicinal product has an orphan designation for the treatment of a rare disease
Definition

Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Cardinality0..0
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.specialDesignation.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
MedicinalProduct.specialDesignation.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.specialDesignation.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MedicinalProduct.specialDesignation.identifier
ShortIdentifier for the designation, or procedure number
Definition

Identifier for the designation, or procedure number.

Cardinality0..*
TypeIdentifier
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
MedicinalProduct.specialDesignation.type
ShortThe type of special designation, e.g. orphan drug, minor use
Definition

The type of special designation, e.g. orphan drug, minor use.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.specialDesignation.intendedUse
ShortThe intended use of the product, e.g. prevention, treatment
Definition

The intended use of the product, e.g. prevention, treatment.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.specialDesignation.indication[x]
ShortCondition for which the medicinal use applies
Definition

Condition for which the medicinal use applies.

Cardinality0..1
TypeCodeableConcept | Reference(MedicinalProductIndication)
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.specialDesignation.status
ShortFor example granted, pending, expired or withdrawn
Definition

For example granted, pending, expired or withdrawn.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
MedicinalProduct.specialDesignation.date
ShortDate when the designation was granted
Definition

Date when the designation was granted.

Cardinality0..1
TypedateTime
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MedicinalProduct.specialDesignation.species
ShortAnimal species for which this applies
Definition

Animal species for which this applies.

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
<StructureDefinition xmlns="http://hl7.org/fhir">
<url value="https://example.org/fhir/StructureDefinition/2.0.0/MedicinalProductNOMA" />
<version value="2.0.0" />
<name value="MedicinalProductNOMA" />
<status value="active" />
<description value="Representing the Medicinal Products approved to be marketed in the Norwegian market. May also represent Nutrition Products." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="MedicinalProduct" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/MedicinalProduct" />
<derivation value="constraint" />
<element id="MedicinalProduct">
<path value="MedicinalProduct" />
<short value="Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use) TEST TESST" />
</element>
<element id="MedicinalProduct.extension:authorizedPharmaceuticalDoseForm">
<path value="MedicinalProduct.extension" />
<sliceName value="authorizedPharmaceuticalDoseForm" />
<short value="The Medicinal Product's Authorized Pharmaceutical Dose form" />
<definition value="Representing the Authorized Pharmaceutical Dose form for the medicinal product. This may be one of the following types, each defined by a separate Code System. All codes are EDQM codes, except local Norwegian codes not present in EDQM, which are published as supplement.\nAll Urls are preliminary and will be changed in the near future.\n\n###### Pharmaceutical Dose Form \nIn this case, the Authorized Pharmaceutical Dose Form is equal to the Manufactured Dose Form on the Manufactured Item\n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/c32a474c-be97-4e15-8977-5d0ae6acfaf8 \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/fca77bf0-11be-4c33-970e-735453b9da1c\n\n###### Combined pharmaceutical dose form \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/5e4998a0-9012-4989-95fc-4efc225c331a \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/d46985c5-0709-48a9-b0e5-45bb6c6954bf\n\n###### Combined Term \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/4e05e38c-ff04-4706-ade1-1365d996b63a \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1c30e3f2-869a-4edf-8212-0fdcf322c76f\n\n###### Combination Pack \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/91fc1aaf-d702-495d-8841-ea2014b04e7e \n**Supplement Url:** N/A" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-authorized-pharmaceutical-dose-form-safest" />
</type>
<isModifier value="false" />
</element>
<element id="MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x]">
<path value="MedicinalProduct.extension.value[x]" />
<short value="Specifies the dose form" />
</element>
<element id="MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.code">
<path value="MedicinalProduct.extension.value[x].coding.code" />
<short value="The code of the dose form" />
</element>
<element id="MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.display">
<path value="MedicinalProduct.extension.value[x].coding.display" />
<short value="The name of the dose form" />
</element>
<element id="MedicinalProduct.extension:nutritionDoseForm">
<path value="MedicinalProduct.extension" />
<sliceName value="nutritionDoseForm" />
<short value="A Medicinal Product's Nutrition Dose Form." />
<definition value="A Medicinal Product's Nutrition Dose Form, in case it is representing a Nutrition Product. \nThe URL points to national Nowegian code system used to classify the nutrition dose form. \nUtl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/ac8e8700-2554-48eb-af05-d1b8e3e54e9f" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-nutrition-dose-form" />
</type>
<meaningWhenMissing value="When missing, the Medicinal Product is not a nutritional product" />
<isModifier value="false" />
</element>
<element id="MedicinalProduct.extension:nutritionDoseForm.value[x].coding.code">
<path value="MedicinalProduct.extension.value[x].coding.code" />
<short value="The code of the nutrition dose form" />
</element>
<element id="MedicinalProduct.extension:nutritionDoseForm.value[x].coding.display">
<path value="MedicinalProduct.extension.value[x].coding.display" />
<short value="The name of the nutrition dose form" />
</element>
<element id="MedicinalProduct.identifier">
<path value="MedicinalProduct.identifier" />
<description value="Sliced" />
<rules value="open" />
</slicing>
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID">
<path value="MedicinalProduct.identifier" />
<sliceName value="nomaMedicinalProductID" />
<short value="Equal to the element's ID" />
<definition value="Equal to the element's ID, specific to NoMA's FHIR API\nUrl (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestMedicinalProductID" />
<min value="1" />
<max value="1" />
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID.use">
<path value="MedicinalProduct.identifier.use" />
<max value="0" />
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID.type">
<path value="MedicinalProduct.identifier.type" />
<max value="0" />
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID.system">
<path value="MedicinalProduct.identifier.system" />
<min value="1" />
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID.value">
<path value="MedicinalProduct.identifier.value" />
<min value="1" />
</element>
<element id="MedicinalProduct.identifier:nomaMedicinalProductID.assigner">
<path value="MedicinalProduct.identifier.assigner" />
<max value="0" />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId">
<path value="MedicinalProduct.identifier" />
<sliceName value="legemiddelmerkevareId" />
<short value="The medicinal product's FEST (legemiddelMerkevare) ID" />
<definition value="Ensures referential integrity with the medicinal product's representation in the FEST master data. \nUrl (preliminary): http://legemiddelverket.no/FEST/LegemiddelMerkevareID\nThere are cases in which two Medicinal Products (temporarily) reference to the same FEST legemiddekMerkevareId, if there is a change in the medicinal product's invented name." />
<max value="1" />
<meaningWhenMissing value="When missing, the medicinal product is not represented as a product in the FEST master data. For example if the medicinal product represents a combinationpack or a multi strength package which are not represented as a product in FEST." />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId.use">
<path value="MedicinalProduct.identifier.use" />
<max value="0" />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId.type">
<path value="MedicinalProduct.identifier.type" />
<max value="0" />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId.system">
<path value="MedicinalProduct.identifier.system" />
<min value="1" />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId.value">
<path value="MedicinalProduct.identifier.value" />
<min value="1" />
</element>
<element id="MedicinalProduct.identifier:legemiddelmerkevareId.assigner">
<path value="MedicinalProduct.identifier.assigner" />
<max value="0" />
</element>
<element id="MedicinalProduct.type">
<path value="MedicinalProduct.type" />
<max value="0" />
</element>
<element id="MedicinalProduct.domain">
<path value="MedicinalProduct.domain" />
<max value="0" />
</element>
<element id="MedicinalProduct.combinedPharmaceuticalDoseForm">
<path value="MedicinalProduct.combinedPharmaceuticalDoseForm" />
<max value="0" />
</element>
<element id="MedicinalProduct.legalStatusOfSupply">
<path value="MedicinalProduct.legalStatusOfSupply" />
<definition value="Contains the legal status of supply of the medicinal product if every package connected to it has the same status. If there is one or more packages with different statuses, then the legal status of supply will be defined on the package and this element will be empty." />
<comment value="Details on the Norwegian code system for Legal Status of Supply: [Finnkode Reseptgruppe](https://finnkode.helsedirektoratet.no/adm/collections/7421?q=7421)\nUsually, only the code (e.g. "C") and not the display text (e.g. "Reseptgruppe C") is used by the consumers." />
<meaningWhenMissing value="When missing, the underlying packages do not all have the same legal status of suppply." />
</element>
<element id="MedicinalProduct.legalStatusOfSupply.coding.system">
<path value="MedicinalProduct.legalStatusOfSupply.coding.system" />
<definition value="(preliminary) https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7421" />
<min value="1" />
</element>
<element id="MedicinalProduct.legalStatusOfSupply.coding.version">
<path value="MedicinalProduct.legalStatusOfSupply.coding.version" />
<max value="0" />
</element>
<element id="MedicinalProduct.legalStatusOfSupply.coding.code">
<path value="MedicinalProduct.legalStatusOfSupply.coding.code" />
<definition value="The letter code for the legal status of supply - A, B, C, F or K" />
<min value="1" />
</element>
<element id="MedicinalProduct.legalStatusOfSupply.coding.display">
<path value="MedicinalProduct.legalStatusOfSupply.coding.display" />
<definition value="E.g. "Reseptgruppe C"" />
</element>
<element id="MedicinalProduct.legalStatusOfSupply.coding.userSelected">
<path value="MedicinalProduct.legalStatusOfSupply.coding.userSelected" />
<max value="0" />
</element>
<element id="MedicinalProduct.additionalMonitoringIndicator">
<path value="MedicinalProduct.additionalMonitoringIndicator" />
<max value="0" />
</element>
<element id="MedicinalProduct.specialMeasures">
<path value="MedicinalProduct.specialMeasures" />
<max value="0" />
</element>
<element id="MedicinalProduct.paediatricUseIndicator">
<path value="MedicinalProduct.paediatricUseIndicator" />
<max value="0" />
</element>
<element id="MedicinalProduct.productClassification">
<path value="MedicinalProduct.productClassification" />
<definition value="Allows the product to be classified by various systems such as ATC." />
<comment value="##### Published (optional) classification categorie for the Medicinal Product::\n\n###### **Medicinal Product Type (Preparattype)**\nThe medicinal product type [Finnkode Preparattype Legemidler](https://finnkode.helsedirektoratet.no/adm/collections/7424?q=7424). \nCardinality: 0..1 \nCode: The medicinal product type code \nDisplay: The medicinal product type such as "Legemiddel" or "Enteral ernæring" \nUrl (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7424 \n###### **XEVMPD Medicinal Product Type (Søknadstype)**\nThe [SPOR RMS classification of a medicinal product](https://spor.ema.europa.eu/rmswi/#/lists/200000000324/terms) according to how itt is authorised. Only used if the medicinal product has been Parallel imported \nCardinality: 0..1 \nCode: The SPOR RMS code for the classification \nDisplay: THe SPOR RMS name for the classification \nUrl (preliminary): https://spor.ema.europa.eu/rmswi/#/lists/200000000324/terms \n###### **Søknadstype godkjenningsfritak**\nWhether dispensing the medicinal product requires individual authorisation by the Norwegian Medicinal Agency, is at the discretion of the dispenser or can be dispensed without any further considerations. Code system published at [Finnkode Søknadstyper](https://finnkode.helsedirektoratet.no/adm/collections/7422?q=7422) \nCardinality: 0..1 \nCode: According to the code system \nDisplay: According to the code system \nUrl (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7422 \n###### **Har utvidet ernæringsinformasjon**\nWhether the Medicinal Product has expanded nutritional information such as vitamins and minerals. Used for paranteral nutrition. \nCardinality: 0..1 \nCode: "true" \nDisplay: "Har utvidet ernæringsinformasjon" \nUrl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/81153ebc-9be0-468b-8676-44152dcb04d5 \n###### **ATC codes**\nAll the medicinal product's ATC code(s). One entry per code. May represent combination of substances according to the medicinal product's ingredients. \nCardinality: 0..* \nCode: The ATC code \nDisplay: The (substances) name \nUrls (preliminary), one per first-level ATC: \n\n| First-level ATC category | Url |\n| :------- | :------ |\n| Alimentary tract and metabolism | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/dcedfe5f-d7dd-43f4-a351-8744395249dd |\n| Blood and blood forming organs | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/127f5448-fa44-4da4-9589-438749da0158 |\n| Cardiovascular system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e104a7eb-e832-4d57-946d-d402b71ecc22 |\n| Dermatologicals | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f5a60497-f1c5-4163-ad34-a3c614d2f6b4 |\n| Genito urinary system and sex hormones | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1fd6dad4-6b05-44ee-9a61-9409927bf195 |\n| Systemic hormonal preparations, excl. sex hormones and insulins | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/bd343711-ab45-4ebd-9f2c-b128f422645e |\n| Antiinfectives for systemic use | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e9f15a26-d384-48c2-a74d-3fa95f44a9dc |\n| Antineoplastic and immunomodulating agents | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/849bc27b-a66d-49ad-9389-d8f19d63b480 |\n| Musculo-skeletal system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/82311936-f7e3-4c24-8821-229f055f7c64 |\n| Nervous system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f7949a93-d26e-4235-ac5d-d2b898a7aad4 |\n| Antiparasitic products, insecticides and repellents | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/a9a04ea3-c412-4c27-b191-fddb4ae4d162 |\n| Respiratory system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/451f509c-f18b-48e1-ac75-d1852b846eee |\n| Sensory organs | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/2949f36e-6b6f-496a-96c8-c61429e75797 |\n| Various | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e5390228-1602-4bef-8ca9-fca1771de4d1 |" />
</element>
<element id="MedicinalProduct.productClassification.coding.system">
<path value="MedicinalProduct.productClassification.coding.system" />
<min value="1" />
</element>
<element id="MedicinalProduct.productClassification.coding.version">
<path value="MedicinalProduct.productClassification.coding.version" />
<max value="0" />
</element>
<element id="MedicinalProduct.productClassification.coding.code">
<path value="MedicinalProduct.productClassification.coding.code" />
<min value="1" />
</element>
<element id="MedicinalProduct.productClassification.coding.userSelected">
<path value="MedicinalProduct.productClassification.coding.userSelected" />
<max value="0" />
</element>
<element id="MedicinalProduct.marketingStatus">
<path value="MedicinalProduct.marketingStatus" />
<max value="0" />
</element>
<element id="MedicinalProduct.pharmaceuticalProduct">
<path value="MedicinalProduct.pharmaceuticalProduct" />
<max value="0" />
</element>
<element id="MedicinalProduct.packagedMedicinalProduct">
<path value="MedicinalProduct.packagedMedicinalProduct" />
<min value="1" />
</element>
<element id="MedicinalProduct.packagedMedicinalProduct.reference">
<path value="MedicinalProduct.packagedMedicinalProduct.reference" />
<min value="1" />
</element>
<element id="MedicinalProduct.packagedMedicinalProduct.type">
<path value="MedicinalProduct.packagedMedicinalProduct.type" />
<min value="1" />
</element>
<element id="MedicinalProduct.packagedMedicinalProduct.identifier">
<path value="MedicinalProduct.packagedMedicinalProduct.identifier" />
<max value="0" />
</element>
<element id="MedicinalProduct.packagedMedicinalProduct.display">
<path value="MedicinalProduct.packagedMedicinalProduct.display" />
<max value="0" />
</element>
<element id="MedicinalProduct.attachedDocument">
<path value="MedicinalProduct.attachedDocument" />
<max value="0" />
</element>
<element id="MedicinalProduct.masterFile">
<path value="MedicinalProduct.masterFile" />
<max value="0" />
</element>
<element id="MedicinalProduct.contact">
<path value="MedicinalProduct.contact" />
<max value="0" />
</element>
<element id="MedicinalProduct.clinicalTrial">
<path value="MedicinalProduct.clinicalTrial" />
<max value="0" />
</element>
<element id="MedicinalProduct.name">
<path value="MedicinalProduct.name" />
<definition value="The product's name, including full name and possibly coded parts.\nFor now, only the "intended name" part is being published." />
</element>
<element id="MedicinalProduct.name.namePart.type">
<path value="MedicinalProduct.name.namePart.type" />
<comment value="Name part types are coded using SPOR RMS" />
</element>
<element id="MedicinalProduct.name.namePart.type.system">
<path value="MedicinalProduct.name.namePart.type.system" />
<comment value="Name part types are coded using SPOR RMS. \nUrl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/b9ab9d4b-d268-42cc-82bc-0d4d0d5d3a41" />
<min value="1" />
</element>
<element id="MedicinalProduct.name.namePart.type.version">
<path value="MedicinalProduct.name.namePart.type.version" />
<max value="0" />
</element>
<element id="MedicinalProduct.name.namePart.type.code">
<path value="MedicinalProduct.name.namePart.type.code" />
<min value="1" />
</element>
<element id="MedicinalProduct.name.namePart.type.userSelected">
<path value="MedicinalProduct.name.namePart.type.userSelected" />
<max value="0" />
</element>
<element id="MedicinalProduct.name.countryLanguage">
<path value="MedicinalProduct.name.countryLanguage" />
<max value="0" />
</element>
<element id="MedicinalProduct.crossReference">
<path value="MedicinalProduct.crossReference" />
<max value="0" />
</element>
<element id="MedicinalProduct.manufacturingBusinessOperation">
<path value="MedicinalProduct.manufacturingBusinessOperation" />
<max value="0" />
</element>
<element id="MedicinalProduct.specialDesignation">
<path value="MedicinalProduct.specialDesignation" />
<max value="0" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"url": "https://example.org/fhir/StructureDefinition/2.0.0/MedicinalProductNOMA",
"version": "2.0.0",
"name": "MedicinalProductNOMA",
"status": "active",
"description": "Representing the Medicinal Products approved to be marketed in the Norwegian market. May also represent Nutrition Products.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "MedicinalProduct",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"derivation": "constraint",
"element": [
{
"id": "MedicinalProduct",
"path": "MedicinalProduct",
"short": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use) TEST TESST"
},
{
"id": "MedicinalProduct.extension:authorizedPharmaceuticalDoseForm",
"path": "MedicinalProduct.extension",
"sliceName": "authorizedPharmaceuticalDoseForm",
"short": "The Medicinal Product's Authorized Pharmaceutical Dose form",
"definition": "Representing the Authorized Pharmaceutical Dose form for the medicinal product. This may be one of the following types, each defined by a separate Code System. All codes are EDQM codes, except local Norwegian codes not present in EDQM, which are published as supplement.\nAll Urls are preliminary and will be changed in the near future.\n\n###### Pharmaceutical Dose Form \nIn this case, the Authorized Pharmaceutical Dose Form is equal to the Manufactured Dose Form on the Manufactured Item\n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/c32a474c-be97-4e15-8977-5d0ae6acfaf8 \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/fca77bf0-11be-4c33-970e-735453b9da1c\n\n###### Combined pharmaceutical dose form \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/5e4998a0-9012-4989-95fc-4efc225c331a \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/d46985c5-0709-48a9-b0e5-45bb6c6954bf\n\n###### Combined Term \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/4e05e38c-ff04-4706-ade1-1365d996b63a \n**Supplement Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1c30e3f2-869a-4edf-8212-0fdcf322c76f\n\n###### Combination Pack \n**Url:** https://api.legemiddelverket.no/FHIR-R4/CodeSystem/91fc1aaf-d702-495d-8841-ea2014b04e7e \n**Supplement Url:** N/A",
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-authorized-pharmaceutical-dose-form-safest"
]
}
],
"isModifier": false
},
{
"id": "MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x]",
"path": "MedicinalProduct.extension.value[x]",
"short": "Specifies the dose form"
},
{
"id": "MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.code",
"path": "MedicinalProduct.extension.value[x].coding.code",
"short": "The code of the dose form"
},
{
"id": "MedicinalProduct.extension:authorizedPharmaceuticalDoseForm.value[x].coding.display",
"path": "MedicinalProduct.extension.value[x].coding.display",
"short": "The name of the dose form"
},
{
"id": "MedicinalProduct.extension:nutritionDoseForm",
"path": "MedicinalProduct.extension",
"sliceName": "nutritionDoseForm",
"short": "A Medicinal Product's Nutrition Dose Form.",
"definition": "A Medicinal Product's Nutrition Dose Form, in case it is representing a Nutrition Product. \nThe URL points to national Nowegian code system used to classify the nutrition dose form. \nUtl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/ac8e8700-2554-48eb-af05-d1b8e3e54e9f",
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/medicinalproduct-nutrition-dose-form"
]
}
],
"meaningWhenMissing": "When missing, the Medicinal Product is not a nutritional product",
"isModifier": false
},
{
"id": "MedicinalProduct.extension:nutritionDoseForm.value[x].coding.code",
"path": "MedicinalProduct.extension.value[x].coding.code",
"short": "The code of the nutrition dose form"
},
{
"id": "MedicinalProduct.extension:nutritionDoseForm.value[x].coding.display",
"path": "MedicinalProduct.extension.value[x].coding.display",
"short": "The name of the nutrition dose form"
},
{
"id": "MedicinalProduct.identifier",
"path": "MedicinalProduct.identifier",
"slicing": {
"description": "Sliced",
"rules": "open"
}
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID",
"path": "MedicinalProduct.identifier",
"sliceName": "nomaMedicinalProductID",
"short": "Equal to the element's ID",
"definition": "Equal to the element's ID, specific to NoMA's FHIR API\nUrl (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestMedicinalProductID",
"min": 1,
"max": "1"
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID.use",
"path": "MedicinalProduct.identifier.use",
"max": "0"
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID.type",
"path": "MedicinalProduct.identifier.type",
"max": "0"
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID.system",
"path": "MedicinalProduct.identifier.system",
"min": 1
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID.value",
"path": "MedicinalProduct.identifier.value",
"min": 1
},
{
"id": "MedicinalProduct.identifier:nomaMedicinalProductID.assigner",
"path": "MedicinalProduct.identifier.assigner",
"max": "0"
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId",
"path": "MedicinalProduct.identifier",
"sliceName": "legemiddelmerkevareId",
"short": "The medicinal product's FEST (legemiddelMerkevare) ID",
"definition": "Ensures referential integrity with the medicinal product's representation in the FEST master data. \nUrl (preliminary): http://legemiddelverket.no/FEST/LegemiddelMerkevareID\nThere are cases in which two Medicinal Products (temporarily) reference to the same FEST legemiddekMerkevareId, if there is a change in the medicinal product's invented name.",
"max": "1",
"meaningWhenMissing": "When missing, the medicinal product is not represented as a product in the FEST master data. For example if the medicinal product represents a combinationpack or a multi strength package which are not represented as a product in FEST."
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId.use",
"path": "MedicinalProduct.identifier.use",
"max": "0"
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId.type",
"path": "MedicinalProduct.identifier.type",
"max": "0"
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId.system",
"path": "MedicinalProduct.identifier.system",
"min": 1
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId.value",
"path": "MedicinalProduct.identifier.value",
"min": 1
},
{
"id": "MedicinalProduct.identifier:legemiddelmerkevareId.assigner",
"path": "MedicinalProduct.identifier.assigner",
"max": "0"
},
{
"id": "MedicinalProduct.type",
"path": "MedicinalProduct.type",
"max": "0"
},
{
"id": "MedicinalProduct.domain",
"path": "MedicinalProduct.domain",
"max": "0"
},
{
"id": "MedicinalProduct.combinedPharmaceuticalDoseForm",
"path": "MedicinalProduct.combinedPharmaceuticalDoseForm",
"max": "0"
},
{
"id": "MedicinalProduct.legalStatusOfSupply",
"path": "MedicinalProduct.legalStatusOfSupply",
"definition": "Contains the legal status of supply of the medicinal product if every package connected to it has the same status. If there is one or more packages with different statuses, then the legal status of supply will be defined on the package and this element will be empty.",
"comment": "Details on the Norwegian code system for Legal Status of Supply: [Finnkode Reseptgruppe](https://finnkode.helsedirektoratet.no/adm/collections/7421?q=7421)\nUsually, only the code (e.g. \"C\") and not the display text (e.g. \"Reseptgruppe C\") is used by the consumers.",
"meaningWhenMissing": "When missing, the underlying packages do not all have the same legal status of suppply."
},
{
"id": "MedicinalProduct.legalStatusOfSupply.coding.system",
"path": "MedicinalProduct.legalStatusOfSupply.coding.system",
"definition": "(preliminary) https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7421",
"min": 1
},
{
"id": "MedicinalProduct.legalStatusOfSupply.coding.version",
"path": "MedicinalProduct.legalStatusOfSupply.coding.version",
"max": "0"
},
{
"id": "MedicinalProduct.legalStatusOfSupply.coding.code",
"path": "MedicinalProduct.legalStatusOfSupply.coding.code",
"definition": "The letter code for the legal status of supply - A, B, C, F or K",
"min": 1
},
{
"id": "MedicinalProduct.legalStatusOfSupply.coding.display",
"path": "MedicinalProduct.legalStatusOfSupply.coding.display",
"definition": "E.g. \"Reseptgruppe C\""
},
{
"id": "MedicinalProduct.legalStatusOfSupply.coding.userSelected",
"path": "MedicinalProduct.legalStatusOfSupply.coding.userSelected",
"max": "0"
},
{
"id": "MedicinalProduct.additionalMonitoringIndicator",
"path": "MedicinalProduct.additionalMonitoringIndicator",
"max": "0"
},
{
"id": "MedicinalProduct.specialMeasures",
"path": "MedicinalProduct.specialMeasures",
"max": "0"
},
{
"id": "MedicinalProduct.paediatricUseIndicator",
"path": "MedicinalProduct.paediatricUseIndicator",
"max": "0"
},
{
"id": "MedicinalProduct.productClassification",
"path": "MedicinalProduct.productClassification",
"definition": "Allows the product to be classified by various systems such as ATC.",
"comment": "##### Published (optional) classification categorie for the Medicinal Product::\n\n###### **Medicinal Product Type (Preparattype)**\nThe medicinal product type [Finnkode Preparattype Legemidler](https://finnkode.helsedirektoratet.no/adm/collections/7424?q=7424). \nCardinality: 0..1 \nCode: The medicinal product type code \nDisplay: The medicinal product type such as \"Legemiddel\" or \"Enteral ernæring\" \nUrl (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7424 \n###### **XEVMPD Medicinal Product Type (Søknadstype)**\nThe [SPOR RMS classification of a medicinal product](https://spor.ema.europa.eu/rmswi/#/lists/200000000324/terms) according to how itt is authorised. Only used if the medicinal product has been Parallel imported \nCardinality: 0..1 \nCode: The SPOR RMS code for the classification \nDisplay: THe SPOR RMS name for the classification \nUrl (preliminary): https://spor.ema.europa.eu/rmswi/#/lists/200000000324/terms \n###### **Søknadstype godkjenningsfritak**\nWhether dispensing the medicinal product requires individual authorisation by the Norwegian Medicinal Agency, is at the discretion of the dispenser or can be dispensed without any further considerations. Code system published at [Finnkode Søknadstyper](https://finnkode.helsedirektoratet.no/adm/collections/7422?q=7422) \nCardinality: 0..1 \nCode: According to the code system \nDisplay: According to the code system \nUrl (preliminary): https://volven.no/toolws/index.asmx/wsAppInfoSchema?strKveKode=7422 \n###### **Har utvidet ernæringsinformasjon**\nWhether the Medicinal Product has expanded nutritional information such as vitamins and minerals. Used for paranteral nutrition. \nCardinality: 0..1 \nCode: \"true\" \nDisplay: \"Har utvidet ernæringsinformasjon\" \nUrl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/81153ebc-9be0-468b-8676-44152dcb04d5 \n###### **ATC codes**\nAll the medicinal product's ATC code(s). One entry per code. May represent combination of substances according to the medicinal product's ingredients. \nCardinality: 0..* \nCode: The ATC code \nDisplay: The (substances) name \nUrls (preliminary), one per first-level ATC: \n\n| First-level ATC category | Url |\n| :------- | :------ |\n| Alimentary tract and metabolism | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/dcedfe5f-d7dd-43f4-a351-8744395249dd |\n| Blood and blood forming organs | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/127f5448-fa44-4da4-9589-438749da0158 |\n| Cardiovascular system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e104a7eb-e832-4d57-946d-d402b71ecc22 |\n| Dermatologicals | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f5a60497-f1c5-4163-ad34-a3c614d2f6b4 |\n| Genito urinary system and sex hormones | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/1fd6dad4-6b05-44ee-9a61-9409927bf195 |\n| Systemic hormonal preparations, excl. sex hormones and insulins | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/bd343711-ab45-4ebd-9f2c-b128f422645e |\n| Antiinfectives for systemic use | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e9f15a26-d384-48c2-a74d-3fa95f44a9dc |\n| Antineoplastic and immunomodulating agents | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/849bc27b-a66d-49ad-9389-d8f19d63b480 |\n| Musculo-skeletal system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/82311936-f7e3-4c24-8821-229f055f7c64 |\n| Nervous system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/f7949a93-d26e-4235-ac5d-d2b898a7aad4 |\n| Antiparasitic products, insecticides and repellents | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/a9a04ea3-c412-4c27-b191-fddb4ae4d162 |\n| Respiratory system | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/451f509c-f18b-48e1-ac75-d1852b846eee |\n| Sensory organs | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/2949f36e-6b6f-496a-96c8-c61429e75797 |\n| Various | https://api.legemiddelverket.no/FHIR-R4/CodeSystem/e5390228-1602-4bef-8ca9-fca1771de4d1 |"
},
{
"id": "MedicinalProduct.productClassification.coding.system",
"path": "MedicinalProduct.productClassification.coding.system",
"min": 1
},
{
"id": "MedicinalProduct.productClassification.coding.version",
"path": "MedicinalProduct.productClassification.coding.version",
"max": "0"
},
{
"id": "MedicinalProduct.productClassification.coding.code",
"path": "MedicinalProduct.productClassification.coding.code",
"min": 1
},
{
"id": "MedicinalProduct.productClassification.coding.userSelected",
"path": "MedicinalProduct.productClassification.coding.userSelected",
"max": "0"
},
{
"id": "MedicinalProduct.marketingStatus",
"path": "MedicinalProduct.marketingStatus",
"max": "0"
},
{
"id": "MedicinalProduct.pharmaceuticalProduct",
"path": "MedicinalProduct.pharmaceuticalProduct",
"max": "0"
},
{
"id": "MedicinalProduct.packagedMedicinalProduct",
"path": "MedicinalProduct.packagedMedicinalProduct",
"min": 1
},
{
"id": "MedicinalProduct.packagedMedicinalProduct.reference",
"path": "MedicinalProduct.packagedMedicinalProduct.reference",
"min": 1
},
{
"id": "MedicinalProduct.packagedMedicinalProduct.type",
"path": "MedicinalProduct.packagedMedicinalProduct.type",
"min": 1
},
{
"id": "MedicinalProduct.packagedMedicinalProduct.identifier",
"path": "MedicinalProduct.packagedMedicinalProduct.identifier",
"max": "0"
},
{
"id": "MedicinalProduct.packagedMedicinalProduct.display",
"path": "MedicinalProduct.packagedMedicinalProduct.display",
"max": "0"
},
{
"id": "MedicinalProduct.attachedDocument",
"path": "MedicinalProduct.attachedDocument",
"max": "0"
},
{
"id": "MedicinalProduct.masterFile",
"path": "MedicinalProduct.masterFile",
"max": "0"
},
{
"id": "MedicinalProduct.contact",
"path": "MedicinalProduct.contact",
"max": "0"
},
{
"id": "MedicinalProduct.clinicalTrial",
"path": "MedicinalProduct.clinicalTrial",
"max": "0"
},
{
"id": "MedicinalProduct.name",
"path": "MedicinalProduct.name",
"definition": "The product's name, including full name and possibly coded parts.\nFor now, only the \"intended name\" part is being published."
},
{
"id": "MedicinalProduct.name.namePart.type",
"path": "MedicinalProduct.name.namePart.type",
"comment": "Name part types are coded using SPOR RMS"
},
{
"id": "MedicinalProduct.name.namePart.type.system",
"path": "MedicinalProduct.name.namePart.type.system",
"comment": "Name part types are coded using SPOR RMS. \nUrl (preliminary): https://api.legemiddelverket.no/FHIR-R4/CodeSystem/b9ab9d4b-d268-42cc-82bc-0d4d0d5d3a41",
"min": 1
},
{
"id": "MedicinalProduct.name.namePart.type.version",
"path": "MedicinalProduct.name.namePart.type.version",
"max": "0"
},
{
"id": "MedicinalProduct.name.namePart.type.code",
"path": "MedicinalProduct.name.namePart.type.code",
"min": 1
},
{
"id": "MedicinalProduct.name.namePart.type.userSelected",
"path": "MedicinalProduct.name.namePart.type.userSelected",
"max": "0"
},
{
"id": "MedicinalProduct.name.countryLanguage",
"path": "MedicinalProduct.name.countryLanguage",
"max": "0"
},
{
"id": "MedicinalProduct.crossReference",
"path": "MedicinalProduct.crossReference",
"max": "0"
},
{
"id": "MedicinalProduct.manufacturingBusinessOperation",
"path": "MedicinalProduct.manufacturingBusinessOperation",
"max": "0"
},
{
"id": "MedicinalProduct.specialDesignation",
"path": "MedicinalProduct.specialDesignation",
"max": "0"
}
]
}
}