R4 Ballot #2 (Mixed Normative/Trial use)
AdministrationThis page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Orders and Observations Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for substance
{
"resourceType" : "StructureDefinition",
"id" : "Substance",
"meta" : {
"lastUpdated" : "2018-08-19T21:48:56.559+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Trial Use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Substance",
"name" : "Substance",
"status" : "draft",
"date" : "2018-08-19T21:48:56+10:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A homogeneous material with a definite composition.",
"fhirVersion" : "3.5.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "orim",
"uri" : "http://hl7.org/orim",
"name" : "Ontological RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Substance",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Substance",
"path" : "Substance",
"short" : "A homogeneous material with a definite composition",
"definition" : "A homogeneous material with a definite composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"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 guman 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."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Material"
},
{
"identity" : "orim",
"map" : "fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\\#MAT ]."
}]
},
{
"id" : "Substance.id",
"path" : "Substance.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Substance.meta",
"path" : "Substance.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Substance.implicitRules",
"path" : "Substance.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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 it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Substance.language",
"path" : "Substance.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Substance.text",
"path" : "Substance.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Substance.contained",
"path" : "Substance.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"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.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.extension",
"path" : "Substance.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.modifierExtension",
"path" : "Substance.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.identifier",
"path" : "Substance.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the substance.",
"comment" : "This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.status",
"path" : "Substance.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the substance is actively used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRSubstanceStatus"
}],
"strength" : "required",
"description" : "A code to indicate if the substance is actively used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-status"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Substance.category",
"path" : "Substance.category",
"short" : "What class/type of substance this is",
"definition" : "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.",
"comment" : "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCategory"
}],
"strength" : "extensible",
"description" : "Category or classification of substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Substance.code",
"path" : "Substance.code",
"short" : "What substance this is",
"definition" : "A code (or set of codes) that identify this substance.",
"comment" : "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Substance.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Substance codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "orim",
"map" : "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"
}]
},
{
"id" : "Substance.description",
"path" : "Substance.description",
"short" : "Textual description of the substance, comments",
"definition" : "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.desc"
}]
},
{
"id" : "Substance.instance",
"path" : "Substance.instance",
"short" : "If this describes a specific package/container of the substance",
"definition" : "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.instance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "If this element is not present, then the substance resource describes a kind of substance",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.determinerCode"
}]
},
{
"id" : "Substance.instance.id",
"path" : "Substance.instance.id",
"representation" : ["xmlAttr"],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.instance.extension",
"path" : "Substance.instance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.instance.modifierExtension",
"path" : "Substance.instance.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.instance.identifier",
"path" : "Substance.instance.identifier",
"short" : "Identifier of the package/container",
"definition" : "Identifier associated with the package/container (usually a label affixed directly).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.instance.expiry",
"path" : "Substance.instance.expiry",
"short" : "When no longer valid to use",
"definition" : "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.expiry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".expiryTime"
}]
},
{
"id" : "Substance.instance.quantity",
"path" : "Substance.instance.quantity",
"short" : "Amount of substance in the package",
"definition" : "The amount of the substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.quantity"
}]
},
{
"id" : "Substance.ingredient",
"path" : "Substance.ingredient",
"short" : "Composition information about the substance",
"definition" : "A substance can be composed of other substances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopesRole[classCode=INGR]"
}]
},
{
"id" : "Substance.ingredient.id",
"path" : "Substance.ingredient.id",
"representation" : ["xmlAttr"],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.ingredient.extension",
"path" : "Substance.ingredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.ingredient.modifierExtension",
"path" : "Substance.ingredient.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.ingredient.quantity",
"path" : "Substance.ingredient.quantity",
"short" : "Optional amount (concentration)",
"definition" : "The amount of the ingredient in the substance - a concentration ratio.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.ingredient.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Substance.ingredient.substance[x]",
"path" : "Substance.ingredient.substance[x]",
"short" : "A component of the substance",
"definition" : "Another substance that is a component of this substance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Substance.ingredient.substance[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceIngredient"
}],
"strength" : "example",
"description" : "Substance Ingredient codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Substance",
"path" : "Substance",
"short" : "A homogeneous material with a definite composition",
"definition" : "A homogeneous material with a definite composition.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Material"
},
{
"identity" : "orim",
"map" : "fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\\#MAT ]."
}]
},
{
"id" : "Substance.identifier",
"path" : "Substance.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the substance.",
"comment" : "This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.status",
"path" : "Substance.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the substance is actively used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRSubstanceStatus"
}],
"strength" : "required",
"description" : "A code to indicate if the substance is actively used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-status"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Substance.category",
"path" : "Substance.category",
"short" : "What class/type of substance this is",
"definition" : "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.",
"comment" : "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCategory"
}],
"strength" : "extensible",
"description" : "Category or classification of substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Substance.code",
"path" : "Substance.code",
"short" : "What substance this is",
"definition" : "A code (or set of codes) that identify this substance.",
"comment" : "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Substance codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "orim",
"map" : "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"
}]
},
{
"id" : "Substance.description",
"path" : "Substance.description",
"short" : "Textual description of the substance, comments",
"definition" : "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.desc"
}]
},
{
"id" : "Substance.instance",
"path" : "Substance.instance",
"short" : "If this describes a specific package/container of the substance",
"definition" : "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "If this element is not present, then the substance resource describes a kind of substance",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.determinerCode"
}]
},
{
"id" : "Substance.instance.identifier",
"path" : "Substance.instance.identifier",
"short" : "Identifier of the package/container",
"definition" : "Identifier associated with the package/container (usually a label affixed directly).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.instance.expiry",
"path" : "Substance.instance.expiry",
"short" : "When no longer valid to use",
"definition" : "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".expiryTime"
}]
},
{
"id" : "Substance.instance.quantity",
"path" : "Substance.instance.quantity",
"short" : "Amount of substance in the package",
"definition" : "The amount of the substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.quantity"
}]
},
{
"id" : "Substance.ingredient",
"path" : "Substance.ingredient",
"short" : "Composition information about the substance",
"definition" : "A substance can be composed of other substances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopesRole[classCode=INGR]"
}]
},
{
"id" : "Substance.ingredient.quantity",
"path" : "Substance.ingredient.quantity",
"short" : "Optional amount (concentration)",
"definition" : "The amount of the ingredient in the substance - a concentration ratio.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Substance.ingredient.substance[x]",
"path" : "Substance.ingredient.substance[x]",
"short" : "A component of the substance",
"definition" : "Another substance that is a component of this substance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceIngredient"
}],
"strength" : "example",
"description" : "Substance Ingredient codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot #2 (v3.5.0-14907) generated on Sun, Aug 19, 2018 21:54+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
Ballot Comparison |
|
Propose a change