Profile: Substance Specification

The Substance Specification resource represents Substances maintained in the NIMA substance database. Substances are part of medicinal and nutrition products and may relate to each other.

nametypestatusversionurl
SubstanceSpecificationNOMASubstanceSpecificationactive2.0.0https://example.org/fhir/StructureDefinition/2.0.0/SubstanceSpecificationNOMA

The Substance Specification FHIR Information Model

The Substance Specification FHIR Pofile Structure

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
statusΣ0..0CodeableConcept
domainΣ0..0CodeableConcept
descriptionΣ0..0string
sourceΣ C0..0Reference(DocumentReference)
commentΣ0..0string
referenceInformationΣ C0..0Reference(SubstanceReferenceInformation)
id0..1string
aliasC0..*Extension
modifierExtensionΣ ?! C0..*Extension
nameΣ1..1string
typeΣ0..1CodeableConcept
statusΣ0..1CodeableConcept
preferredΣ0..1boolean
languageΣ0..*CodeableConcept
domainΣ0..*CodeableConcept
jurisdictionΣ0..*CodeableConcept
synonymΣ0..*see (name)
translationΣ0..*see (name)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
authorityΣ0..1CodeableConcept
statusΣ0..1CodeableConcept
dateΣ0..1dateTime
sourceΣ C0..*Reference(DocumentReference)
molecularWeightΣ0..0see (molecularWeight)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
substanceCodeableConceptCodeableConcept
substanceReferenceReference(SubstanceSpecification)
relationshipΣ0..1CodeableConcept
isDefiningΣ0..1boolean
amountRatioLowLimitΣ C0..1Ratio
amountTypeΣ0..1CodeableConcept
sourceΣ C0..*Reference(DocumentReference)
nucleicAcidΣ C0..0Reference(SubstanceNucleicAcid)
polymerΣ C0..0Reference(SubstancePolymer)
proteinΣ C0..0Reference(SubstanceProtein)
sourceMaterialΣ C0..0Reference(SubstanceSourceMaterial)
SMSIDC0..*Extension
UniiCodeC0..*Extension
FestIdC1..*Extension
classificationC0..*Extension(CodeableConcept)
SubstanceSpecification
ShortThe detailed description of a substance, typically at a level beyond what is used for prescribing
Definition

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Cardinality0..*
AliasSubstanceDefinition (FHIR R5)
Comments

Based on ISO 11238

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
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.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?
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.identifier
ShortIndentifier for the substance.
Definition

Identifier by which this substance is known, specific to NoMA's FHIR API Url (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID
Alternative (business) identifiers - SMS ID, UniiCode and FEST ID - are provided in the extension. since the identifier attribute can provide at most one identifier.

Cardinality1..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
SubstanceSpecification.identifier.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
SubstanceSpecification.identifier.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
SubstanceSpecification.identifier.use
Shortusual | official | temp | secondary | old (If known)
Definition

The purpose of this identifier.

Cardinality0..1
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
SubstanceSpecification.identifier.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..1
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
SubstanceSpecification.identifier.system
ShortThe namespace for the identifier value
Definition

The namespace is preliminary and will be replaced with a stable "GUPRI"

Cardinality0..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())
Fixed Value
http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID
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
SubstanceSpecification.identifier.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.

Cardinality0..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
SubstanceSpecification.identifier.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
SubstanceSpecification.identifier.assigner
ShortOrganization that issued id (may be just text)
Definition

Organization that issued/manages the identifier.

Cardinality0..1
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
SubstanceSpecification.type
ShortHigh level categorization, e.g. chemical, polymer or nucleic acid
Definition

High level categorization, e.g. chemical, polymer or nucleic acid.

Cardinality0..1
TypeCodeableConcept
Binding

SPOR RMS Substance Types

https://spor.ema.europa.eu/rmswi/#/lists/100000075826/terms (example)

SummaryTrue
Aliascategory
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
SubstanceSpecification.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
SubstanceSpecification.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
SubstanceSpecification.type.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
SubstanceSpecification.type.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
SubstanceSpecification.type.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
SubstanceSpecification.type.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code. The system URL is preliminary and will be replaced with a stable "GUPRI"

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())
Fixed Value
https://api.legemiddelverket.no/FHIR-R4/CodeSystem/905de22c-b0f9-4ad5-bfcb-08e1d6fef20d
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
SubstanceSpecification.type.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
SubstanceSpecification.type.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).

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
SubstanceSpecification.type.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
SubstanceSpecification.type.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 ]
SubstanceSpecification.type.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
SubstanceSpecification.status
ShortStatus of substance within the catalogue e.g. approved
Definition

Status of substance within the catalogue e.g. approved.

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
SubstanceSpecification.domain
ShortIf the substance applies to only human or veterinary use
Definition

If the substance applies to only human or veterinary use.

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
SubstanceSpecification.description
ShortTextual description of the substance
Definition

Textual description of the substance.

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
SubstanceSpecification.source
ShortSupporting literature
Definition

Supporting literature.

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)
SubstanceSpecification.comment
ShortTextual comment about this record of a substance
Definition

Textual comment about this record of a substance.

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
SubstanceSpecification.moiety
ShortMoiety, for structural modifications
Definition

Moiety, for structural modifications.

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
SubstanceSpecification.moiety.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
SubstanceSpecification.moiety.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
SubstanceSpecification.moiety.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
SubstanceSpecification.moiety.role
ShortRole that the moiety is playing
Definition

Role that the moiety is playing.

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
SubstanceSpecification.moiety.identifier
ShortIdentifier by which this moiety substance is known
Definition

Identifier by which this moiety substance is known.

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
SubstanceSpecification.moiety.name
ShortTextual name for this moiety substance
Definition

Textual name for this moiety substance.

Cardinality0..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
SubstanceSpecification.moiety.stereochemistry
ShortStereochemistry type
Definition

Stereochemistry type.

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
SubstanceSpecification.moiety.opticalActivity
ShortOptical activity type
Definition

Optical activity type.

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
SubstanceSpecification.moiety.molecularFormula
ShortMolecular formula
Definition

Molecular formula.

Cardinality0..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
SubstanceSpecification.moiety.amount[x]
ShortQuantitative value for this moiety
Definition

Quantitative value for this moiety.

Cardinality0..1
TypeQuantity | string
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
SubstanceSpecification.property
ShortGeneral specifications for this substance, including how it is related to other substances
Definition

General specifications for this substance, including how it is related to other substances.

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
SubstanceSpecification.property.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
SubstanceSpecification.property.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
SubstanceSpecification.property.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
SubstanceSpecification.property.category
ShortA category for this property, e.g. Physical, Chemical, Enzymatic
Definition

A category for this property, e.g. Physical, Chemical, Enzymatic.

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
SubstanceSpecification.property.code
ShortProperty type e.g. viscosity, pH, isoelectric point
Definition

Property type e.g. viscosity, pH, isoelectric point.

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
SubstanceSpecification.property.parameters
ShortParameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
Definition

Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).

Cardinality0..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
SubstanceSpecification.property.definingSubstance[x]
ShortA substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
Definition

A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).

Cardinality0..1
TypeCodeableConcept | Reference(Substance | SubstanceSpecification)
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
SubstanceSpecification.property.amount[x]
ShortQuantitative value for this property
Definition

Quantitative value for this property.

Cardinality0..1
TypeQuantity | string
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
SubstanceSpecification.referenceInformation
ShortGeneral information detailing this substance
Definition

General information detailing this substance.

Cardinality0..0
TypeReference(SubstanceReferenceInformation)
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)
SubstanceSpecification.structure
ShortStructural information
Definition

Structural information.

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
SubstanceSpecification.structure.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
SubstanceSpecification.structure.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
SubstanceSpecification.structure.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
SubstanceSpecification.structure.stereochemistry
ShortStereochemistry type
Definition

Stereochemistry type.

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
SubstanceSpecification.structure.opticalActivity
ShortOptical activity type
Definition

Optical activity type.

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
SubstanceSpecification.structure.molecularFormula
ShortMolecular formula
Definition

Molecular formula.

Cardinality0..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
SubstanceSpecification.structure.molecularFormulaByMoiety
ShortSpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
Definition

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.

Cardinality0..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
SubstanceSpecification.structure.isotope
ShortApplicable for single substances that contain a radionuclide or a non-natural isotopic ratio
Definition

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

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
SubstanceSpecification.structure.isotope.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
SubstanceSpecification.structure.isotope.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
SubstanceSpecification.structure.isotope.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
SubstanceSpecification.structure.isotope.identifier
ShortSubstance identifier for each non-natural or radioisotope
Definition

Substance identifier for each non-natural or radioisotope.

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
SubstanceSpecification.structure.isotope.name
ShortSubstance name for each non-natural or radioisotope
Definition

Substance name for each non-natural or radioisotope.

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
SubstanceSpecification.structure.isotope.substitution
ShortThe type of isotopic substitution present in a single substance
Definition

The type of isotopic substitution present in a single substance.

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
SubstanceSpecification.structure.isotope.halfLife
ShortHalf life - for a non-natural nuclide
Definition

Half life - for a non-natural nuclide.

Cardinality0..1
TypeQuantity
SummaryTrue
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
SubstanceSpecification.structure.isotope.molecularWeight
ShortThe molecular weight or weight range (for proteins, polymers or nucleic acids)
Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Cardinality0..1
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
SubstanceSpecification.structure.isotope.molecularWeight.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
SubstanceSpecification.structure.isotope.molecularWeight.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
SubstanceSpecification.structure.isotope.molecularWeight.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
SubstanceSpecification.structure.isotope.molecularWeight.method
ShortThe method by which the molecular weight was determined
Definition

The method by which the molecular weight was determined.

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
SubstanceSpecification.structure.isotope.molecularWeight.type
ShortType of molecular weight such as exact, average (also known as. number average), weight average
Definition

Type of molecular weight such as exact, average (also known as. number average), weight average.

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
SubstanceSpecification.structure.isotope.molecularWeight.amount
ShortUsed to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field
Definition

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

Cardinality0..1
TypeQuantity
SummaryTrue
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

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())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
SubstanceSpecification.structure.molecularWeight
ShortThe molecular weight or weight range (for proteins, polymers or nucleic acids)
Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Cardinality0..1
Typesee (molecularWeight)
SummaryTrue
SubstanceSpecification.structure.source
ShortSupporting literature
Definition

Supporting literature.

Cardinality0..*
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)
SubstanceSpecification.structure.representation
ShortMolecular structural representation
Definition

Molecular structural representation.

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
SubstanceSpecification.structure.representation.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
SubstanceSpecification.structure.representation.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
SubstanceSpecification.structure.representation.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
SubstanceSpecification.structure.representation.type
ShortThe type of structure (e.g. Full, Partial, Representative)
Definition

The type of structure (e.g. Full, Partial, Representative).

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
SubstanceSpecification.structure.representation.representation
ShortThe structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX
Definition

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.

Cardinality0..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
SubstanceSpecification.structure.representation.attachment
ShortAn attached file with the structural representation
Definition

An attached file with the structural representation.

Cardinality0..1
TypeAttachment
SummaryTrue
Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

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())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
SubstanceSpecification.code
ShortCodes associated with the substance
Definition

Codes associated with the substance.

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
SubstanceSpecification.code.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
SubstanceSpecification.code.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
SubstanceSpecification.code.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
SubstanceSpecification.code.code
ShortThe specific code
Definition

The specific code.

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
SubstanceSpecification.code.status
ShortStatus of the code assignment
Definition

Status of the code assignment.

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
SubstanceSpecification.code.statusDate
ShortThe date at which the code status is changed as part of the terminology maintenance
Definition

The date at which the code status is changed as part of the terminology maintenance.

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
SubstanceSpecification.code.comment
ShortAny comment can be provided in this field, if necessary
Definition

Any comment can be provided in this field, if necessary.

Cardinality0..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
SubstanceSpecification.code.source
ShortSupporting literature
Definition

Supporting literature.

Cardinality0..*
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)
SubstanceSpecification.name
ShortNames applicable to this substance
Definition

Names applicable to this substance.. Provided in Norwegian, English and (if exists) Latin

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
SubstanceSpecification.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
SubstanceSpecification.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, alias
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
SubstanceSpecification.name.extension:alias
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.

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
SubstanceSpecification.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
SubstanceSpecification.name.name
ShortThe actual name
Definition

The actual 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
SubstanceSpecification.name.type
ShortName type
Definition

Name type.

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
SubstanceSpecification.name.status
ShortThe status of the name
Definition

The status of the name.

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
SubstanceSpecification.name.preferred
ShortIf this is the preferred name for this substance
Definition

If this is the preferred name for this substance.

Cardinality0..1
Typeboolean
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
SubstanceSpecification.name.language
ShortLanguage of the name
Definition

Language of the name. Norwegian, English or (if exists) Latin

Cardinality0..*
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
SubstanceSpecification.name.domain
ShortThe use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
Definition

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

Cardinality0..*
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
SubstanceSpecification.name.jurisdiction
ShortThe jurisdiction where this name applies
Definition

The jurisdiction where this name applies.

Cardinality0..*
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
SubstanceSpecification.name.synonym
ShortA synonym of this name
Definition

A synonym of this name.

Cardinality0..*
Typesee (name)
SummaryTrue
SubstanceSpecification.name.translation
ShortA translation for this name
Definition

A translation for this name.

Cardinality0..*
Typesee (name)
SummaryTrue
SubstanceSpecification.name.official
ShortDetails of the official nature of this name
Definition

Details of the official nature of this 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
SubstanceSpecification.name.official.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
SubstanceSpecification.name.official.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
SubstanceSpecification.name.official.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
SubstanceSpecification.name.official.authority
ShortWhich authority uses this official name
Definition

Which authority uses this official name.

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
SubstanceSpecification.name.official.status
ShortThe status of the official name
Definition

The status of the official name.

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
SubstanceSpecification.name.official.date
ShortDate of official name change
Definition

Date of official name change.

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
SubstanceSpecification.name.source
ShortSupporting literature
Definition

Supporting literature.

Cardinality0..*
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)
SubstanceSpecification.molecularWeight
ShortThe molecular weight or weight range (for proteins, polymers or nucleic acids)
Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Cardinality0..0
Typesee (molecularWeight)
SummaryTrue
SubstanceSpecification.relationship
ShortA link between this substance and another, with details of the relationship
Definition

A link between this substance and another, with details of the relationship.

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
SubstanceSpecification.relationship.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
SubstanceSpecification.relationship.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
SubstanceSpecification.relationship.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
SubstanceSpecification.relationship.substance[x]
ShortA pointer to another substance, as a resource or just a representational code
Definition

A pointer to another substance, as a resource or just a representational code.

Cardinality0..1
TypeCodeableConcept | Reference(SubstanceSpecification)
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
SubstanceSpecification.relationship.relationship
ShortFor example "salt to parent", "active moiety", "starting material"
Definition

For example "salt to parent", "active moiety", "starting material".

Cardinality0..1
TypeCodeableConcept
SummaryTrue
Aliastype
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
SubstanceSpecification.relationship.isDefining
ShortFor example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
Definition

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

Cardinality0..1
Typeboolean
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
SubstanceSpecification.relationship.amount[x]
ShortA numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Cardinality0..0
TypeQuantity | Range | Ratio | string
SummaryTrue
Slicing

Unordered, Open, by $this(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
SubstanceSpecification.relationship.amount[x]:amountQuantity
ShortA numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Cardinality0..0
TypeQuantity
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
SubstanceSpecification.relationship.amount[x]:amountRange
ShortA numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Cardinality0..0
TypeRange
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
SubstanceSpecification.relationship.amount[x]:amountRatio
ShortA numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Cardinality0..0
TypeRatio
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
SubstanceSpecification.relationship.amount[x]:amountString
ShortA numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Cardinality0..0
Typestring
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
SubstanceSpecification.relationship.amountRatioLowLimit
ShortFor use when the numeric
Definition

For use when the numeric.

Cardinality0..1
TypeRatio
SummaryTrue
Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

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())
  • rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
    (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: RTO
SubstanceSpecification.relationship.amountType
ShortAn operator for the amount, for example "average", "approximately", "less than"
Definition

An operator for the amount, for example "average", "approximately", "less than".

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
SubstanceSpecification.relationship.source
ShortSupporting literature
Definition

Supporting literature.

Cardinality0..*
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)
SubstanceSpecification.nucleicAcid
ShortData items specific to nucleic acids
Definition

Data items specific to nucleic acids.

Cardinality0..0
TypeReference(SubstanceNucleicAcid)
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)
SubstanceSpecification.polymer
ShortData items specific to polymers
Definition

Data items specific to polymers.

Cardinality0..0
TypeReference(SubstancePolymer)
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)
SubstanceSpecification.protein
ShortData items specific to proteins
Definition

Data items specific to proteins.

Cardinality0..0
TypeReference(SubstanceProtein)
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)
SubstanceSpecification.sourceMaterial
ShortMaterial or taxonomic/anatomical source for the substance
Definition

Material or taxonomic/anatomical source for the substance.

Cardinality0..0
TypeReference(SubstanceSourceMaterial)
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)
SubstanceSpecification.extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

Cardinality1..*
TypeExtension
Slicing

Ordered, Open, by url(Value)

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
SubstanceSpecification.extension:SMSID
ShortSPOR SMS ID
Definition

The substance ID in the EMA SPOR substances management services. Identifies substnaces in EU marketing authorisations.

Cardinality0..*
TypeExtension
Requirements

Provides ability to map substances between different substance master data systems

Comments

URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/SMSID

Meaning when missing

SPOR does not contain the relevant substance

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
SubstanceSpecification.extension:UniiCode
ShortGSRS Substance ID
Definition

The Unique Ingredient Identifier (UNII) generated by the Global Substance Registration System (GSRS) of the US Food and Drug Administration.

Cardinality0..*
TypeExtension
Requirements

Provides ability to map substances between different susbtance master data systems

Comments

URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/UniiCode

Meaning when missing

GSRS does not contain the relevant substance

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
SubstanceSpecification.extension:FestId
ShortFEST substance ID
Definition

The substance ID in the FEST medicinal product master data

Cardinality1..*
TypeExtension
Comments

URL (preliminary): http://legemiddelverket.no/FEST/SubstansID

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
SubstanceSpecification.extension:classification
ShortClassifies the substance
Definition

Optional xtension for classifying substances.

Cardinality0..*
TypeExtension(CodeableConcept)
Comments
Published (optional) classification categories:
E-Number

The substance's E-number(s). A substance can have multiple e-numbers. Cardinality: 0..*
Code: The E-number
Display: The E-number name (substance)
Url (preliminary): https://simplifier.net/safest/e-number

Is Therapeutic

Whether the substance is therapeutic (only published when "true").
Cardinality: 0..1
Code: "true"
Display: "Er terapautisk del"
Url (preliminary): https://simplifier.net/safest/activemoiety

Is Prodrug

Whether the substance is a prodrug (only published when "true")
Cardinality: 0..1
Code: "true"
Display: "Er prodrug"
Url (preliminary): ttps://simplifier.net/safest/prodrug

Is Complex

Whether the substance is complex (only published when "true")
Cardinality: 0..1
Code: "true"
Display: "Er kompleks"
Url (preliminary): https://simplifier.net/safest/complex

ATC codes

All the substance's ATC code(s). Human codes only. Cardinality: 0..*
Code: The ATC code
Display: The (substance) 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())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="SubstanceSpecificationNOMA2.0.1" />
<url value="https://example.org/fhir/StructureDefinition/2.0.0/SubstanceSpecificationNOMA" />
<version value="2.0.0" />
<name value="SubstanceSpecificationNOMA" />
<status value="active" />
<description value="Representing the Substances in the Norwegian Substance database" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="SubstanceSpecification" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/SubstanceSpecification" />
<derivation value="constraint" />
<element id="SubstanceSpecification">
<path value="SubstanceSpecification" />
<comment value="Based on ISO 11238" />
<alias value="SubstanceDefinition (FHIR R5)" />
</element>
<element id="SubstanceSpecification.identifier">
<path value="SubstanceSpecification.identifier" />
<short value="Indentifier for the substance." />
<definition value="Identifier by which this substance is known, specific to NoMA's FHIR API\nUrl (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID \nAlternative (business) identifiers - SMS ID, UniiCode and FEST ID - are provided in the extension. since the identifier attribute can provide at most one identifier." />
<min value="1" />
</element>
<element id="SubstanceSpecification.identifier.system">
<path value="SubstanceSpecification.identifier.system" />
<definition value="The namespace is preliminary and will be replaced with a stable "GUPRI"" />
<fixedUri value="http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID" />
</element>
<element id="SubstanceSpecification.type">
<path value="SubstanceSpecification.type" />
<short value="High level categorization, e.g. chemical, polymer or nucleic acid" />
<definition value="High level categorization, e.g. chemical, polymer or nucleic acid." />
<alias value="category" />
<strength value="example" />
<description value="SPOR RMS Substance Types" />
<valueSet value="https://spor.ema.europa.eu/rmswi/#/lists/100000075826/terms" />
</binding>
</element>
<element id="SubstanceSpecification.type.coding.system">
<path value="SubstanceSpecification.type.coding.system" />
<definition value="The identification of the code system that defines the meaning of the symbol in the code.\nThe system URL is preliminary and will be replaced with a stable "GUPRI"" />
<fixedUri value="https://api.legemiddelverket.no/FHIR-R4/CodeSystem/905de22c-b0f9-4ad5-bfcb-08e1d6fef20d" />
</element>
<element id="SubstanceSpecification.status">
<path value="SubstanceSpecification.status" />
<max value="0" />
</element>
<element id="SubstanceSpecification.domain">
<path value="SubstanceSpecification.domain" />
<max value="0" />
</element>
<element id="SubstanceSpecification.description">
<path value="SubstanceSpecification.description" />
<max value="0" />
</element>
<element id="SubstanceSpecification.source">
<path value="SubstanceSpecification.source" />
<max value="0" />
</element>
<element id="SubstanceSpecification.comment">
<path value="SubstanceSpecification.comment" />
<max value="0" />
</element>
<element id="SubstanceSpecification.moiety">
<path value="SubstanceSpecification.moiety" />
<max value="0" />
</element>
<element id="SubstanceSpecification.property">
<path value="SubstanceSpecification.property" />
<max value="0" />
</element>
<element id="SubstanceSpecification.referenceInformation">
<path value="SubstanceSpecification.referenceInformation" />
<max value="0" />
</element>
<element id="SubstanceSpecification.structure">
<path value="SubstanceSpecification.structure" />
<max value="0" />
</element>
<element id="SubstanceSpecification.code">
<path value="SubstanceSpecification.code" />
<max value="0" />
</element>
<element id="SubstanceSpecification.name">
<path value="SubstanceSpecification.name" />
<definition value="Names applicable to this substance.. Provided in Norwegian, English and (if exists) Latin" />
</element>
<element id="SubstanceSpecification.name.extension">
<path value="SubstanceSpecification.name.extension" />
<alias value="alias" />
</element>
<element id="SubstanceSpecification.name.extension:alias">
<path value="SubstanceSpecification.name.extension" />
<sliceName value="alias" />
<code value="Extension" />
<profile value="https://example.org/fhir/StructureDefinition/SubstanceSpecificationNameAliasNOMA" />
</type>
<isModifier value="false" />
</element>
<element id="SubstanceSpecification.name.language">
<path value="SubstanceSpecification.name.language" />
<definition value="Language of the name. Norwegian, English or (if exists) Latin" />
</element>
<element id="SubstanceSpecification.molecularWeight">
<path value="SubstanceSpecification.molecularWeight" />
<max value="0" />
</element>
<element id="SubstanceSpecification.relationship.relationship">
<path value="SubstanceSpecification.relationship.relationship" />
<alias value="type" />
</element>
<element id="SubstanceSpecification.relationship.amount[x]">
<path value="SubstanceSpecification.relationship.amount[x]" />
<type value="type" />
<path value="$this" />
</discriminator>
<rules value="open" />
</slicing>
<max value="0" />
</element>
<element id="SubstanceSpecification.relationship.amount[x]:amountQuantity">
<path value="SubstanceSpecification.relationship.amount[x]" />
<sliceName value="amountQuantity" />
<max value="0" />
<code value="Quantity" />
</type>
</element>
<element id="SubstanceSpecification.relationship.amount[x]:amountRange">
<path value="SubstanceSpecification.relationship.amount[x]" />
<sliceName value="amountRange" />
<max value="0" />
<code value="Range" />
</type>
</element>
<element id="SubstanceSpecification.relationship.amount[x]:amountRatio">
<path value="SubstanceSpecification.relationship.amount[x]" />
<sliceName value="amountRatio" />
<max value="0" />
<code value="Ratio" />
</type>
</element>
<element id="SubstanceSpecification.relationship.amount[x]:amountString">
<path value="SubstanceSpecification.relationship.amount[x]" />
<sliceName value="amountString" />
<max value="0" />
<code value="string" />
</type>
</element>
<element id="SubstanceSpecification.nucleicAcid">
<path value="SubstanceSpecification.nucleicAcid" />
<max value="0" />
</element>
<element id="SubstanceSpecification.polymer">
<path value="SubstanceSpecification.polymer" />
<max value="0" />
</element>
<element id="SubstanceSpecification.protein">
<path value="SubstanceSpecification.protein" />
<max value="0" />
</element>
<element id="SubstanceSpecification.sourceMaterial">
<path value="SubstanceSpecification.sourceMaterial" />
<max value="0" />
</element>
<element id="SubstanceSpecification.extension">
<path value="SubstanceSpecification.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="true" />
<rules value="open" />
</slicing>
<min value="1" />
<code value="Extension" />
</type>
<mustSupport value="false" />
<isModifier value="false" />
</element>
<element id="SubstanceSpecification.extension:SMSID">
<path value="SubstanceSpecification.extension" />
<sliceName value="SMSID" />
<short value="SPOR SMS ID" />
<definition value="The substance ID in the [EMA SPOR substances management services](https://spor.ema.europa.eu/smswi/#/). \nIdentifies substnaces in EU marketing authorisations." />
<comment value="URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/SMSID" />
<requirements value="Provides ability to map substances between different substance master data systems" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension" />
</type>
<meaningWhenMissing value="SPOR does not contain the relevant substance" />
<isModifier value="false" />
</element>
<element id="SubstanceSpecification.extension:UniiCode">
<path value="SubstanceSpecification.extension" />
<sliceName value="UniiCode" />
<short value="GSRS Substance ID" />
<definition value="The Unique Ingredient Identifier (UNII) generated by the [Global Substance Registration System (GSRS)](https://gsrs.ncats.nih.gov/) of the US Food and Drug Administration." />
<comment value="URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/UniiCode" />
<requirements value="Provides ability to map substances between different susbtance master data systems" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension" />
</type>
<meaningWhenMissing value="GSRS does not contain the relevant substance" />
<isModifier value="false" />
</element>
<element id="SubstanceSpecification.extension:FestId">
<path value="SubstanceSpecification.extension" />
<sliceName value="FestId" />
<short value="FEST substance ID" />
<definition value="The substance ID in the [FEST medicinal product master data](https://www.dmp.no/om-oss/distribusjon-av-legemiddeldata/fest)" />
<comment value="URL (preliminary): http://legemiddelverket.no/FEST/SubstansID" />
<min value="1" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension" />
</type>
<isModifier value="false" />
</element>
<element id="SubstanceSpecification.extension:classification">
<path value="SubstanceSpecification.extension" />
<sliceName value="classification" />
<short value="Classifies the substance" />
<definition value="Optional xtension for classifying substances." />
<comment value="##### Published (optional) classification categories:\n\n###### **E-Number**\nThe substance's [E-number(s)](https://ec.europa.eu/food/food-feed-portal/screen/food-additives/search). A substance can have multiple e-numbers.\nCardinality: 0..* \nCode: The E-number \nDisplay: The E-number name (substance) \nUrl (preliminary): https://simplifier.net/safest/e-number\n###### **Is Therapeutic**\nWhether the substance is therapeutic (only published when "true"). \nCardinality: 0..1 \nCode: "true" \nDisplay: "Er terapautisk del" \nUrl (preliminary): https://simplifier.net/safest/activemoiety\n###### **Is Prodrug**\nWhether the substance is a prodrug (only published when "true") \nCardinality: 0..1 \nCode: "true" \nDisplay: "Er prodrug" \nUrl (preliminary): ttps://simplifier.net/safest/prodrug\n###### **Is Complex**\nWhether the substance is complex (only published when "true") \nCardinality: 0..1 \nCode: "true" \nDisplay: "Er kompleks" \nUrl (preliminary): https://simplifier.net/safest/complex \n###### **ATC codes**\nAll the substance's ATC code(s). Human codes only.\nCardinality: 0..* \nCode: The ATC code \nDisplay: The (substance) 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 |" />
<code value="Extension" />
<profile value="http://legemiddelverket.no/fhir/StructureDefinition/substancespecification-classification" />
</type>
<isModifier value="false" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "SubstanceSpecificationNOMA2.0.1",
"url": "https://example.org/fhir/StructureDefinition/2.0.0/SubstanceSpecificationNOMA",
"version": "2.0.0",
"name": "SubstanceSpecificationNOMA",
"status": "active",
"description": "Representing the Substances in the Norwegian Substance database",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "SubstanceSpecification",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"derivation": "constraint",
"element": [
{
"id": "SubstanceSpecification",
"path": "SubstanceSpecification",
"comment": "Based on ISO 11238",
"alias": [
"SubstanceDefinition (FHIR R5)"
]
},
{
"id": "SubstanceSpecification.identifier",
"path": "SubstanceSpecification.identifier",
"short": "Indentifier for the substance.",
"definition": "Identifier by which this substance is known, specific to NoMA's FHIR API\nUrl (preliminary): http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID \nAlternative (business) identifiers - SMS ID, UniiCode and FEST ID - are provided in the extension. since the identifier attribute can provide at most one identifier.",
"min": 1
},
{
"id": "SubstanceSpecification.identifier.system",
"path": "SubstanceSpecification.identifier.system",
"definition": "The namespace is preliminary and will be replaced with a stable \"GUPRI\"",
"fixedUri": "http://legemiddelverket.no/fhir/SAFEST/SafestSubstanceDefinitionID"
},
{
"id": "SubstanceSpecification.type",
"path": "SubstanceSpecification.type",
"short": "High level categorization, e.g. chemical, polymer or nucleic acid",
"definition": "High level categorization, e.g. chemical, polymer or nucleic acid.",
"alias": [
"category"
],
"binding": {
"strength": "example",
"description": "SPOR RMS Substance Types",
"valueSet": "https://spor.ema.europa.eu/rmswi/#/lists/100000075826/terms"
}
},
{
"id": "SubstanceSpecification.type.coding.system",
"path": "SubstanceSpecification.type.coding.system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.\nThe system URL is preliminary and will be replaced with a stable \"GUPRI\"",
"fixedUri": "https://api.legemiddelverket.no/FHIR-R4/CodeSystem/905de22c-b0f9-4ad5-bfcb-08e1d6fef20d"
},
{
"id": "SubstanceSpecification.status",
"path": "SubstanceSpecification.status",
"max": "0"
},
{
"id": "SubstanceSpecification.domain",
"path": "SubstanceSpecification.domain",
"max": "0"
},
{
"id": "SubstanceSpecification.description",
"path": "SubstanceSpecification.description",
"max": "0"
},
{
"id": "SubstanceSpecification.source",
"path": "SubstanceSpecification.source",
"max": "0"
},
{
"id": "SubstanceSpecification.comment",
"path": "SubstanceSpecification.comment",
"max": "0"
},
{
"id": "SubstanceSpecification.moiety",
"path": "SubstanceSpecification.moiety",
"max": "0"
},
{
"id": "SubstanceSpecification.property",
"path": "SubstanceSpecification.property",
"max": "0"
},
{
"id": "SubstanceSpecification.referenceInformation",
"path": "SubstanceSpecification.referenceInformation",
"max": "0"
},
{
"id": "SubstanceSpecification.structure",
"path": "SubstanceSpecification.structure",
"max": "0"
},
{
"id": "SubstanceSpecification.code",
"path": "SubstanceSpecification.code",
"max": "0"
},
{
"id": "SubstanceSpecification.name",
"path": "SubstanceSpecification.name",
"definition": "Names applicable to this substance.. Provided in Norwegian, English and (if exists) Latin"
},
{
"id": "SubstanceSpecification.name.extension",
"path": "SubstanceSpecification.name.extension",
"alias": [
"alias"
]
},
{
"id": "SubstanceSpecification.name.extension:alias",
"path": "SubstanceSpecification.name.extension",
"sliceName": "alias",
"type": [
{
"code": "Extension",
"profile": [
"https://example.org/fhir/StructureDefinition/SubstanceSpecificationNameAliasNOMA"
]
}
],
"isModifier": false
},
{
"id": "SubstanceSpecification.name.language",
"path": "SubstanceSpecification.name.language",
"definition": "Language of the name. Norwegian, English or (if exists) Latin"
},
{
"id": "SubstanceSpecification.molecularWeight",
"path": "SubstanceSpecification.molecularWeight",
"max": "0"
},
{
"id": "SubstanceSpecification.relationship.relationship",
"path": "SubstanceSpecification.relationship.relationship",
"alias": [
"type"
]
},
{
"id": "SubstanceSpecification.relationship.amount[x]",
"path": "SubstanceSpecification.relationship.amount[x]",
"slicing": {
{
"type": "type",
"path": "$this"
}
],
"rules": "open"
},
"max": "0"
},
{
"id": "SubstanceSpecification.relationship.amount[x]:amountQuantity",
"path": "SubstanceSpecification.relationship.amount[x]",
"sliceName": "amountQuantity",
"max": "0",
"type": [
{
"code": "Quantity"
}
]
},
{
"id": "SubstanceSpecification.relationship.amount[x]:amountRange",
"path": "SubstanceSpecification.relationship.amount[x]",
"sliceName": "amountRange",
"max": "0",
"type": [
{
"code": "Range"
}
]
},
{
"id": "SubstanceSpecification.relationship.amount[x]:amountRatio",
"path": "SubstanceSpecification.relationship.amount[x]",
"sliceName": "amountRatio",
"max": "0",
"type": [
{
"code": "Ratio"
}
]
},
{
"id": "SubstanceSpecification.relationship.amount[x]:amountString",
"path": "SubstanceSpecification.relationship.amount[x]",
"sliceName": "amountString",
"max": "0",
"type": [
{
"code": "string"
}
]
},
{
"id": "SubstanceSpecification.nucleicAcid",
"path": "SubstanceSpecification.nucleicAcid",
"max": "0"
},
{
"id": "SubstanceSpecification.polymer",
"path": "SubstanceSpecification.polymer",
"max": "0"
},
{
"id": "SubstanceSpecification.protein",
"path": "SubstanceSpecification.protein",
"max": "0"
},
{
"id": "SubstanceSpecification.sourceMaterial",
"path": "SubstanceSpecification.sourceMaterial",
"max": "0"
},
{
"id": "SubstanceSpecification.extension",
"path": "SubstanceSpecification.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"ordered": true,
"rules": "open"
},
"min": 1,
"type": [
{
"code": "Extension"
}
],
"mustSupport": false,
"isModifier": false
},
{
"id": "SubstanceSpecification.extension:SMSID",
"path": "SubstanceSpecification.extension",
"sliceName": "SMSID",
"short": "SPOR SMS ID",
"definition": "The substance ID in the [EMA SPOR substances management services](https://spor.ema.europa.eu/smswi/#/). \nIdentifies substnaces in EU marketing authorisations.",
"comment": "URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/SMSID",
"requirements": "Provides ability to map substances between different substance master data systems",
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension"
]
}
],
"meaningWhenMissing": "SPOR does not contain the relevant substance",
"isModifier": false
},
{
"id": "SubstanceSpecification.extension:UniiCode",
"path": "SubstanceSpecification.extension",
"sliceName": "UniiCode",
"short": "GSRS Substance ID",
"definition": "The Unique Ingredient Identifier (UNII) generated by the [Global Substance Registration System (GSRS)](https://gsrs.ncats.nih.gov/) of the US Food and Drug Administration.",
"comment": "URL (preliminary): http://legemiddelverket.no/fhir/SAFEST/UniiCode",
"requirements": "Provides ability to map substances between different susbtance master data systems",
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension"
]
}
],
"meaningWhenMissing": "GSRS does not contain the relevant substance",
"isModifier": false
},
{
"id": "SubstanceSpecification.extension:FestId",
"path": "SubstanceSpecification.extension",
"sliceName": "FestId",
"short": "FEST substance ID",
"definition": "The substance ID in the [FEST medicinal product master data](https://www.dmp.no/om-oss/distribusjon-av-legemiddeldata/fest)",
"comment": "URL (preliminary): http://legemiddelverket.no/FEST/SubstansID",
"min": 1,
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/IdentifierExtension"
]
}
],
"isModifier": false
},
{
"id": "SubstanceSpecification.extension:classification",
"path": "SubstanceSpecification.extension",
"sliceName": "classification",
"short": "Classifies the substance",
"definition": "Optional xtension for classifying substances.",
"comment": "##### Published (optional) classification categories:\n\n###### **E-Number**\nThe substance's [E-number(s)](https://ec.europa.eu/food/food-feed-portal/screen/food-additives/search). A substance can have multiple e-numbers.\nCardinality: 0..* \nCode: The E-number \nDisplay: The E-number name (substance) \nUrl (preliminary): https://simplifier.net/safest/e-number\n###### **Is Therapeutic**\nWhether the substance is therapeutic (only published when \"true\"). \nCardinality: 0..1 \nCode: \"true\" \nDisplay: \"Er terapautisk del\" \nUrl (preliminary): https://simplifier.net/safest/activemoiety\n###### **Is Prodrug**\nWhether the substance is a prodrug (only published when \"true\") \nCardinality: 0..1 \nCode: \"true\" \nDisplay: \"Er prodrug\" \nUrl (preliminary): ttps://simplifier.net/safest/prodrug\n###### **Is Complex**\nWhether the substance is complex (only published when \"true\") \nCardinality: 0..1 \nCode: \"true\" \nDisplay: \"Er kompleks\" \nUrl (preliminary): https://simplifier.net/safest/complex \n###### **ATC codes**\nAll the substance's ATC code(s). Human codes only.\nCardinality: 0..* \nCode: The ATC code \nDisplay: The (substance) 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 |",
"type": [
{
"code": "Extension",
"profile": [
"http://legemiddelverket.no/fhir/StructureDefinition/substancespecification-classification"
]
}
],
"isModifier": false
}
]
}
}