0.0.1 - 0.0.1
EAHPInteroperabilityIG - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-05-13 |
Definitions for the SupplyRequestEAHPInteroperability resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. SupplyRequest | |
| Definition | A record of a request to deliver a medication, substance or device used in the healthcare setting to a particular destination for a particular person or organization. |
| Short | Request for a medication, substance or device |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) |
| 2. 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. |
| Short | A set of rules under which this content was created |
| 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. SupplyRequest.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 6. 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 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 managable, 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). |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | 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. |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 8. SupplyRequest.identifier | |
| Definition | Business 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. |
| Short | List of identifiers , should contain at least a request header id and a line header id. The couple (request header id, line header id) must be unique.Business Identifier for SupplyRequest |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on SupplyRequest.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. SupplyRequest.identifier:requestId | |
| Slice Name | requestId |
| Definition | Normally generated by the requesting system to group multiple supply request lines under a single transaction. Business 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. |
| Short | The ID of a complete supply request, spanning multiple medicines/inventory items.Business Identifier for SupplyRequest |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. SupplyRequest.identifier:requestId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. SupplyRequest.identifier:requestId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Control | 10..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. SupplyRequest.status | |
| Definition | Status of the supply request. |
| Short | draft | active | suspended + |
| Control | 10..1 |
| Binding | The codes SHALL be taken from SupplyRequestStatushttp://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0)Status of the supply request. |
| Type | code |
| Is Modifier | true because This element is labeled 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. SupplyRequest.priority | |
| Definition | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. |
| Short | routine | urgent | asap | stat |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0 (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)Identifies the level of importance to be assigned to actioning the request. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. SupplyRequest.item | |
| Definition | The requested supply item, limited to references to Medication or InventoryItem resources. 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. |
| Short | Requested product must be a Medication or InventoryItemMedication, Substance, or Device requested to be supplied |
| 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. |
| Control | 1..1 |
| Binding | For example codes, see SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item|5.0.0 (example to http://hl7.org/fhir/ValueSet/supply-item|5.0.0)The item that was requested. |
| Type | CodeableReference(Medication, InventoryItem, Medication, Substance, Device, DeviceDefinition, BiologicallyDerivedProduct, NutritionProduct, InventoryItem) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. SupplyRequest.item.concept | |
| Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
| Short | Reference to a concept (by class) |
| Control | 0..01 |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. SupplyRequest.quantity | |
| Definition | The quantity of the specified item to be supplied, expressed strictly as a count of physical, atomic units (Indivisible Logistical Units). This represents the handling unit of the automation (e.g., 1 vial, 1 blister, 1 box) rather than the clinical strength or volume. The amount that is being ordered of the indicated item. |
| Short | The count of indivisible logistical units (e.g., pills, packs) requested.The requested amount of the item indicated |
| Control | 1..1 |
| Type | Quantity(EAHP Logistical Quantity) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. SupplyRequest.authoredOn | |
| Definition | When the request was made. |
| Short | When the request was made |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Alternate Names | date, createdOn, signedOn |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. SupplyRequest.requester | |
| Definition | The device, practitioner, etc. who initiated the request. |
| Short | Individual making the request |
| Control | 0..1 |
| Type | Reference(Practitioner, Device, Organization, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device, CareTeam) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | author, source |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. SupplyRequest.deliverFrom | |
| Definition | The specific location representing the automation that should supply the items. This is typically used in point-to-point setups where the source is known. It is optional to allow for central orchestration where the specific fulfillment source is determined dynamically. Where the supply is expected to come from. |
| Short | The automatic location representing the automation that should supply the medicationsThe origin of the supply |
| Control | 0..1 |
| Type | Reference(Location, Organization, Location) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. SupplyRequest.deliverTo | |
| Definition | Where the supply is destined to go. |
| Short | The destination of the supply request. If it must be delivered to an automation, this must be a location linked with the device representing the automation. |
| Control | 0..1 |
| Type | Reference(Organization, Location, Organization, Location, Patient, RelatedPerson) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SupplyRequest | |
| 2. SupplyRequest.identifier | |
| Short | List of identifiers , should contain at least a request header id and a line header id. The couple (request header id, line header id) must be unique. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| Slicing | This element introduces a set of slices on SupplyRequest.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. SupplyRequest.identifier:requestId | |
| Slice Name | requestId |
| Definition | Normally generated by the requesting system to group multiple supply request lines under a single transaction. |
| Short | The ID of a complete supply request, spanning multiple medicines/inventory items. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Must Support | true |
| 6. SupplyRequest.identifier:requestId.type | |
| Control | 1..? |
| Pattern Value | { |
| 8. SupplyRequest.status | |
| Control | 1..? |
| Must Support | true |
| 10. SupplyRequest.priority | |
| Must Support | true |
| 12. SupplyRequest.item | |
| Definition | The requested supply item, limited to references to Medication or InventoryItem resources. |
| Short | Requested product must be a Medication or InventoryItem |
| Type | CodeableReference(Medication, InventoryItem) |
| 14. SupplyRequest.item.concept | |
| Control | 0..0 |
| 16. SupplyRequest.quantity | |
| Definition | The quantity of the specified item to be supplied, expressed strictly as a count of physical, atomic units (Indivisible Logistical Units). This represents the handling unit of the automation (e.g., 1 vial, 1 blister, 1 box) rather than the clinical strength or volume. |
| Short | The count of indivisible logistical units (e.g., pills, packs) requested. |
| Type | Quantity(EAHP Logistical Quantity) |
| 18. SupplyRequest.authoredOn | |
| Must Support | true |
| 20. SupplyRequest.requester | |
| Type | Reference(Practitioner, Device, Organization) |
| 22. SupplyRequest.deliverFrom | |
| Definition | The specific location representing the automation that should supply the items. This is typically used in point-to-point setups where the source is known. It is optional to allow for central orchestration where the specific fulfillment source is determined dynamically. |
| Short | The automatic location representing the automation that should supply the medications |
| Type | Reference(Location) |
| Must Support | true |
| 24. SupplyRequest.deliverTo | |
| Short | The destination of the supply request. If it must be delivered to an automation, this must be a location linked with the device representing the automation. |
| Type | Reference(Organization, Location) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SupplyRequest | |
| Definition | A record of a request to deliver a medication, substance or device used in the healthcare setting to a particular destination for a particular person or organization. |
| Short | Request for a medication, substance or device |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) |
| 2. SupplyRequest.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. 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. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. 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. |
| Short | A set of rules under which this content was created |
| 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. SupplyRequest.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. 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. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. SupplyRequest.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. SupplyRequest.extension | |
| 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 managable, 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 16. 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 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 managable, 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). |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Requirements | 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. |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 18. SupplyRequest.identifier | |
| Definition | Business 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. |
| Short | List of identifiers , should contain at least a request header id and a line header id. The couple (request header id, line header id) must be unique. |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on SupplyRequest.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SupplyRequest.identifier:requestId | |
| Slice Name | requestId |
| Definition | Normally generated by the requesting system to group multiple supply request lines under a single transaction. |
| Short | The ID of a complete supply request, spanning multiple medicines/inventory items. |
| Comments | The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. SupplyRequest.identifier:requestId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. SupplyRequest.identifier:requestId.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 managable, 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on SupplyRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. SupplyRequest.identifier:requestId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. SupplyRequest.identifier:requestId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. SupplyRequest.identifier:requestId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. SupplyRequest.identifier:requestId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. SupplyRequest.identifier:requestId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. SupplyRequest.identifier:requestId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. SupplyRequest.status | |
| Definition | Status of the supply request. |
| Short | draft | active | suspended + |
| Control | 1..1 |
| Binding | The codes SHALL be taken from SupplyRequestStatus (required to http://hl7.org/fhir/ValueSet/supplyrequest-status|5.0.0)Status of the supply request. |
| Type | code |
| Is Modifier | true because This element is labeled 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. SupplyRequest.basedOn | |
| Definition | Plan/proposal/order fulfilled by this request. |
| Short | What other request is fulfilled by this supply request |
| Control | 0..* |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. SupplyRequest.category | |
| Definition | Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. |
| Short | The kind of supply (central, non-stock, etc.) |
| Control | 0..1 |
| Binding | For example codes, see SupplyType (example to http://hl7.org/fhir/ValueSet/supplyrequest-kind|5.0.0)Category of supply request. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | kind |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. SupplyRequest.priority | |
| Definition | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. |
| Short | routine | urgent | asap | stat |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)Identifies the level of importance to be assigned to actioning the request. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. SupplyRequest.deliverFor | |
| Definition | The patient to whom the supply will be given or for whom they will be used. |
| Short | The patient for who the supply request is for |
| Control | 0..1 |
| Type | Reference(Patient) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | subject |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. SupplyRequest.item | |
| Definition | The requested supply item, limited to references to Medication or InventoryItem resources. |
| Short | Requested product must be a Medication or InventoryItem |
| 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. |
| Control | 1..1 |
| Binding | For example codes, see SNOMEDCTSupplyItem (example to http://hl7.org/fhir/ValueSet/supply-item|5.0.0)The item that was requested. |
| Type | CodeableReference(Medication, InventoryItem) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. SupplyRequest.item.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 52. SupplyRequest.item.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 managable, 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on SupplyRequest.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. SupplyRequest.item.concept | |
| Definition | A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology. |
| Short | Reference to a concept (by class) |
| Control | 0..0 |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. SupplyRequest.item.reference | |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Short | Reference to a resource (by instance) |
| Control | 0..1 |
| Type | Reference |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. SupplyRequest.quantity | |
| Definition | The quantity of the specified item to be supplied, expressed strictly as a count of physical, atomic units (Indivisible Logistical Units). This represents the handling unit of the automation (e.g., 1 vial, 1 blister, 1 box) rather than the clinical strength or volume. |
| Short | The count of indivisible logistical units (e.g., pills, packs) requested. |
| Control | 1..1 |
| Type | Quantity(EAHP Logistical Quantity) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. SupplyRequest.parameter | |
| Definition | Specific parameters for the ordered item. For example, the size of the indicated item. |
| Short | Ordered item details |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. 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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 64. 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 managable, 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| 66. 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 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 managable, 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 68. SupplyRequest.parameter.code | |
| Definition | A code or string that identifies the device detail being asserted. |
| Short | Item detail |
| Control | 0..1 |
| Binding | A code that identifies the device detail. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. SupplyRequest.parameter.value[x] | |
| Definition | The value of the device detail. |
| Short | Value of detail |
| Comments | Range means device should have a value that falls somewhere within the specified range. |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, Quantity, Range, boolean |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. SupplyRequest.occurrence[x] | |
| Definition | When the request should be fulfilled. |
| Short | When the request should be fulfilled |
| Control | 0..1 |
| Type | Choice of: dateTime, Period, Timing |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Alternate Names | when, timing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. SupplyRequest.authoredOn | |
| Definition | When the request was made. |
| Short | When the request was made |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Alternate Names | date, createdOn, signedOn |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. SupplyRequest.requester | |
| Definition | The device, practitioner, etc. who initiated the request. |
| Short | Individual making the request |
| Control | 0..1 |
| Type | Reference(Practitioner, Device, Organization) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | author, source |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. SupplyRequest.supplier | |
| Definition | Who is intended to fulfill the request. |
| Short | Who is intended to fulfill the request |
| Control | 0..* |
| Type | Reference(Organization, HealthcareService) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | performer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. SupplyRequest.reason | |
| Definition | The reason why the supply item was requested. |
| Short | The reason why the supply item was requested |
| Control | 0..* |
| Binding | For example codes, see SupplyRequestReason (example to http://hl7.org/fhir/ValueSet/supplyrequest-reason|5.0.0)The reason why the supply item was requested. |
| Type | CodeableReference(Condition, Observation, DiagnosticReport, DocumentReference) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. SupplyRequest.deliverFrom | |
| Definition | The specific location representing the automation that should supply the items. This is typically used in point-to-point setups where the source is known. It is optional to allow for central orchestration where the specific fulfillment source is determined dynamically. |
| Short | The automatic location representing the automation that should supply the medications |
| Control | 0..1 |
| Type | Reference(Location) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. SupplyRequest.deliverTo | |
| Definition | Where the supply is destined to go. |
| Short | The destination of the supply request. If it must be delivered to an automation, this must be a location linked with the device representing the automation. |
| Control | 0..1 |
| Type | Reference(Organization, Location) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |