{ "resourceType": "StructureDefinition", "base": "http://hl7.org/fhir/StructureDefinition/DomainResource", "id": "spark94", "meta": { "versionId": "spark94", "lastUpdated": "2015-10-02T11:56:12.705+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"SupplyRequestΣDomainResourceRequest for a medication, substance or device
\".\"\".\"\".\"patientΣ0..1Reference(\n Patient)\n Patient for whom the item is supplied
\".\"\".\"\".\"sourceΣ0..1Reference(\n Practitioner | \n Organization | \n Patient)\n Who initiated this order
\".\"\".\"\".\"dateΣ0..1dateTimeWhen the request was made
\".\"\".\"\".\"identifierΣ0..1IdentifierUnique identifier
\".\"\".\"\".\"status?! Σ0..1coderequested | completed | failed | cancelled\n
SupplyRequestStatus (\n Required)\n
\".\"\".\"\".\"kindΣ0..1CodeableConceptThe kind of supply (central, non-stock, etc.)\n
Supply Type (\n Required)\n
\".\"\".\"\".\"orderedItemΣ0..1Reference(\n Medication | \n Substance | \n Device)\n Medication, Substance, or Device requested to be supplied
\".\"\".\"\".\"supplierΣ0..*Reference(\n Organization)\n Who is intended to fulfill the request
\".\"\".\"\".\"reason[x]Σ0..1Why the supply item was requested\n
SupplyRequestReason (\n Example)\n
\".\"\".\"\".\"\".\"reasonCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" reasonReference\n Reference(\n Any)\n
\".\"\".\"\".\"whenΣ0..1BackboneElementWhen the request should be fulfilled
\".\"\".\"\".\"\".\"codeΣ0..1CodeableConceptFulfilment code\n
Supply Request When (\n Example)\n
\".\"\".\"\".\"\".\"scheduleΣ0..1TimingFormal fulfillment schedule

\"doco\" Documentation for this format\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 } ], "url": "http://hl7.org/fhir/StructureDefinition/SupplyRequest", "name": "SupplyRequest", "status": "draft", "date": "2015-09-22T03:47:23+00:00", "publisher": "Health Level Seven International (Orders and Observations)", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "other", "value": "http://www.hl7.org/Special/committees/orders/index.cfm" } ] } ], "description": "Base StructureDefinition for SupplyRequest Resource", "fhirVersion": "1.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "snapshot": { "element": [ { "path": "SupplyRequest", "short": "Request for a medication, substance or device", "definition": "A record of a request for a medication, substance or device used in the healthcare setting.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Supply[moodCode=RQO]" }, { "identity": "w5", "map": "workflow.order" } ] }, { "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. Bundles always have an id, though it is usually a generated UUID.", "path": "SupplyRequest.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.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true }, { "path": "SupplyRequest.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", "type": [ { "code": "Meta" } ], "isSummary": true }, { "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.", "path": "SupplyRequest.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.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "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).", "path": "SupplyRequest.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "path": "SupplyRequest.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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "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.", "path": "SupplyRequest.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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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.", "path": "SupplyRequest.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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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.", "path": "SupplyRequest.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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "SupplyRequest.patient", "short": "Patient for whom the item is supplied", "definition": "A link to a resource representing the person whom the ordered item is for.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "path": "SupplyRequest.source", "short": "Who initiated this order", "definition": "The Practitioner , Organization or Patient who initiated this order for the supply.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true }, { "path": "SupplyRequest.date", "short": "When the request was made", "definition": "When the request was made.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true }, { "comments": "This is assigned by the orderer, and used to refer to this order in other external standards.", "path": "SupplyRequest.identifier", "short": "Unique identifier", "definition": "Unique identifier for this supply request.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" } ] }, { "path": "SupplyRequest.status", "short": "requested | completed | failed | cancelled", "definition": "Status of the supply request.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Status of the supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode, also existence of fulfillment events" } ] }, { "path": "SupplyRequest.kind", "short": "The kind of supply (central, non-stock, etc.)", "definition": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "required", "description": "Category of supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-kind" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] }, { "comments": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.", "path": "SupplyRequest.orderedItem", "short": "Medication, Substance, or Device requested to be supplied", "definition": "The item that is requested to be supplied.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Substance" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRD].role" } ] }, { "path": "SupplyRequest.supplier", "short": "Who is intended to fulfill the request", "definition": "Who is intended to fulfill the request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "SupplyRequest.reason[x]", "short": "Why the supply item was requested", "definition": "Why the supply item was requested.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "binding": { "strength": "example", "description": "Why the supply item was requested", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-reason" } } }, { "path": "SupplyRequest.when", "short": "When the request should be fulfilled", "definition": "When the request should be fulfilled.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "isSummary": true }, { "path": "SupplyRequest.when.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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.", "path": "SupplyRequest.when.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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "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.", "path": "SupplyRequest.when.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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "Code may simply be a priority code.", "path": "SupplyRequest.when.code", "short": "Fulfilment code", "definition": "Code indicating when the request should be fulfilled.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "When the request should be fulfilled", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-when" } } }, { "path": "SupplyRequest.when.schedule", "short": "Formal fulfillment schedule", "definition": "Formal fulfillment schedule.", "min": 0, "max": "1", "type": [ { "code": "Timing" } ], "isSummary": true } ] }, "differential": { "element": [ { "path": "SupplyRequest", "short": "Request for a medication, substance or device", "definition": "A record of a request for a medication, substance or device used in the healthcare setting.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "Supply[moodCode=RQO]" }, { "identity": "w5", "map": "workflow.order" } ] }, { "path": "SupplyRequest.patient", "short": "Patient for whom the item is supplied", "definition": "A link to a resource representing the person whom the ordered item is for.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "path": "SupplyRequest.source", "short": "Who initiated this order", "definition": "The Practitioner , Organization or Patient who initiated this order for the supply.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true }, { "path": "SupplyRequest.date", "short": "When the request was made", "definition": "When the request was made.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true }, { "comments": "This is assigned by the orderer, and used to refer to this order in other external standards.", "path": "SupplyRequest.identifier", "short": "Unique identifier", "definition": "Unique identifier for this supply request.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id" } ] }, { "path": "SupplyRequest.status", "short": "requested | completed | failed | cancelled", "definition": "Status of the supply request.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Status of the supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode, also existence of fulfillment events" } ] }, { "path": "SupplyRequest.kind", "short": "The kind of supply (central, non-stock, etc.)", "definition": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "required", "description": "Category of supply request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-kind" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] }, { "comments": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.", "path": "SupplyRequest.orderedItem", "short": "Medication, Substance, or Device requested to be supplied", "definition": "The item that is requested to be supplied.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Medication" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Substance" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=PRD].role" } ] }, { "path": "SupplyRequest.supplier", "short": "Who is intended to fulfill the request", "definition": "Who is intended to fulfill the request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true }, { "path": "SupplyRequest.reason[x]", "short": "Why the supply item was requested", "definition": "Why the supply item was requested.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "binding": { "strength": "example", "description": "Why the supply item was requested", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-reason" } } }, { "path": "SupplyRequest.when", "short": "When the request should be fulfilled", "definition": "When the request should be fulfilled.", "min": 0, "max": "1", "isSummary": true }, { "comments": "Code may simply be a priority code.", "path": "SupplyRequest.when.code", "short": "Fulfilment code", "definition": "Code indicating when the request should be fulfilled.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "When the request should be fulfilled", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/supplyrequest-when" } } }, { "path": "SupplyRequest.when.schedule", "short": "Formal fulfillment schedule", "definition": "Formal fulfillment schedule.", "min": 0, "max": "1", "type": [ { "code": "Timing" } ], "isSummary": true } ] } }