{
"description": "SubstanceDefinition (ePI)",
"_filename": "StructureDefinition-SubstanceDefinition-uv-epi.json",
"package_name": "hl7.fhir.uv.emedicinal-product-info",
"date": "2023-07-26T13:32:34+00:00",
"derivation": "constraint",
"publisher": "HL7 International - Biomedical Research & Regulation Work Group",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "SubstanceDefinitionUvEpi",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "https://www.iso.org/obp/ui/#iso:std:iso:11238",
"name": "IDMP Mapping (Substance)",
"identity": "idmp-substance"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "SubstanceDefinition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "SubstanceDefinition (ePI)",
"package_version": "1.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "SubstanceDefinition",
"min": 0,
"definition": "The detailed description of a substance, typically at a level beyond what is used for prescribing.",
"isModifier": false,
"short": "The detailed description of a substance, typically at a level beyond what is used for prescribing",
"mapping": [ {
"map": "Entity, Role, or Act",
"identity": "rim"
}, {
"map": "administrative.medication",
"identity": "w5"
}, {
"map": "Substance (and derived classes: Chemical, Polymer, Protein, Nucleic_Acid, Structurally_Diverse)",
"identity": "idmp-substance"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition"
},
"isSummary": false
}, {
"path": "SubstanceDefinition.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.implicitRules",
"comment": "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 its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "SubstanceDefinition.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "SubstanceDefinition.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a 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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "SubstanceDefinition.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "SubstanceDefinition.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier",
"min": 1,
"definition": "Identifier by which this substance is known.",
"isModifier": false,
"short": "Identifier by which this substance is known",
"mapping": [ {
"map": "Substance.Substance_Id",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.identifier",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.identifier"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.identifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.identifier.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.identifier.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.identifier.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "Identifies the purpose for this identifier, if known ."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "SubstanceDefinition.identifier.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "SubstanceDefinition.identifier.type",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.system",
"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.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "SubstanceDefinition.identifier.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "SubstanceDefinition.identifier.value",
"condition": [ "ident-1" ],
"comment": "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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). 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.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "SubstanceDefinition.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "SubstanceDefinition.identifier.assigner",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.version",
"min": 0,
"definition": "A business level version identifier of the substance.",
"isModifier": false,
"short": "A business level version identifier of the substance",
"mapping": [ {
"map": "Version.Version_Number",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.version",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.status",
"min": 0,
"definition": "Status of substance within the catalogue e.g. active, retired.",
"isModifier": false,
"short": "draft|active|retired|unknown",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "SubstanceDefinition.status",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.classification",
"min": 0,
"definition": "A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).",
"isModifier": false,
"short": "A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity",
"mapping": [ {
"map": "Substance_Classification.Substance_Classification and Substance_classification.Substance_Classification_Subtype",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.classification",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.classification"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.domain",
"min": 0,
"definition": "If the substance applies to human or veterinary use.",
"isModifier": false,
"short": "If the substance applies to human or veterinary use",
"mapping": [ {
"map": "Substance_Classification.Substance_Classification (and Code and Type) and Substance_Classification.Substance_Classification_Subtype",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medicinal-product-domain"
},
"max": "1",
"id": "SubstanceDefinition.domain",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.domain"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.grade",
"min": 0,
"definition": "The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).",
"isModifier": false,
"short": "The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)",
"mapping": [ {
"map": "Substance_Specified_Substance_Group_3.Grade",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-grade",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceGrade"
} ],
"description": "The quality standard, established benchmark, to which a substance complies"
},
"max": "*",
"id": "SubstanceDefinition.grade",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.grade"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.description",
"min": 0,
"definition": "Textual description of the substance.",
"isModifier": false,
"short": "Textual description of the substance.",
"mapping": [ {
"map": "Substance.Comment",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.description",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.informationSource",
"min": 0,
"definition": "Supporting literature.",
"isModifier": false,
"short": "Supporting literature",
"mapping": [ {
"map": "Substance.Reference_Source",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Citation" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.informationSource",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.informationSource"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.note",
"min": 0,
"definition": "Textual comment about the substance's catalogue or registry record.",
"isModifier": false,
"short": "Textual comment about the substance's catalogue or registry record",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.note",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.note"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.manufacturer",
"min": 0,
"definition": "The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.",
"isModifier": false,
"short": "The entity that creates, makes, produces or fabricates the substance",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/Organization-uv-epi" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.manufacturer",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.manufacturer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.supplier",
"min": 0,
"definition": "An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.",
"isModifier": false,
"short": "An entity that is the source for the substance. It may be different from the manufacturer",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.supplier",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.supplier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety",
"min": 0,
"definition": "Moiety, for structural modifications.",
"isModifier": false,
"short": "Moiety, for structural modifications",
"mapping": [ {
"map": "Substance.Moiety",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.moiety",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.moiety"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.moiety.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.moiety.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.moiety.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.moiety.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.moiety.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.moiety.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.role",
"min": 0,
"definition": "Role that the moiety is playing.",
"isModifier": false,
"short": "Role that the moiety is playing",
"mapping": [ {
"map": "Moiety.Moiety_Role",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.moiety.role",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.role"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.identifier",
"min": 0,
"definition": "Identifier by which this moiety substance is known.",
"isModifier": false,
"short": "Identifier by which this moiety substance is known",
"mapping": [ {
"map": "Moiety.Moiety_Id",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.moiety.identifier",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.name",
"min": 0,
"definition": "Textual name for this moiety substance.",
"isModifier": false,
"short": "Textual name for this moiety substance",
"mapping": [ {
"map": "Moiety.Moiety_Name",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.moiety.name",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.stereochemistry",
"min": 0,
"definition": "Stereochemistry type.",
"isModifier": false,
"short": "Stereochemistry type",
"mapping": [ {
"map": "Moiety.Stereochemistry",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-stereochemistry",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceStereochemistry"
} ],
"description": "The optical rotation type of a substance."
},
"max": "1",
"id": "SubstanceDefinition.moiety.stereochemistry",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.stereochemistry"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.opticalActivity",
"min": 0,
"definition": "Optical activity type.",
"isModifier": false,
"short": "Optical activity type",
"mapping": [ {
"map": "Moiety.Optical_Activity",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-optical-activity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceOpticalActivity"
} ],
"description": "The optical rotation type of a substance."
},
"max": "1",
"id": "SubstanceDefinition.moiety.opticalActivity",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.opticalActivity"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.molecularFormula",
"min": 0,
"definition": "Molecular formula for this moiety of this substance, typically using the Hill system.",
"isModifier": false,
"short": "Molecular formula for this moiety (e.g. with the Hill system)",
"mapping": [ {
"map": "Moiety.Molecular_Formula",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.moiety.molecularFormula",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.molecularFormula"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.amount[x]",
"min": 0,
"definition": "Quantitative value for this moiety.",
"isModifier": false,
"short": "Quantitative value for this moiety",
"mapping": [ {
"map": "Moiety.Amount",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Quantity"
}, {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.moiety.amount[x]",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.amount[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.moiety.measurementType",
"min": 0,
"definition": "The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.",
"isModifier": false,
"short": "The measurement type of the quantitative value",
"mapping": [ {
"map": "Amount.Amount_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-amount-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceAmountType"
} ],
"description": "The relationship between two substance types."
},
"max": "1",
"id": "SubstanceDefinition.moiety.measurementType",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.moiety.measurementType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.characterization",
"min": 0,
"definition": "General specifications for this substance.",
"isModifier": false,
"short": "General specifications for this substance",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.characterization",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.characterization"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.characterization.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.characterization.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.characterization.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.characterization.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.characterization.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.characterization.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.characterization.technique",
"min": 0,
"definition": "The method used to elucidate the characterization of the drug substance. Example: HPLC.",
"isModifier": false,
"short": "The method used to find the characterization e.g. HPLC",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-structure-technique",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceStructureTechnique"
} ],
"description": "The method used to elucidate the characterization of the drug substance."
},
"max": "1",
"id": "SubstanceDefinition.characterization.technique",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.characterization.technique"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.characterization.form",
"min": 0,
"definition": "Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form.",
"isModifier": false,
"short": "Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-form",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceForm"
} ]
},
"max": "1",
"id": "SubstanceDefinition.characterization.form",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.characterization.form"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.characterization.description",
"min": 0,
"definition": "The description or justification in support of the interpretation of the data file.",
"isModifier": false,
"short": "The description or justification in support of the interpretation of the data file",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.characterization.description",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.characterization.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.characterization.file",
"min": 0,
"definition": "The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis.",
"isModifier": false,
"short": "The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.characterization.file",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.characterization.file"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.property",
"min": 0,
"definition": "General specifications for this substance.",
"isModifier": false,
"short": "General specifications for this substance",
"mapping": [ {
"map": "Substance.Property",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.property",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.property"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.property.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.property.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.property.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.property.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.property.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.property.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.property.type",
"min": 1,
"definition": "A code expressing the type of property.",
"isModifier": false,
"short": "A code expressing the type of property",
"mapping": [ {
"map": "Property.Property_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/product-characteristic-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SNOMEDCTCharacteristicCodes"
} ],
"description": "This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set."
},
"max": "1",
"id": "SubstanceDefinition.property.type",
"base": {
"max": "1",
"min": 1,
"path": "SubstanceDefinition.property.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.property.value[x]",
"min": 0,
"definition": "A value for the property.",
"isModifier": false,
"short": "A value for the property",
"mapping": [ {
"map": "Physical Characteristics, attribute's value",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Quantity"
}, {
"code": "date"
}, {
"code": "boolean"
}, {
"code": "Attachment"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.property.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.property.value[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.referenceInformation",
"min": 0,
"definition": "General information detailing this substance.",
"isModifier": false,
"short": "General information detailing this substance",
"mapping": [ {
"map": "Reference_Information",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation" ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.referenceInformation",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.referenceInformation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight",
"min": 0,
"definition": "The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.",
"isModifier": false,
"short": "The average mass of a molecule of a compound",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.molecularWeight",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.molecularWeight"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.molecularWeight.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.molecularWeight.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.molecularWeight.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.molecularWeight.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.molecularWeight.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.method",
"min": 0,
"definition": "The method by which the molecular weight was determined.",
"isModifier": false,
"short": "The method by which the weight was determined",
"mapping": [ {
"map": "Molecular_Weight.Molecular_Weight_Method",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-weight-method",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceWeightMethod"
} ],
"description": "The method by which the substance weight was measured."
},
"max": "1",
"id": "SubstanceDefinition.molecularWeight.method",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.molecularWeight.method"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.type",
"min": 0,
"definition": "Type of molecular weight such as exact, average (also known as. number average), weight average.",
"isModifier": false,
"short": "Type of molecular weight e.g. exact, average, weight average",
"mapping": [ {
"map": "Molecular_Weight.Molecular_Weight_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-weight-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceWeightType"
} ],
"description": "The type of substance weight measurement."
},
"max": "1",
"id": "SubstanceDefinition.molecularWeight.type",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.molecularWeight.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount",
"min": 1,
"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.",
"isModifier": false,
"short": "The molecular weight.",
"mapping": [ {
"map": "Molecular_Weight.Amount",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Quantity"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount",
"base": {
"max": "1",
"min": 1,
"path": "SubstanceDefinition.molecularWeight.amount"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.molecularWeight.amount.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.molecularWeight.amount.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.value",
"requirements": "Precision is handled implicitly in almost all cases of measurement.",
"min": 0,
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"isModifier": false,
"short": "numerical value.",
"mapping": [ {
"map": "SN.2 / CQ - N/A",
"identity": "v2"
}, {
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.value",
"comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.comparator",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.",
"isModifier": true,
"short": "< | <= | >= | > | ad - how to understand the value",
"mapping": [ {
"map": "SN.1 / CQ.1",
"identity": "v2"
}, {
"map": "IVL properties",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "How the Quantity should be understood and represented."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
} ],
"description": "How the Quantity should be understood and represented."
},
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.comparator",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.comparator"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.unit",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 0,
"definition": "A human-readable form of the unit.",
"isModifier": false,
"short": "Unit of measure.",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.unit",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.unit",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.unit"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.system",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 0,
"definition": "The identification of the system that provides the coded form of the unit.",
"isModifier": false,
"short": "System that defines coded unit form",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "CO.codeSystem, PQ.translation.codeSystem",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.system",
"condition": [ "qty-3" ],
"base": {
"max": "1",
"min": 0,
"path": "Quantity.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.molecularWeight.amount.code",
"requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min": 0,
"definition": "A computer processable form of the unit in some unit representation system.",
"isModifier": false,
"short": "coded form of the unit of measure.",
"mapping": [ {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.code, MO.currency, PQ.translation.code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "SubstanceDefinition.molecularWeight.amount.code",
"condition": [ "qty-3" ],
"comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure",
"min": 0,
"definition": "Structural information.",
"isModifier": false,
"short": "Structural information",
"mapping": [ {
"map": "Substance.Structure",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.structure.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.structure.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.structure.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.structure.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.structure.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.structure.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.stereochemistry",
"min": 0,
"definition": "Stereochemistry type.",
"isModifier": false,
"short": "Stereochemistry type",
"mapping": [ {
"map": "Structure.Stereochemistry",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-stereochemistry",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceStereochemistry"
} ],
"description": "The optical rotation type of a substance."
},
"max": "1",
"id": "SubstanceDefinition.structure.stereochemistry",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.stereochemistry"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.opticalActivity",
"min": 0,
"definition": "Optical activity type.",
"isModifier": false,
"short": "Optical activity type",
"mapping": [ {
"map": "Structure.Optical_Activity",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-optical-activity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceOpticalActivity"
} ],
"description": "The optical rotation type of a substance."
},
"max": "1",
"id": "SubstanceDefinition.structure.opticalActivity",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.opticalActivity"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.molecularFormula",
"min": 0,
"definition": "An expression which states the number and type of atoms present in a molecule of a substance.",
"isModifier": false,
"short": "Molecular formula (e.g. using the Hill system).",
"mapping": [ {
"map": "Structure.Molecular_Formula",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure.molecularFormula",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.molecularFormula"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.molecularFormulaByMoiety",
"min": 0,
"definition": "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.",
"isModifier": false,
"short": "Specified per moiety according to the Hill system",
"mapping": [ {
"map": "Structure.Molecular_Formula_By_Moiety",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure.molecularFormulaByMoiety",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.molecularFormulaByMoiety"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.molecularWeight",
"min": 0,
"definition": "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"isModifier": false,
"short": "The molecular weight or weight range",
"mapping": [ {
"map": "Structure.Molecular_Weight",
"identity": "idmp-substance"
} ],
"contentReference": "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.molecularWeight",
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure.molecularWeight",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.molecularWeight"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.technique",
"min": 0,
"definition": "The method used to elucidate the structure of the drug substance. Examples: X-ray, NMR, Peptide mapping, Ligand binding assay.",
"isModifier": false,
"short": "The method used to find the structure e.g. X-ray, NMR",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-structure-technique",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceStructureTechnique"
} ],
"description": "The method used to elucidate the structure of the drug substance."
},
"max": "*",
"id": "SubstanceDefinition.structure.technique",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.structure.technique"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.sourceDocument",
"min": 0,
"definition": "The source of information about the structure.",
"isModifier": false,
"short": "Source of information for the structure",
"mapping": [ {
"map": "Structure.Reference_Source",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.structure.sourceDocument",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.structure.sourceDocument"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.representation",
"min": 0,
"definition": "A depiction of the structure of the substance.",
"isModifier": false,
"short": "A depiction of the structure of the substance",
"mapping": [ {
"map": "Structure.Structural_Representation",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.structure.representation",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.structure.representation"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.structure.representation.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.structure.representation.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.structure.representation.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.structure.representation.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.structure.representation.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.structure.representation.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.representation.type",
"min": 0,
"definition": "The kind of structural representation (e.g. full, partial).",
"isModifier": false,
"short": "The kind of structural representation (e.g. full, partial)",
"mapping": [ {
"map": "Structural_Representation.Structural_Representation_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-representation-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceRepresentationType"
} ],
"description": "A format of a substance representation."
},
"max": "1",
"id": "SubstanceDefinition.structure.representation.type",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.representation.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.representation.representation",
"min": 0,
"definition": "The structural representation as a text string in a standard format.",
"isModifier": false,
"short": "The structural representation as a text string in a standard format",
"mapping": [ {
"map": "Structural_Representation.Structural_Representation",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure.representation.representation",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.representation.representation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.representation.format",
"min": 0,
"definition": "The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.",
"isModifier": false,
"short": "The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-representation-format",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceRepresentationFormat"
} ],
"description": "A format of a substance representation."
},
"max": "1",
"id": "SubstanceDefinition.structure.representation.format",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.representation.format"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.structure.representation.document",
"min": 0,
"definition": "An attached file with the structural representation e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.",
"isModifier": false,
"short": "An attachment with the structural representation e.g. a structure graphic or AnIML file",
"mapping": [ {
"map": "Structural_Representation.Structural_Representation_Attachment",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.structure.representation.document",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.structure.representation.document"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code",
"min": 0,
"definition": "Codes associated with the substance.",
"isModifier": false,
"short": "Codes associated with the substance.",
"mapping": [ {
"map": "Substance.Substance_Code",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.code",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.code"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.code.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.code.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.code.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.code.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.code.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.code.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code.code",
"min": 0,
"definition": "The specific code.",
"isModifier": false,
"short": "The specific code",
"mapping": [ {
"map": "Substance_Code.Code, Substance_Code.Code_System, Substance_Code.Code_System_Id",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/substance"
},
"max": "1",
"id": "SubstanceDefinition.code.code",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.code.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code.status",
"min": 0,
"definition": "Status of the code assignment, for example 'provisional', 'approved'.",
"isModifier": false,
"short": "Status of the code assignment, for example 'provisional', 'approved'",
"mapping": [ {
"map": "Substance_Code.Code_System_Status",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "SubstanceDefinition.code.status",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.code.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code.statusDate",
"min": 0,
"definition": "The date at which the code status was changed as part of the terminology maintenance.",
"isModifier": false,
"short": "The date at which the code status was changed",
"mapping": [ {
"map": "Substance_Code.Code_Change_Date",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.code.statusDate",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.code.statusDate"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code.note",
"min": 0,
"definition": "Any comment can be provided in this field, if necessary.",
"isModifier": false,
"short": "Any comment can be provided in this field",
"mapping": [ {
"map": "Substance_Code.Comment",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.code.note",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.code.note"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.code.source",
"min": 0,
"definition": "Supporting literature.",
"isModifier": false,
"short": "Supporting literature",
"mapping": [ {
"map": "Substance_Code.Reference_Source",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.code.source",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.code.source"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name",
"min": 0,
"definition": "Names applicable to this substance.",
"isModifier": false,
"short": "International Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.",
"mapping": [ {
"map": "Substance.Substance_Name",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.name",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.name.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.name.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.name.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.name.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.name.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.name.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.name",
"min": 1,
"definition": "The actual name.",
"isModifier": false,
"short": "The actual name",
"mapping": [ {
"map": "Substance_Name.Substance_Name",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.name.name",
"base": {
"max": "1",
"min": 1,
"path": "SubstanceDefinition.name.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.type",
"min": 0,
"definition": "Name type, for example 'systematic', 'scientific, 'brand'.",
"isModifier": false,
"short": "Name type e.g. 'scientific, 'brand'",
"mapping": [ {
"map": "Substance_Name.Substance_Name_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-name-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceNameType"
} ],
"description": "The type of a name given to a substance."
},
"max": "1",
"id": "SubstanceDefinition.name.type",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.status",
"min": 0,
"definition": "The status of the name, for example 'current', 'proposed'.",
"isModifier": false,
"short": "The status of the name e.g. 'current', 'proposed'",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "SubstanceDefinition.name.status",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.preferred",
"min": 0,
"definition": "If this is the preferred name for this substance.",
"isModifier": false,
"short": "If this is the preferred name for this substance",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If this value is not present, there is no statement being made about whether this is the preferred name or not. No inference can be made",
"max": "1",
"id": "SubstanceDefinition.name.preferred",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.preferred"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.language",
"min": 0,
"definition": "Human language that the name is written in.",
"isModifier": false,
"short": "Human language that the name is written in",
"mapping": [ {
"map": "Substance_Name.Language",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "*",
"id": "SubstanceDefinition.name.language",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.language"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.domain",
"min": 0,
"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.",
"isModifier": false,
"short": "The use context of this name e.g. as an active ingredient or as a food colour additive",
"mapping": [ {
"map": "Substance_Name.Substance_Name_Domain",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-name-domain",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceNameDomain"
} ],
"description": "The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive."
},
"max": "*",
"id": "SubstanceDefinition.name.domain",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.domain"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.jurisdiction",
"min": 0,
"definition": "The jurisdiction where this name applies.",
"isModifier": false,
"short": "The jurisdiction where this name applies",
"mapping": [ {
"map": "Substance_Name.Jurisdiction",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Jurisdiction codes"
},
"max": "*",
"id": "SubstanceDefinition.name.jurisdiction",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.synonym",
"min": 0,
"definition": "A synonym of this particular name, by which the substance is also known.",
"isModifier": false,
"short": "A synonym of this particular name, by which the substance is also known",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"contentReference": "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.name",
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.name.synonym",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.synonym"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.translation",
"min": 0,
"definition": "A translation for this name into another human language.",
"isModifier": false,
"short": "A translation for this name into another human language",
"mapping": [ {
"map": "n/a",
"identity": "idmp-substance"
} ],
"contentReference": "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.name",
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.name.translation",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.translation"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.official",
"min": 0,
"definition": "Details of the official nature of this name.",
"isModifier": false,
"short": "Details of the official nature of this name",
"mapping": [ {
"map": "Substance_Name.Official_Name",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.name.official",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.official"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.name.official.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.name.official.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.name.official.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.name.official.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.name.official.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.name.official.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.official.authority",
"min": 0,
"definition": "Which authority uses this official name.",
"isModifier": false,
"short": "Which authority uses this official name",
"mapping": [ {
"map": "Official_Name.Official_Name_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-name-authority",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceNameAuthority"
} ],
"description": "An authority that officates substance names."
},
"max": "1",
"id": "SubstanceDefinition.name.official.authority",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.official.authority"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.official.status",
"min": 0,
"definition": "The status of the official name, for example 'draft', 'active', 'retired'.",
"isModifier": false,
"short": "The status of the official name, for example 'draft', 'active'",
"mapping": [ {
"map": "Official_Name.Official_Name_Status",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "SubstanceDefinition.name.official.status",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.official.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.official.date",
"min": 0,
"definition": "Date of the official name change.",
"isModifier": false,
"short": "Date of official name change",
"mapping": [ {
"map": "Official_Name.Official_Name_Status_Change_Date",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.name.official.date",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.name.official.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.name.source",
"min": 0,
"definition": "Supporting literature.",
"isModifier": false,
"short": "Supporting literature",
"mapping": [ {
"map": "Substance_Name.Reference_Source",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.name.source",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.name.source"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship",
"min": 0,
"definition": "A link between this substance and another, with details of the relationship.",
"isModifier": false,
"short": "A link between this substance and another",
"mapping": [ {
"map": "Substance.Reference_Information.Relationship",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.relationship",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.relationship"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.relationship.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.relationship.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.relationship.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.relationship.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.relationship.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.relationship.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.substanceDefinition[x]",
"min": 0,
"definition": "A pointer to another substance, as a resource or just a representational code.",
"isModifier": false,
"short": "A pointer to another substance, as a resource or a representational code",
"mapping": [ {
"map": "Substance_Relationship.Related_Substance_Id",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition" ]
}, {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.relationship.substanceDefinition[x]",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.relationship.substanceDefinition[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.type",
"min": 1,
"definition": "For example \"salt to parent\", \"active moiety\", \"starting material\", \"polymorph\", \"impurity of\".",
"isModifier": false,
"short": "For example \"salt to parent\", \"active moiety\"",
"mapping": [ {
"map": "Substance_Relationship.Relationship_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-relationship-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceRelationshipType"
} ],
"description": "The relationship between two substance types."
},
"max": "1",
"id": "SubstanceDefinition.relationship.type",
"base": {
"max": "1",
"min": 1,
"path": "SubstanceDefinition.relationship.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.isDefining",
"min": 0,
"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.",
"isModifier": false,
"short": "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships",
"mapping": [ {
"map": "Substance_Relationship.Is_Defining",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If this value is not present, there is no statement being made about whether this is a defining relationship or not. No inference can be made",
"max": "1",
"id": "SubstanceDefinition.relationship.isDefining",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.relationship.isDefining"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.amount[x]",
"min": 0,
"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.",
"isModifier": false,
"short": "A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other",
"mapping": [ {
"map": "Substance_Relationship.Amount.Quantity",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Quantity"
}, {
"code": "Ratio"
}, {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.relationship.amount[x]",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.relationship.amount[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.ratioHighLimitAmount",
"min": 0,
"definition": "For use when the numeric has an uncertain range.",
"isModifier": false,
"short": "For use when the numeric has an uncertain range",
"mapping": [ {
"map": "Substance_Relationship.Amount.Quantity.High_Limit",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Ratio"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.relationship.ratioHighLimitAmount",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.relationship.ratioHighLimitAmount"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.comparator",
"min": 0,
"definition": "An operator for the amount, for example \"average\", \"approximately\", \"less than\".",
"isModifier": false,
"short": "An operator for the amount, for example \"average\", \"approximately\", \"less than\"",
"mapping": [ {
"map": "Substance_Relationship.Amount_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-amount-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SubstanceAmountType"
} ],
"description": "The relationship between two substance types."
},
"max": "1",
"id": "SubstanceDefinition.relationship.comparator",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.relationship.comparator"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.relationship.source",
"min": 0,
"definition": "Supporting literature.",
"isModifier": false,
"short": "Supporting literature",
"mapping": [ {
"map": "Substance_Relationship.Reference_Source",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"max": "*",
"id": "SubstanceDefinition.relationship.source",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.relationship.source"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.nucleicAcid",
"min": 0,
"definition": "Data items specific to nucleic acids.",
"isModifier": false,
"short": "Data items specific to nucleic acids",
"mapping": [ {
"map": "(used to add specifics of Nucleic Acids to Substances)",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid" ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.nucleicAcid",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.nucleicAcid"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.polymer",
"min": 0,
"definition": "Data items specific to polymers.",
"isModifier": false,
"short": "Data items specific to polymers",
"mapping": [ {
"map": "(used to add specifics of Polymers to Substances)",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubstancePolymer" ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.polymer",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.polymer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.protein",
"min": 0,
"definition": "Data items specific to proteins.",
"isModifier": false,
"short": "Data items specific to proteins",
"mapping": [ {
"map": "(used to add specifics of Proteins to Substances)",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/SubstanceProtein" ]
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.protein",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.protein"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial",
"min": 0,
"definition": "Material or taxonomic/anatomical source for the substance.",
"isModifier": false,
"short": "Material or taxonomic/anatomical source",
"mapping": [ {
"map": "Substance.Source_Material",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "SubstanceDefinition.sourceMaterial",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial"
},
"isSummary": true
}, {
"path": "SubstanceDefinition.sourceMaterial.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "SubstanceDefinition.sourceMaterial.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.sourceMaterial.extension",
"min": 0,
"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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "SubstanceDefinition.sourceMaterial.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "SubstanceDefinition.sourceMaterial.modifierExtension",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "SubstanceDefinition.sourceMaterial.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial.type",
"min": 0,
"definition": "A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.",
"isModifier": false,
"short": "Classification of the origin of the raw material. e.g. cat hair is an Animal source type",
"mapping": [ {
"map": "Source_Material.Source_Material_Type",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-source-material-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SourceMaterialType"
} ],
"description": "A classification that provides the origin of the substance raw material."
},
"max": "1",
"id": "SubstanceDefinition.sourceMaterial.type",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial.genus",
"min": 0,
"definition": "The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.",
"isModifier": false,
"short": "The genus of an organism e.g. the Latin epithet of the plant/animal scientific name",
"mapping": [ {
"map": "Source_Material.Organism.Genus",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-source-material-genus",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SourceMaterialGenus"
} ],
"description": "The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name."
},
"max": "1",
"id": "SubstanceDefinition.sourceMaterial.genus",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial.genus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial.species",
"min": 0,
"definition": "The species of an organism, typically referring to the Latin epithet of the species of the plant/animal.",
"isModifier": false,
"short": "The species of an organism e.g. the Latin epithet of the species of the plant/animal",
"mapping": [ {
"map": "Source_Material.Organism.Species",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-source-material-species",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SourceMaterialSpecies"
} ],
"description": "A species of origin a substance raw material."
},
"max": "1",
"id": "SubstanceDefinition.sourceMaterial.species",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial.species"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial.part",
"min": 0,
"definition": "An anatomical origin of the source material within an organism.",
"isModifier": false,
"short": "An anatomical origin of the source material within an organism",
"mapping": [ {
"map": "Source_Material.Part_Description.Part",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/substance-source-material-part",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SourceMaterialPart"
} ],
"description": "An anatomical origin of the source material within an organism."
},
"max": "1",
"id": "SubstanceDefinition.sourceMaterial.part",
"base": {
"max": "1",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial.part"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "SubstanceDefinition.sourceMaterial.countryOfOrigin",
"min": 0,
"definition": "The country or countries where the material is harvested.",
"isModifier": false,
"short": "The country or countries where the material is harvested",
"mapping": [ {
"map": "Source_Material.Country_Of_Origin",
"identity": "idmp-substance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/country|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Country"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Jurisdiction codes"
},
"max": "*",
"id": "SubstanceDefinition.sourceMaterial.countryOfOrigin",
"base": {
"max": "*",
"min": 0,
"path": "SubstanceDefinition.sourceMaterial.countryOfOrigin"
},
"isSummary": true
} ]
},
"status": "active",
"id": "ba48e412-c874-474e-9f4e-1f7060d83c53",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/SubstanceDefinition-uv-epi",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "SubstanceDefinition",
"path": "SubstanceDefinition"
}, {
"id": "SubstanceDefinition.identifier",
"min": 1,
"path": "SubstanceDefinition.identifier"
}, {
"id": "SubstanceDefinition.identifier.system",
"min": 1,
"path": "SubstanceDefinition.identifier.system"
}, {
"id": "SubstanceDefinition.identifier.value",
"min": 1,
"path": "SubstanceDefinition.identifier.value"
}, {
"id": "SubstanceDefinition.status",
"path": "SubstanceDefinition.status",
"short": "draft|active|retired|unknown"
}, {
"id": "SubstanceDefinition.domain",
"path": "SubstanceDefinition.domain",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medicinal-product-domain"
}
}, {
"id": "SubstanceDefinition.description",
"path": "SubstanceDefinition.description",
"short": "Textual description of the substance."
}, {
"id": "SubstanceDefinition.manufacturer",
"path": "SubstanceDefinition.manufacturer",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/Organization-uv-epi" ]
} ]
}, {
"id": "SubstanceDefinition.molecularWeight.amount",
"path": "SubstanceDefinition.molecularWeight.amount",
"short": "The molecular weight."
}, {
"id": "SubstanceDefinition.molecularWeight.amount.value",
"path": "SubstanceDefinition.molecularWeight.amount.value",
"short": "numerical value."
}, {
"id": "SubstanceDefinition.molecularWeight.amount.unit",
"path": "SubstanceDefinition.molecularWeight.amount.unit",
"short": "Unit of measure."
}, {
"id": "SubstanceDefinition.molecularWeight.amount.code",
"path": "SubstanceDefinition.molecularWeight.amount.code",
"short": "coded form of the unit of measure."
}, {
"id": "SubstanceDefinition.structure.molecularFormula",
"path": "SubstanceDefinition.structure.molecularFormula",
"short": "Molecular formula (e.g. using the Hill system)."
}, {
"id": "SubstanceDefinition.code",
"path": "SubstanceDefinition.code",
"short": "Codes associated with the substance."
}, {
"id": "SubstanceDefinition.code.code",
"path": "SubstanceDefinition.code.code",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/substance"
}
}, {
"id": "SubstanceDefinition.name",
"path": "SubstanceDefinition.name",
"short": "International Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable."
}, {
"id": "SubstanceDefinition.name.type",
"path": "SubstanceDefinition.name.type",
"short": "Name type e.g. 'scientific, 'brand'"
} ]
},
"contact": [ {
"name": "HL7 International - Biomedical Research & Regulation Work Group",
"telecom": [ {
"value": "http://hl7.org/Special/committees/rcrim",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/SubstanceDefinition"
}