R4 Ballot #2 (Mixed Normative/Trial use)
WorkflowThis 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: Patient, Practitioner |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for supplydelivery
{
"resourceType" : "StructureDefinition",
"id" : "SupplyDelivery",
"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" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Trial Use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"name" : "SupplyDelivery",
"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" : "Record of delivery of what is supplied.",
"fhirVersion" : "3.5.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SupplyDelivery",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SupplyDelivery",
"path" : "SupplyDelivery",
"short" : "Delivery of bulk Supplies",
"definition" : "Record of delivery of what is supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery",
"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" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=RQO]"
}]
},
{
"id" : "SupplyDelivery.id",
"path" : "SupplyDelivery.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" : "SupplyDelivery.meta",
"path" : "SupplyDelivery.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" : "SupplyDelivery.implicitRules",
"path" : "SupplyDelivery.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" : "SupplyDelivery.language",
"path" : "SupplyDelivery.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" : "SupplyDelivery.text",
"path" : "SupplyDelivery.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" : "SupplyDelivery.contained",
"path" : "SupplyDelivery.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" : "SupplyDelivery.extension",
"path" : "SupplyDelivery.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" : "SupplyDelivery.modifierExtension",
"path" : "SupplyDelivery.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" : "SupplyDelivery.identifier",
"path" : "SupplyDelivery.identifier",
"short" : "External identifier",
"definition" : "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.",
"comment" : "This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "SupplyDelivery.basedOn",
"path" : "SupplyDelivery.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyRequest"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "SupplyDelivery.partOf",
"path" : "SupplyDelivery.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "Not to be used to link an event to an Encounter - use Event.context for that.\r\r[The allowed reference resources may be adjusted as appropriate for the event resource].",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"http://hl7.org/fhir/StructureDefinition/Contract"]
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "SupplyDelivery.status",
"path" : "SupplyDelivery.status",
"short" : "in-progress | completed | abandoned | entered-in-error",
"definition" : "A code specifying the state of the dispense event.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.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" : "SupplyDeliveryStatus"
}],
"strength" : "required",
"description" : "Status of the supply delivery.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "rim",
"map" : ".statusCode, also existence of fulfillment events"
}]
},
{
"id" : "SupplyDelivery.patient",
"path" : "SupplyDelivery.patient",
"short" : "Patient for whom the item is supplied",
"definition" : "A link to a resource representing the person whom the delivered item is for.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.patient",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "SupplyDelivery.type",
"path" : "SupplyDelivery.type",
"short" : "Category of dispense event",
"definition" : "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryType"
}],
"strength" : "required",
"description" : "The type of supply dispense.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyDelivery.suppliedItem",
"path" : "SupplyDelivery.suppliedItem",
"short" : "The item that is delivered or supplied",
"definition" : "The item that is being delivered or has been supplied.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem",
"min" : 0,
"max" : "1"
},
"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" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.id",
"path" : "SupplyDelivery.suppliedItem.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" : "SupplyDelivery.suppliedItem.extension",
"path" : "SupplyDelivery.suppliedItem.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" : "SupplyDelivery.suppliedItem.modifierExtension",
"path" : "SupplyDelivery.suppliedItem.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" : "SupplyDelivery.suppliedItem.quantity",
"path" : "SupplyDelivery.suppliedItem.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of supply that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.item[x]",
"path" : "SupplyDelivery.suppliedItem.item[x]",
"short" : "Medication, Substance, or Device supplied",
"definition" : "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem.item[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryItem"
}],
"strength" : "example",
"description" : "The item that was delivered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.occurrence[x]",
"path" : "SupplyDelivery.occurrence[x]",
"short" : "When event occurred",
"definition" : "The date or time(s) the activity occurred.",
"comment" : "[The list of types may be constrained as appropriate for the type of event].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyDelivery.supplier",
"path" : "SupplyDelivery.supplier",
"short" : "Dispenser",
"definition" : "The individual responsible for dispensing the medication, supplier or device.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.supplier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "SupplyDelivery.destination",
"path" : "SupplyDelivery.destination",
"short" : "Where the Supply was sent",
"definition" : "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.destination",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
}]
},
{
"id" : "SupplyDelivery.receiver",
"path" : "SupplyDelivery.receiver",
"short" : "Who collected the Supply",
"definition" : "Identifies the person who picked up the Supply.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.receiver",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
}]
}]
},
"differential" : {
"element" : [{
"id" : "SupplyDelivery",
"path" : "SupplyDelivery",
"short" : "Delivery of bulk Supplies",
"definition" : "Record of delivery of what is supplied.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=RQO]"
}]
},
{
"id" : "SupplyDelivery.identifier",
"path" : "SupplyDelivery.identifier",
"short" : "External identifier",
"definition" : "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.",
"comment" : "This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "SupplyDelivery.basedOn",
"path" : "SupplyDelivery.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "SupplyDelivery.partOf",
"path" : "SupplyDelivery.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "Not to be used to link an event to an Encounter - use Event.context for that.\r\r[The allowed reference resources may be adjusted as appropriate for the event resource].",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"http://hl7.org/fhir/StructureDefinition/Contract"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "SupplyDelivery.status",
"path" : "SupplyDelivery.status",
"short" : "in-progress | completed | abandoned | entered-in-error",
"definition" : "A code specifying the state of the dispense event.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"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" : "SupplyDeliveryStatus"
}],
"strength" : "required",
"description" : "Status of the supply delivery.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "rim",
"map" : ".statusCode, also existence of fulfillment events"
}]
},
{
"id" : "SupplyDelivery.patient",
"path" : "SupplyDelivery.patient",
"short" : "Patient for whom the item is supplied",
"definition" : "A link to a resource representing the person whom the delivered item is for.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "SupplyDelivery.type",
"path" : "SupplyDelivery.type",
"short" : "Category of dispense event",
"definition" : "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryType"
}],
"strength" : "required",
"description" : "The type of supply dispense.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyDelivery.suppliedItem",
"path" : "SupplyDelivery.suppliedItem",
"short" : "The item that is delivered or supplied",
"definition" : "The item that is being delivered or has been supplied.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.quantity",
"path" : "SupplyDelivery.suppliedItem.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of supply that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.item[x]",
"path" : "SupplyDelivery.suppliedItem.item[x]",
"short" : "Medication, Substance, or Device supplied",
"definition" : "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryItem"
}],
"strength" : "example",
"description" : "The item that was delivered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.occurrence[x]",
"path" : "SupplyDelivery.occurrence[x]",
"short" : "When event occurred",
"definition" : "The date or time(s) the activity occurred.",
"comment" : "[The list of types may be constrained as appropriate for the type of event].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyDelivery.supplier",
"path" : "SupplyDelivery.supplier",
"short" : "Dispenser",
"definition" : "The individual responsible for dispensing the medication, supplier or device.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "SupplyDelivery.destination",
"path" : "SupplyDelivery.destination",
"short" : "Where the Supply was sent",
"definition" : "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
}]
},
{
"id" : "SupplyDelivery.receiver",
"path" : "SupplyDelivery.receiver",
"short" : "Who collected the Supply",
"definition" : "Identifies the person who picked up the Supply.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
}]
}]
}
}
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