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. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: CRD SupplyRequest - Detailed Descriptions

Definitions for the profile-supplyrequest-r4 Profile.

SupplyRequest
Definition

A record of a request for a medication, substance or device used in the healthcare setting.

Control0..*
InvariantsDefined on this element
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 or SHALL refer to the containing resource (: 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())
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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.div.exists())
SupplyRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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 might not always be associated with version changes to the resource.

Control0..1
TypeMeta
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
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. 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.

SupplyRequest.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from Common Languages
Typecode
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 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.

Control0..1
TypeNarrative
Alternate Namesnarrative, 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 information 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.

Control0..*
TypeResource
Alternate Namesinline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

SupplyRequest.extension
Definition

An Extension

Control0..*
TypeExtension
SupplyRequest.extension ([CanonicalType[http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance]])
Definition

Indicates coverage relevant to the appointment.

Control1..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(CRD Coverage))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (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. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Must Supporttrue
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.

Control1..1
BindingStatus of the supply request.
The codes SHALL be taken from SupplyRequestStatus
Typecode
Is Modifiertrue
Must Supporttrue
Fixed Valuedraft
SupplyRequest.category
Definition

Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.

Control0..1
BindingCategory of supply request.
For example codes, see SupplyType
TypeCodeableConcept
Alternate Nameskind
Comments

potentially relevant for CRD in some situations.

SupplyRequest.priority
Definition

Indicates how quickly this SupplyRequest should be addressed with respect to other requests.

Control0..1
BindingIdentifies the level of importance to be assigned to actioning the request.
The codes SHALL be taken from RequestPriority
Typecode
Meaning if MissingIf missing, this task should be performed with normal priority
SupplyRequest.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.

Control1..1
BindingThe item that was requested.
For example codes, see SNOMEDCTSupplyItem
TypeChoice of: Reference(CRD Medication | CRD Device), CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
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.quantity
Definition

The amount that is being ordered of the indicated item.

Control1..1
TypeQuantity
Must Supporttrue
SupplyRequest.parameter
Definition

Specific parameters for the ordered item. For example, the size of the indicated item.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SupplyRequest.parameter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
SupplyRequest.parameter.extension
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.parameter.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 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.parameter.code
Definition

A code or string that identifies the device detail being asserted.

Control0..1
BindingA code that identifies the device detail.
TypeCodeableConcept
SupplyRequest.parameter.value[x]
Definition

The value of the device detail.

Control0..1
TypeChoice of: CodeableConcept, Quantity, Range, boolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Range means device should have a value that falls somewhere within the specified range.

SupplyRequest.occurrence[x]
Definition

When the request should be fulfilled.

Control0..1
TypeChoice of: dateTime, Period, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Alternate Nameswhen, timing
SupplyRequest.authoredOn
Definition

When the request was made.

Control1..1
TypedateTime
Must Supporttrue
Alternate Namesdate, createdOn, signedOn
SupplyRequest.requester
Definition

The device, practitioner, etc. who initiated the request.

Control1..1
TypeReference(CRD Practitioner | CRD PractitionerRole)
Must Supporttrue
Alternate Namesauthor, source
SupplyRequest.supplier
Definition

Who is intended to fulfill the request.

Control0..1
TypeReference(CRD Organization)
Must Supporttrue
Alternate Namesperformer
SupplyRequest.reasonCode
Definition

The reason why the supply item was requested.

Control0..*
BindingThe reason why the supply item was requested.
For example codes, see SupplyRequestReason
TypeCodeableConcept
Must Supporttrue
Comments

potentially relevant for CRD in some situations.

SupplyRequest.reasonReference
Definition

The reason why the supply item was requested.

Control0..*
TypeReference(CRD Condition | CRD Observation)
Must Supporttrue
Comments

potentially relevant for CRD in some situations.

SupplyRequest.deliverFrom
Definition

Where the supply is expected to come from.

Control0..1
TypeReference(CRD Organization | CRD Location)
SupplyRequest.deliverTo
Definition

Where the supply is destined to go.

Control0..1
TypeReference(CRD Organization | CRD Location | CRD Patient)