Resource: SupplyRequest
Additional guidance based on the FHIR R4 SupplyRequest resource, for which the tree view of the resource is shown below.
| SupplyRequest | C | DomainResource | Element idSupplyRequestShort description Request for a medication, substance or device DefinitionA record of a request for a medication, substance or device used in the healthcare setting.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idSupplyRequest.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSupplyRequest.metaShort description Metadata about the resource DefinitionThe 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. | ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSupplyRequest.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. | ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSupplyRequest.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idSupplyRequest.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idSupplyRequest.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idSupplyRequest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idSupplyRequest.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 and/or the understanding of the containing element's descendants. 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| ||
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSupplyRequest.identifierShort description Business Identifier for SupplyRequest DefinitionBusiness identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.
| ||
| status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idSupplyRequest.statusShort description draft | active | suspended + DefinitionStatus of the supply request. Status of the supply request. http://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.0 (required) Mappings
| ||
| category | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSupplyRequest.categoryShort description The kind of supply (central, non-stock, etc.) Alternate nameskind DefinitionCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. Category of supply request. Mappings
| ||
| priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idSupplyRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly this SupplyRequest should be addressed with respect to other requests. If missing, this task should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. http://hl7.org/fhir/ValueSet/request-priority|4.0.0 (required) Mappings
| ||
| item[x] | Σ | 1..1 | There are no (further) constraints on this element Element idSupplyRequest.item[x]Short description Medication, Substance, or Device requested to be supplied DefinitionThe 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. 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. The item that was requested. Mappings
| |||
| itemCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| itemReference | Reference(Device | Medication | Substance) | There are no (further) constraints on this element Data type | ||||
| quantity | Σ | 1..1 | Quantity | There are no (further) constraints on this element Element idSupplyRequest.quantityShort description The requested amount of the item indicated DefinitionThe amount that is being ordered of the indicated item.
| ||
| parameter | 0..* | BackboneElement | There are no (further) constraints on this element Element idSupplyRequest.parameterShort description Ordered item details DefinitionSpecific parameters for the ordered item. For example, the size of the indicated item.
| |||
| occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idSupplyRequest.occurrence[x]Short description When the request should be fulfilled Alternate nameswhen, timing DefinitionWhen the request should be fulfilled.
| |||
| occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| occurrencePeriod | Period | There are no (further) constraints on this element Data type | ||||
| occurrenceTiming | Timing | There are no (further) constraints on this element Data type | ||||
| authoredOn | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idSupplyRequest.authoredOnShort description When the request was made Alternate namesdate, createdOn, signedOn DefinitionWhen the request was made.
| ||
| requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idSupplyRequest.requesterShort description Individual making the request Alternate namesauthor, source DefinitionThe device, practitioner, etc. who initiated the request. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Mappings
| ||
| supplier | Σ | 0..* | Reference(HealthcareService | Organization) | There are no (further) constraints on this element Element idSupplyRequest.supplierShort description Who is intended to fulfill the request Alternate namesperformer DefinitionWho is intended to fulfill the request. Reference(HealthcareService | Organization) Mappings
| ||
| reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idSupplyRequest.reasonCodeShort description The reason why the supply item was requested DefinitionThe reason why the supply item was requested. The reason why the supply item was requested. Mappings
| |||
| reasonReference | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | There are no (further) constraints on this element Element idSupplyRequest.reasonReferenceShort description The reason why the supply item was requested DefinitionThe reason why the supply item was requested. Reference(Condition | DiagnosticReport | DocumentReference | Observation) Mappings
| |||
| deliverFrom | 0..1 | Reference(Location | Organization) | There are no (further) constraints on this element Element idSupplyRequest.deliverFromShort description The origin of the supply DefinitionWhere the supply is expected to come from. Reference(Location | Organization) Mappings
| |||
| deliverTo | 0..1 | Reference(Location | Organization | Patient) | There are no (further) constraints on this element Element idSupplyRequest.deliverToShort description The destination of the supply DefinitionWhere the supply is destined to go. Reference(Location | Organization | Patient) Mappings
|
Guidance to be added...