This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: CRD SupplyRequest - Detailed Descriptions

Definitions for the profile-supplyrequest-stu3 Profile.

SupplyRequest
Definition | A record of a request for a medication, substance or device used in the healthcare setting.
Control | 0..*
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
SupplyRequest.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
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.
SupplyRequest.meta
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.
Control | 0..1
Type | Meta
SupplyRequest.implicitRules
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.
Control | 0..1
Type | uri
Is Modifier | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
SupplyRequest.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Type | code
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).
SupplyRequest.text
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.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
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.
SupplyRequest.contained
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.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
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.
SupplyRequest.extension
Definition | An Extension
Control | 0..*
Type | Extension
SupplyRequest.extension ([CanonicalType[http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/ext-insurance]])
Definition | Indicates coverage relevant to the appointment.
Control | 1..1 This element is affected by the following invariants: ele-1
Type | (Extension Type: Reference(CRD Coverage))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SupplyRequest.modifierExtension
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.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content
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.
SupplyRequest.identifier
Definition | Unique identifier for this supply request.
Note | This is a business identifer, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Comments | This is assigned by the requester, and used to refer to this order in other external standards.
SupplyRequest.status
Definition | Status of the supply request.
Control | 1..1
Binding | Status of the supply request The codes SHALL be taken from SupplyRequestStatus
Type | code
Is Modifier | true
Must Support | true
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Fixed Value | draft
SupplyRequest.category
Definition | Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
Control | 0..1
Binding | Category of supply request For example codes, see Supply Type
Type | CodeableConcept
Alternate Names | kind
Comments | potentially relevant for CRD in some situations.
SupplyRequest.priority
Definition | Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
Control | 0..1
Binding | Identifies the level of importance to be assigned to actioning the request The codes SHALL be taken from RequestPriority
Type | code
Meaning if Missing | If missing, this task should be performed with normal priority
SupplyRequest.orderedItem
Definition | The item being requested.
Control | 1..1
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
SupplyRequest.orderedItem.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
SupplyRequest.orderedItem.extension
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
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.
SupplyRequest.orderedItem.modifierExtension
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.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
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.
SupplyRequest.orderedItem.quantity
Definition | The amount that is being ordered of the indicated item.
Control | 1..1
Type | Quantity
Must Support | true
SupplyRequest.orderedItem.item[x]
Definition | The item that is requested to be supplied. 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.
Control | 1..1
Binding | The item that was requested For example codes, see SNOMED CT Supply Item
Type | Choice of: Reference(http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-medication-stu3 | CRD Device), CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
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.
SupplyRequest.occurrence[x]
Definition | When the request should be fulfilled.
Control | 0..1
Type | Choice of: dateTime, Period, Timing
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Alternate Names | when, timing
SupplyRequest.authoredOn
Definition | When the request was made.
Control | 1..1
Type | dateTime
Must Support | true
Alternate Names | date, createdOn, signedOn
SupplyRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Control | 1..1
Type | BackboneElement
Must Support | true
Alternate Names | author, source
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
SupplyRequest.requester.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
SupplyRequest.requester.extension
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
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.
SupplyRequest.requester.modifierExtension
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.
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
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.
SupplyRequest.requester.agent
Definition | The device, practitioner, etc. who initiated the request.
Control | 1..1
Type | Reference(CRD Practitioner)
Must Support | true
SupplyRequest.requester.onBehalfOf
Definition | The organization the device or practitioner was acting on behalf of.
Control | 0..1
Type | Reference(CRD Organization)
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.
Comments | potentially relevant for CRD in some situations.
SupplyRequest.supplier
Definition | Who is intended to fulfill the request.
Control | 0..1
Type | Reference(CRD Organization)
Must Support | true
Alternate Names | performer
SupplyRequest.reason[x]
Definition | Why the supply item was requested.
Control | 0..1
Binding | Why the supply item was requested For example codes, see SupplyRequestReason
Type | Choice of: CodeableConcept, Reference(US Core Condition Profile | US Core Result Observation)
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Comments | potentially relevant for CRD in some situations.
SupplyRequest.deliverFrom
Definition | Where the supply is expected to come from.
Control | 0..1
Type | Reference(CRD Organization | CRD Location)
SupplyRequest.deliverTo
Definition | Where the supply is destined to go.
Control | 0..1
Type | Reference(CRD Organization | CRD Location | CRD Patient)