API Name: put-ordered-medications
This API creates medication order records representing one or more medication orders or requests for both supply of the medication and the instructions for administration of the medication to a patient.
Specification
| Endpoint | [baseurl]/$put-ordered-medications |
|---|---|
| Protocol | HTTPS |
| HTTP Method | Post |
| HTTP Header | Content-Type: application/fhir+json |
Request Body
Remarks:
- (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
- This is a system-level operation that processes a Bundle of MedicationRequest resources.
- Medications in the bundle can be organized into groups using
groupIdentifierand connected using theorderSetConnectingTermextension for step doses (THEN) and variable doses (AND).
Bundle
| Bundle | C | Bundle | There are no (further) constraints on this element Element idBundleShort description Contains a collection of resources DefinitionA container for a collection of resources.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.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. 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. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.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 idBundle.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 its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.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). IETF language tag for a human language
| |
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idBundle.identifierShort description Persistent identifier for the bundle DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. The cardinality or value of this element may be affected by these constraints: bdl-9 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idBundle.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 0..1 | uriFixed Value | Element idBundle.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/StructureDefinition/profile-bundle-medicationrequestExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 0..1 | string | There are no (further) constraints on this element Element idBundle.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idBundle.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idBundle.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| type | Σ C | 1..1 | codeBindingFixed Value | Element idBundle.typeShort description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification DefinitionIndicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Indicates the purpose of a bundle - how it is intended to be used. The cardinality or value of this element may be affected by these constraints: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 Constraints
transactionMappings
|
| timestamp | Σ C | 0..0 | instant | There are no (further) constraints on this element Element idBundle.timestampShort description When the bundle was assembled DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. The cardinality or value of this element may be affected by these constraints: bdl-10 Constraints
|
| total | Σ C | 0..0 | unsignedInt | There are no (further) constraints on this element Element idBundle.totalShort description If search, the total number of matches DefinitionIf a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. The cardinality or value of this element may be affected by these constraints: bdl-1 Constraints
|
| link | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.linkShort description Links related to this Bundle DefinitionA series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. The cardinality or value of this element may be affected by these constraints: bdl-18 Constraints
|
| entry | Σ C | 1..* | BackboneElement | Element idBundle.entryShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Unordered, Open, by resource(Profile) Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.resourceShort description A resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Mappings
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
|
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
|
| medicationrequest | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequestShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | MedicationRequest | Element idBundle.entry:medicationrequest.resourceShort description Ordering of medication for patient or group Alternate namesPrescription, Order DefinitionAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
|
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
|
| dispenser | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenserShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:dispenser.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:dispenser.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | Location | Element idBundle.entry:dispenser.resourceShort description Details and position information for a place DefinitionDetails and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| signature | Σ | 0..0 | Signature | There are no (further) constraints on this element Element idBundle.signatureShort description Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSig or a JWS. A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
|
| issues | Σ C | 0..0 | OperationOutcome | There are no (further) constraints on this element Element idBundle.issuesShort description Issues with the Bundle DefinitionCaptures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. The cardinality or value of this element may be affected by these constraints: bdl-16, bdl-17 Constraints
|
| MedicationRequest | C | MedicationRequest | There are no (further) constraints on this element Element idMedicationRequestShort description Ordering of medication for patient or group Alternate namesPrescription, Order DefinitionAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedicationRequest.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. 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. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedicationRequest.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 idMedicationRequest.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 its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.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). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idMedicationRequest.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 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. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idMedicationRequest.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, 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. 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. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.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 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. 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 Constraints
|
| orderingLocation | C | 0..1 | Extension(string) | Element idMedicationRequest.extension:orderingLocationShort description Ordering Location Information Alternate namesextensions, user content DefinitionExtension for capturing ordering location information in MedicationRequest 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. https://fhir.synapxe.sg/StructureDefinition/ext-orderingLocation Constraints
|
| orderSetConnectingTerm | C | 0..1 | Extension(CodeableConcept) | Element idMedicationRequest.extension:orderSetConnectingTermShort description Order Set Connecting Term Information Alternate namesextensions, user content DefinitionExtension for capturing order set connecting term information in MedicationRequest 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. https://fhir.synapxe.sg/StructureDefinition/ext-orderSetConnectingTerm Constraints
|
| changesMade | C | 0..* | Extension(string) | Element idMedicationRequest.extension:changesMadeShort description Changes Made Information Alternate namesextensions, user content DefinitionExtension for capturing changes made information in MedicationRequest 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. https://fhir.synapxe.sg/StructureDefinition/ext-changesMade Constraints
|
| authorizer | C | 0..* | Extension(Reference(Practitioner)) | Element idMedicationRequest.extension:authorizerShort description Authorizer Information Alternate namesextensions, user content DefinitionExtension for capturing authorizer information in MedicationRequest 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. Extension(Reference(Practitioner)) Extension URLhttps://fhir.synapxe.sg/StructureDefinition/ext-authorizer Constraints
|
| orderingInstitution | C | 0..1 | Extension(Reference(Organization)) | Element idMedicationRequest.extension:orderingInstitutionShort description Ordering Institution Information Alternate namesextensions, user content DefinitionExtension for capturing ordering institution information in ServiceRequest 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. Extension(Reference(Organization)) Extension URLhttps://fhir.synapxe.sg/StructureDefinition/ext-orderingInstitution Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.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 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). 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 Constraints
|
| identifier | C | 1..* | Identifier | Element idMedicationRequest.identifierShort description External ids for this request DefinitionIdentifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier. Unordered, Open, by $this(Value) Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| recordIdentifier | C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifierShort description External ids for this request DefinitionIdentifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.identifier:recordIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/record-idExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.identifier:recordIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| orderID | C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderIDShort description External ids for this request DefinitionIdentifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.identifier:orderID.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/order-noExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.identifier:orderID.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| sourceGroupingID | C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingIDShort description External ids for this request DefinitionIdentifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.identifier:sourceGroupingID.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/source-grouping-idExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.identifier:sourceGroupingID.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| sequenceNo | C | 0..1 | Identifier | Element idMedicationRequest.identifier:sequenceNoShort description An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.identifier:sequenceNo.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/sequence-noExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.identifier:sequenceNo.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| basedOn | Σ C | 0..0 | Reference(Encounter) | Element idMedicationRequest.basedOnShort description A plan or request that is fulfilled in whole or in part by this medication request DefinitionA plan or request that is fulfilled in whole or in part by this medication request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| priorPrescription | C | 0..0 | Reference(MedicationRequest) | There are no (further) constraints on this element Element idMedicationRequest.priorPrescriptionShort description Reference to an order/prescription that is being replaced by this MedicationRequest DefinitionReference to an order/prescription that is being replaced by this MedicationRequest. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| groupIdentifier | Σ C | 1..1 | Identifier | Element idMedicationRequest.groupIdentifierShort description An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.groupIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/group-noExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.groupIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| status | Σ ?! | 1..1 | codeBinding | Element idMedicationRequest.statusShort description active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown DefinitionA code specifying the current state of the order. Generally, this will be active or completed state. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Clinical decision support systems should take the status into account when determining which medications to include in their algorithms. A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. MedicationrequestStatusValueSet (required) Constraints
|
| statusReason | 0..1 | CodeableConceptBinding | Element idMedicationRequest.statusReasonShort description Reason for cancellation, if it is cancelled DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Identifies the reasons for a given status. StatusReasonValueSet (required) Constraints
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.statusReason.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.statusReason.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 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. 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 Constraints
|
| coding | Σ C | 1..* | Coding | There are no (further) constraints on this element Element idMedicationRequest.statusReason.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.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 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. 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 Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.statusReason.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/status-reasonMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.statusReason.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.statusReason.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| statusChanged | 0..1 | dateTime | Element idMedicationRequest.statusChangedShort description if status is Discontinued, this is the discontinued date time Definitionif status is Discontinued, this is the discontinued date time UTC offset is allowed for dates and partial dates
| |
| intent | Σ ?! | 1..1 | codeBindingFixed Value | Element idMedicationRequest.intentShort description proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, or an original order. It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of medication order. MedicationRequestIntent (required) Constraints
orderMappings
|
| category | 1..1 | CodeableConceptBinding | Element idMedicationRequest.categoryShort description The specific clinical setting when this medication is ordered DefinitionThe specific clinical setting when this medication is ordered Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept identifying where the medication is to be consumed or administered.
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.category.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.category.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 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. 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 Constraints
|
| coding | Σ C | 1..* | Coding | There are no (further) constraints on this element Element idMedicationRequest.category.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.category.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.category.coding.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 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. 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 Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.category.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/order-typeMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.category.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.category.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.category.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.category.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.category.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| priority | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the Medication Request should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size Identifies the level of importance to be assigned to actioning the request.
|
| doNotPerform | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.doNotPerformShort description True if patient is to stop taking or not to start taking the medication DefinitionIf true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication. If do not perform is not specified, the request is a positive request e.g. "do perform".
|
| medication | Σ | 1..1 | CodeableReference(Medication) | Element idMedicationRequest.medicationShort description Medication to be taken DefinitionIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource. Allowed aggregation:contained BindingA coded concept identifying substance or product that can be ordered. SNOMEDCTMedicationCodes (example) Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.medication.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 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. 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 Constraints
|
| concept | Σ | 1..1 | CodeableConceptBinding | Element idMedicationRequest.medication.conceptShort description Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.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 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. 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 Constraints
|
| coding | Σ C | 1..* | Coding | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.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 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. 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 Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.medication.concept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/med-codeMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.concept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| reference | Σ C | 0..1 | Reference | There are no (further) constraints on this element Element idMedicationRequest.medication.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.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 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. 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 Constraints
|
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
|
| identifier | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| display | Σ C | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.medication.reference.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| subject | Σ C | 1..1 | Reference(Patient) | Element idMedicationRequest.subjectShort description A reference from one resource to another DefinitionA reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.subject.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.subject.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 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. 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 Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | There are no (further) constraints on this element Element idMedicationRequest.subject.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
PatientMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.subject.identifierShort description An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/nricExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.subject.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| informationSource | C | 0..0 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idMedicationRequest.informationSourceShort description The person or organization who provided the information about this request, if the source is someone other than the requestor DefinitionThe person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
| encounter | C | 0..1 | Reference(Encounter) | Element idMedicationRequest.encounterShort description A reference from one resource to another DefinitionA reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| supportingInformation | C | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idMedicationRequest.supportingInformationShort description Information to support fulfilling of the medication DefinitionInformation to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient). This attribute can be used to reference a MedicationStatement about the patients' medication use.
|
| authoredOn | Σ | 1..1 | dateTime | Element idMedicationRequest.authoredOnShort description medication order date time DefinitionThe date (and perhaps time) when the prescription was initially written or authored on. UTC offset is allowed for dates and partial dates
|
| requester | Σ C | 1..1 | Reference(Practitioner) | Element idMedicationRequest.requesterShort description A reference from one resource to another DefinitionA reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.requester.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.requester.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 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. 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 Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.requester.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | There are no (further) constraints on this element Element idMedicationRequest.requester.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
PractitionerMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.requester.identifierShort description An identifier intended for computation DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.requester.identifier.systemShort description The namespace for the identifier value Definitionhttps://fhir.synapxe.sg/NamingSystem/mcr https://fhir.synapxe.sg/NamingSystem/dcr https://fhir.synapxe.sg/NamingSystem/prn https://fhir.synapxe.sg/NamingSystem/snb 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/mcrExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.requester.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| display | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.requester.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| reported | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.reportedShort description Reported rather than primary record DefinitionIndicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report. If not populated, then assume that this is the original record and not reported
|
| performerType | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.performerTypeShort description Desired kind of performer of the medication administration DefinitionIndicates the type of performer of the administration of the medication. If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available. Identifies the type of individual that is desired to administer the medication. MedicationIntendedPerformerRole (extensible) Constraints
|
| performer | C | 0..0 | Reference(Practitioner) | Element idMedicationRequest.performerShort description Intended performer of administration DefinitionThe specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| device | 0..0 | CodeableReference(DeviceDefinition) | There are no (further) constraints on this element Element idMedicationRequest.deviceShort description Intended type of device for the administration DefinitionThe intended type of device that is to be used for the administration of the medication (for example, PCA Pump). CodeableReference(DeviceDefinition) Constraints
| |
| recorder | C | 0..0 | Reference(Practitioner) | Element idMedicationRequest.recorderShort description The healthcare professional responsible for prescribing this medication order DefinitionThe healthcare professional responsible for prescribing this medication order References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| reason | 0..1 | CodeableReference(Condition | Observation) | There are no (further) constraints on this element Element idMedicationRequest.reasonShort description Reason or indication for ordering or not ordering the medication DefinitionThe reason or the indication for ordering or not ordering the medication. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. CodeableReference(Condition | Observation) BindingA coded concept indicating why the medication was ordered. ConditionProblemDiagnosisCodes (example) Constraints
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.reason.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 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. 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 Constraints
|
| concept | Σ | 1..1 | CodeableConceptBinding | Element idMedicationRequest.reason.conceptShort description Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. ReasonForMedicationValueSet (required) Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.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 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. 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 Constraints
|
| coding | Σ C | 1..* | Coding | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.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 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. 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 Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idMedicationRequest.reason.concept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/reason-for-medicationMappings
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.reason.concept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| reference | Σ C | 0..1 | Reference | There are no (further) constraints on this element Element idMedicationRequest.reason.referenceShort description Reference to a resource (by instance) DefinitionA reference to a resource the provides exact details about the information being referenced. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| courseOfTherapyType | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.courseOfTherapyTypeShort description Overall pattern of medication administration DefinitionThe description of the overall pattern of the administration of the medication to the patient. This attribute should not be confused with the protocol of the medication. Identifies the overall pattern of medication administratio. MedicationRequestCourseOfTherapyCodes (extensible) Constraints
| |
| insurance | C | 0..0 | Reference(ClaimResponse | Coverage) | There are no (further) constraints on this element Element idMedicationRequest.insuranceShort description Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ClaimResponse | Coverage) Constraints
|
| note | 0..1 | Annotation | Element idMedicationRequest.noteShort description Text node with attribution DefinitionA text note which also contains information about who made the statement and when. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
| renderedDosageInstruction | 0..0 | markdown | There are no (further) constraints on this element Element idMedicationRequest.renderedDosageInstructionShort description Full representation of the dosage instructions DefinitionThe full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
| effectiveDosePeriod | C | 0..1 | Period | There are no (further) constraints on this element Element idMedicationRequest.effectiveDosePeriodShort description Period over which the medication is to be taken DefinitionThe period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.effectiveDosePeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.effectiveDosePeriod.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 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. 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 Constraints
|
| start | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationRequest.effectiveDosePeriod.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| end | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationRequest.effectiveDosePeriod.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| dosageInstruction | C | 1..1 | Dosage | There are no (further) constraints on this element Element idMedicationRequest.dosageInstructionShort description Specific instructions for how the medication should be taken DefinitionSpecific instructions for how the medication is to be used by the patient. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. In general, each prescribed drug will be a separate Medication Request. When drug orders are grouped together at the time of order entry, but each of the drugs can be manipulated independently e.g. changing the status of one order to "completed" or "cancelled", changing another order status to "on-hold", the method to "group" all of the medication requests together is to use MedicationRequest.groupIdentifier element. All of the orders grouped together in this manner will have the same groupIdentifier, and separately, each order in the group may have a unique identifier. There are cases that require grouping of Medication orders together when it is necessary to specify optionality e.g. order two drugs at one time, but stating either of these drugs may be used to treat the patient. The use of a RequestOrchestration should be used as a parent for the Medication orders that require this type of grouping. An example when it may be necessary to group medication orders together is when you specify timing relationships e.g. order drug "xyz" with dose 123, then taper the same drug to a different dose after some interval of time precedence: e.g. give drug "abc" followed by drug "def" e.g. give drug 30 minutes before some procedure was performed more generically this supports - hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group. Note that one should NOT use the List or Composition resource to accomplish the above requirements. You may use List or Composition for other business requirements, but not to address the specific requirements of grouping medication orders.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| sequence | Σ | 1..1 | integer | Element idMedicationRequest.dosageInstruction.sequenceShort description The sequence number of the dosage instructions for step or variable dose DefinitionThe sequence number of the dosage instructions for step or variable dose If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. 32 bit number; for values larger than this, use decimal
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.textShort description Free text dosage instructions e.g. SIG DefinitionFree text dosage instructions e.g. SIG. Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| additionalInstruction | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.additionalInstructionShort description Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" DefinitionSupplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text. A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". SNOMEDCTAdditionalDosageInstructions (example) Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.additionalInstruction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.additionalInstruction.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 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. 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 Constraints
|
| coding | Σ C | 0..0 | Coding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.additionalInstruction.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.additionalInstruction.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| patientInstruction | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.patientInstructionShort description Patient or consumer oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| timing | Σ | 0..1 | Timing | Element idMedicationRequest.dosageInstruction.timingShort description When medication should be administered DefinitionWhen medication should be administered. Frequency code, duration and durationUnits. Refer to https://hl7.org/fhir/datatypes.html#timing on how to populate timing. For example duration code "1 week" and frquency code "every morning" will map to period "1", periodUnit "week" and when "MORN" The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| event | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. UTC offset is allowed for dates and partial dates
|
| repeat | Σ C | 0..1 | Element | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.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 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. 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 Constraints
|
| bounds[x] | Σ | 0..1 | Range | Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].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 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. 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 Constraints
|
| low | Σ C | 1..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].lowShort description Low limit DefinitionThe low limit. The boundary is inclusive. If the low element is missing, the low boundary is not known. The cardinality or value of this element may be affected by these constraints: rng-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.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 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. 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 Constraints
|
| value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.valueShort description Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
|
| comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.comparatorShort description < | <= | >= | > | ad - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
| unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.unitShort description Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.systemShort description System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].low.codeShort description Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| high | Σ C | 1..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].highShort description High limit DefinitionThe high limit. The boundary is inclusive. If the high element is missing, the high boundary is not known. The cardinality or value of this element may be affected by these constraints: rng-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.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 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. 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 Constraints
|
| value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.valueShort description Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
|
| comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.comparatorShort description < | <= | >= | > | ad - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
| unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.unitShort description Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.systemShort description System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.bounds[x].high.codeShort description Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| count | Σ C | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. The cardinality or value of this element may be affected by these constraints: tim-8 Constraints
|
| countMax | Σ C | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: tim-8 Constraints
|
| duration | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). The cardinality or value of this element may be affected by these constraints: tim-7, tim-1, tim-4 Constraints
|
| durationMax | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). The cardinality or value of this element may be affected by these constraints: tim-7 Constraints
|
| durationUnit | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size A unit of time (units from UCUM). The cardinality or value of this element may be affected by these constraints: tim-1 Constraints
|
| frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.frequencyShort description Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. 32 bit number; for values larger than this, use decimal If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
| frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. 32 bit number; for values larger than this, use decimal
|
| period | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.periodShort description The duration to which the frequency applies. I.e. Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: tim-6, tim-5, tim-2 Constraints
|
| periodMax | Σ C | 0..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) The cardinality or value of this element may be affected by these constraints: tim-6 Constraints
|
| periodUnit | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.periodUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size A unit of time (units from UCUM). The cardinality or value of this element may be affected by these constraints: tim-2 Constraints
|
| dayOfWeek | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified.
|
| timeOfDay | Σ C | 0..1 | time | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa. The cardinality or value of this element may be affected by these constraints: tim-10 Constraints
|
| when | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Real-world event relating to the schedule. The cardinality or value of this element may be affected by these constraints: tim-9, tim-10 Constraints
|
| offset | Σ C | 0..1 | unsignedInt | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.timing.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal The cardinality or value of this element may be affected by these constraints: tim-9 Constraints
|
| code | Σ | 0..1 | CodeableConceptBinding | Element idMedicationRequest.dosageInstruction.timing.codeShort description Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Code for a known / defined timing pattern. TimingAbbreviation (preferred) Constraints
|
| asNeeded | Σ C | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.asNeededShort description Take "as needed" DefinitionIndicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option). Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. The cardinality or value of this element may be affected by these constraints: dos-1 Constraints
|
| asNeededFor | Σ C | 0..1 | CodeableConcept | Element idMedicationRequest.dosageInstruction.asNeededForShort description Frequency qualifier. Take "as needed" (for x) DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. SNOMEDCTMedicationAsNeededReasonCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: dos-1 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.asNeededFor.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.asNeededFor.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 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. 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 Constraints
|
| coding | Σ C | 0..0 | Coding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.asNeededFor.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.asNeededFor.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| site | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.siteShort description Body site to administer to DefinitionBody site to administer to. A coded specification of the anatomic site where the medication first enters the body. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. A coded concept describing the site location the medicine enters into or onto the body. SNOMEDCTAnatomicalStructureAdministrationSites (example) Constraints
|
| route | Σ | 0..1 | CodeableConcept | Element idMedicationRequest.dosageInstruction.routeShort description Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.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 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. 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 Constraints
|
| coding | Σ C | 1..* | Coding | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.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 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. 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 Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.route.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| method | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.methodShort description Technique for administering medication DefinitionTechnique for administering medication. A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. Terminologies used often pre-coordinate this term with the route and or form of administration. A coded concept describing the technique by which the medicine is administered. SNOMEDCTAdministrationMethodCodes (example) Constraints
|
| doseAndRate | Σ | 0..* | Element | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRateShort description Amount of medication administered, to be administered or typical amount to be administered DefinitionDepending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.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 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. 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 Constraints
|
| type | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.typeShort description The kind of dose or rate specified DefinitionThe kind of dose or rate specified, for example, ordered or calculated. If the type is not populated, assume to be "ordered". Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The kind of dose or rate specified. http://terminology.hl7.org/ValueSet/dose-rate-type (example) Constraints
|
| dose[x] | Σ | 1..1 | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.dose[x]Short description Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
| |
| doseQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
| doseRange | Range | There are no (further) constraints on this element Data type | ||
| rate[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.rate[x]Short description Amount of medication per unit of time DefinitionAmount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
| |
| rateQuantity | SimpleQuantity | There are no (further) constraints on this element Data type | ||
| rateRange | Range | There are no (further) constraints on this element Data type | ||
| rateRatio | Ratio | There are no (further) constraints on this element Data type | ||
| maxDosePerPeriod | Σ C | 0..0 | Ratio | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.maxDosePerPeriodShort description Upper limit on medication per unit of time DefinitionUpper limit on medication per unit of time. The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
|
| maxDosePerAdministration | Σ C | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.maxDosePerAdministrationShort description Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
|
| maxDosePerLifetime | Σ C | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.maxDosePerLifetimeShort description Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
| dispenseRequest | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequestShort description Medication supply authorization DefinitionIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
| |
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| initialFill | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.initialFillShort description First fill details DefinitionIndicates the quantity or duration for the first dispense of the medication. If populating this element, either the quantity or the duration must be included.
| |
| dispenseInterval | C | 0..0 | Duration | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenseIntervalShort description Minimum period of time between dispenses DefinitionThe minimum period of time that must occur between dispenses of the medication. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
| validityPeriod | C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.validityPeriodShort description Time period supply is authorized for DefinitionThis indicates the validity period of a prescription (stale dating the Prescription). Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.
|
| numberOfRepeatsAllowed | 0..0 | unsignedInt | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.numberOfRepeatsAllowedShort description Number of refills authorized DefinitionAn integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense. If displaying "number of authorized fills", add 1 to this number.
| |
| quantity | C | 1..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantityShort description Amount of medication to supply per dispense DefinitionThe amount that is to be dispensed for one fill. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.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 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. 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 Constraints
|
| value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.valueShort description Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
|
| comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.comparatorShort description < | <= | >= | > | ad - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
| unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.unitShort description Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.systemShort description System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.quantity.codeShort description Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. The cardinality or value of this element may be affected by these constraints: qty-3 Constraints
|
| expectedSupplyDuration | C | 0..0 | Duration | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.expectedSupplyDurationShort description Number of days supply per dispense DefinitionIdentifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.
|
| dispenser | C | 0..1 | Reference(Location) | Element idMedicationRequest.dispenseRequest.dispenserShort description Intended performer of dispense DefinitionIndicates the intended performing Organization that will dispense the medication as specified by the prescriber. References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Allowed aggregation:bundled Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.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 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. 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 Constraints
|
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 Constraints
|
| type | Σ | 1..1 | uriBindingFixed Value | Element idMedicationRequest.dispenseRequest.dispenser.typeShort description Type the reference refers to (e.g. "Patient") - must be a resource in resources DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. Aa resource (or, for logical models, the URI of the logical model).
LocationMappings
|
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenser.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. The cardinality or value of this element may be affected by these constraints: ref-2 Constraints
|
| dispenserInstruction | 0..0 | Annotation | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.dispenserInstructionShort description Additional information for the dispenser DefinitionProvides additional information to the dispenser, for example, counselling to be provided to the patient. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
| doseAdministrationAid | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.doseAdministrationAidShort description Type of adherence packaging to use for the dispense DefinitionProvides information about the type of adherence packaging to be supplied for the medication dispense. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| substitution | 0..0 | BackboneElement | There are no (further) constraints on this element Element idMedicationRequest.substitutionShort description Any restrictions on medication substitution DefinitionIndicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
| |
| eventHistory | C | 0..0 | Reference(Provenance) | There are no (further) constraints on this element Element idMedicationRequest.eventHistoryShort description A list of events of interest in the lifecycle DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This might not include provenances for all versions of the request – only those deemed "relevant" or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
|
Successful Response
| Bundle | C | Bundle | There are no (further) constraints on this element Element idBundleShort description Contains a collection of resources DefinitionA container for a collection of resources.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.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. 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. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.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 idBundle.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 its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.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). IETF language tag for a human language
| |
| identifier | Σ C | 1..1 | Identifier | There are no (further) constraints on this element Element idBundle.identifierShort description Persistent identifier for the bundle DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server. Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. The cardinality or value of this element may be affected by these constraints: bdl-9 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.identifier.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 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. 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 Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idBundle.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 0..1 | uriFixed Value | Element idBundle.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/StructureDefinition/profile-bundle-medicationrequestExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 0..1 | string | There are no (further) constraints on this element Element idBundle.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idBundle.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idBundle.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| type | Σ C | 1..1 | codeBindingFixed Value | Element idBundle.typeShort description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification DefinitionIndicates the purpose of this bundle - how it is intended to be used. It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. Indicates the purpose of a bundle - how it is intended to be used. The cardinality or value of this element may be affected by these constraints: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 Constraints
transactionMappings
|
| timestamp | Σ C | 0..0 | instant | There are no (further) constraints on this element Element idBundle.timestampShort description When the bundle was assembled DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage:
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. The cardinality or value of this element may be affected by these constraints: bdl-10 Constraints
|
| total | Σ C | 0..0 | unsignedInt | There are no (further) constraints on this element Element idBundle.totalShort description If search, the total number of matches DefinitionIf a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. The cardinality or value of this element may be affected by these constraints: bdl-1 Constraints
|
| link | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.linkShort description Links related to this Bundle DefinitionA series of links that provide context to this bundle. Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners. The cardinality or value of this element may be affected by these constraints: bdl-18 Constraints
|
| entry | Σ C | 1..* | BackboneElement | Element idBundle.entryShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Unordered, Open, by resource(Profile) Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.resourceShort description A resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Mappings
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
|
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
|
| medicationrequest | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequestShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | MedicationRequest | Element idBundle.entry:medicationrequest.resourceShort description Ordering of medication for patient or group Alternate namesPrescription, Order DefinitionAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.statusShort description Status response code (text optional) DefinitionThe status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.locationShort description The location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.etagShort description The Etag for the resource (if relevant) DefinitionThe Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
|
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.lastModifiedShort description Server's date time modified DefinitionThe date/time that the resource was modified on the server. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
|
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry:medicationrequest.response.outcomeShort description OperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
|
| dispenser | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenserShort description Entry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:dispenser.linkShort description Links related to this entry DefinitionA series of links that provide context to this entry. |
| fullUrl | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:dispenser.fullUrlShort description URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). The cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints
|
| resource | Σ C | 1..1 | Location | Element idBundle.entry:dispenser.resourceShort description Details and position information for a place DefinitionDetails and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.searchShort description Search related information DefinitionInformation about the search process that lead to the creation of this entry. The cardinality or value of this element may be affected by these constraints: bdl-2 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.modeShort description match | include - why this is in the result set DefinitionWhy this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry:dispenser.search.scoreShort description Search ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element.
|
| request | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.requestShort description Additional execution information (transaction/batch/history) DefinitionAdditional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.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 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. 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 Constraints
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.methodShort description GET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size HTTP verbs (in the HTTP command line). See HTTP rfc for details. The cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.urlShort description URL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted). E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifNoneMatchShort description For managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifModifiedSinceShort description For managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifMatchShort description For managing update contention DefinitionOnly perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:dispenser.request.ifNoneExistShort description For conditional creates DefinitionInstruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:dispenser.responseShort description Results of execution (transaction/batch/history) DefinitionIndicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. The cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints
|
| signature | Σ | 0..0 | Signature | There are no (further) constraints on this element Element idBundle.signatureShort description Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSig or a JWS. A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
|
| issues | Σ C | 0..0 | OperationOutcome | There are no (further) constraints on this element Element idBundle.issuesShort description Issues with the Bundle DefinitionCaptures issues and warnings that relate to the construction of the Bundle and the content within it. Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle. The cardinality or value of this element may be affected by these constraints: bdl-16, bdl-17 Constraints
|
Business Level Errors
This section details the business level errors exposed by OperationOutcome resource for this operation. Refer to API Error Handling for framework level errors.
For illustration only
| http status code | code | details.coding.code | details.text |
|---|---|---|---|
| 404 | not-found | E-10000 | No matching patient found based on NRIC, Date of Birth and Gender |
| 404 | not-found | E-10001 | Institution code for ordering organization is not found |
| 404 | not-found | E-10002 | Organization code is not found |
| 400 | business-rule | E-10003 | Patient is not currently enrolled to the organization |
| 400 | duplicate | E-10004 | An attempt was made to create a duplicate record |
| 400 | invalid | E-10005 | Invalid medication code |
| 400 | invalid | E-10006 | Invalid requester identifier |
| 400 | invalid | E-10007 | Invalid encounter reference |
| 400 | business-rule | E-10008 | Medication order date must not be in the future |