This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
{
"resourceType" : "StructureDefinition",
"id" : "daf-substance",
"url" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-substance",
"name" : "Profile daf-substance",
"status" : "draft",
"publisher" : "Health Level Seven International (Infrastructure and Messaging - Data Access Framework)",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://www.healthit.gov"
}
}
}
},
"date" : "2015-03-17",
"mapping" : [
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"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/w5",
"name" : "W5 Mapping"
}
},
"kind" : "resource",
"abstract" : false,
"type" : "Substance",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Substance",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Substance:dafsubstance",
"path" : "Substance",
"name" : "DAFSubstance",
"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)"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)"
},
{
"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))"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
},
"mustSupport" : 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 ]."
},
{
"identity" : "w5",
"map" : "administrative.entity"
},
{
"identity" : "servd",
"map" : "Organization"
}
}
},
{
"id" : "Substance:dafsubstance.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.",
"comments" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "id"
}
},
"isSummary" : true
},
{
"id" : "Substance:dafsubstance.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 may not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Meta"
}
},
"isSummary" : true
},
{
"id" : "Substance:dafsubstance.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.",
"comments" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
},
"isModifier" : true,
"isSummary" : true
},
{
"id" : "Substance:dafsubstance.language",
"path" : "Substance.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comments" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
},
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
}
},
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "Substance:dafsubstance.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 may 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.",
"comments" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
},
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Narrative"
}
},
"condition" : [
"dom-1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
}
},
{
"id" : "Substance:dafsubstance.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.",
"comments" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
}
},
{
"id" : "Substance:dafsubstance.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. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
}
},
{
"id" : "Substance:dafsubstance.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. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
}
},
{
"id" : "Substance:dafsubstance.identifier",
"path" : "Substance.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the substance.",
"comments" : "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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "w5",
"map" : "id"
}
}
},
{
"id" : "Substance:dafsubstance.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.",
"comments" : "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"
}
},
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"description" : "Category or classification of substance",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/substance-category"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "w5",
"map" : "class"
}
}
},
{
"id" : "Substance:dafsubstance.code",
"path" : "Substance.code",
"short" : "What substance this is",
"definition" : "A code (or set of codes) that identify this substance.",
"comments" : "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"
}
},
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "example",
"description" : "Substance codes",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/substance-code"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "orim",
"map" : "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"
},
{
"identity" : "w5",
"map" : "what"
},
{
"identity" : "servd",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".player.desc"
}
}
},
{
"id" : "Substance:dafsubstance.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",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".player.determinerCode"
}
}
},
{
"id" : "Substance:dafsubstance.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" : "*"
},
"type" : [
{
"code" : "string"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.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. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.instance.modifierExtension",
"path" : "Substance.instance.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content",
"modifiers"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".expiryTime"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".player.quantity"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".player.scopesRole[classCode=INGR]"
}
}
},
{
"id" : "Substance:dafsubstance.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" : "*"
},
"type" : [
{
"code" : "string"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.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. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.ingredient.modifierExtension",
"path" : "Substance.ingredient.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content",
"modifiers"
},
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
},
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
}
},
{
"id" : "Substance:dafsubstance.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"
}
},
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".quantity"
}
}
},
{
"id" : "Substance:dafsubstance.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",
"profile" : "http://hl7.org/fhir/StructureDefinition/Substance"
}
},
"isSummary" : true,
"binding" : {
"strength" : "example",
"description" : "Substance Ingredient codes",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/substance-code"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".player"
}
}
}
}
},
"differential" : {
"element" : [
{
"id" : "Substance:dafsubstance",
"path" : "Substance",
"name" : "DAFSubstance",
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "servd",
"map" : "Organization"
}
}
},
{
"id" : "Substance:dafsubstance.code",
"path" : "Substance.code",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "servd",
"map" : "n/a"
}
}
},
{
"id" : "Substance:dafsubstance.description",
"path" : "Substance.description",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
}
}
}
}
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change