Page Status: updated 2022-11-24
NLLPrescriptionBundle (Bundle)
Page index
Introduction
The profile NLLPrescriptionBundle is used when managing multiple medication requests in one transaction. The currently supported scenarios are related to certain situations when managing parallell prescriptions. See VR178 in Handbok för vård och apoteksaktörer - Nationella läkemedelslistan - Generella verksamhetsregler for details about conditions that apply when using bundles for managing parallell prescriptions.
More information about parallell prescriptions can be found in Handbok för vård och apoteksaktörer - Nationella läkemedelslistan and short description is available in this implementation guide on the page describing MedicationRequest MedicationRequest
In this use case the endpoint is [base]
and not [base]/Bundle
.
Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources
Overview
NLLPrescriptionBundle (Bundle) | I | Bundle | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
identifier | Σ | 0..1 | Identifier |
type | S Σ | 1..1 | codeBinding |
timestamp | Σ | 0..1 | instant |
total | Σ I | 0..1 | unsignedInt |
link | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
relation | Σ | 1..1 | string |
url | Σ | 1..1 | uri |
entry | S Σ I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
link | Σ | 0..* | see (link) |
fullUrl | S Σ | 0..1 | uri |
resource | S I | 1..1 | NLLMedicationRequest |
search | Σ I | 0..0 | BackboneElement |
request | S Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 1..* | Extension |
nllProvenanceDetails | I | 1..1 | Extension(Complex) |
id | 0..1 | string | |
extension | I | 2..* | Extension |
reason | S I | 1..1 | ExtensionBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
activity | S I | 1..1 | ExtensionBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueCodeableConcept | CodeableConcept | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
url | 1..1 | uriFixed Value | |
value[x] | 0..0 | ||
modifierExtension | Σ ?! I | 0..* | Extension |
method | S Σ | 1..1 | codeBinding |
url | S Σ | 1..1 | uri |
ifNoneMatch | Σ | 0..1 | string |
ifModifiedSince | Σ | 0..1 | instant |
ifMatch | Σ | 0..1 | string |
ifNoneExist | Σ | 0..1 | string |
response | S Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
status | S Σ | 1..1 | string |
location | S Σ | 0..1 | uri |
etag | Σ | 0..1 | string |
lastModified | Σ | 0..1 | instant |
outcome | S Σ | 0..1 | Resource |
signature | Σ | 0..1 | Signature |
Bundle | |
Definition | A container for a collection of resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Bundle.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Bundle.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Bundle.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Bundle.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Bundle.identifier | |
Definition | A persistent identifier for the bundle that won't change as a bundle is copied from server to server. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.type | |
Definition | Indicates the purpose of this bundle - how it is intended to be used. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates the purpose of a bundle - how it is intended to be used. |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.timestamp | |
Definition | The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.total | |
Definition | If a set of search matches, this is the 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. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Comments | 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. |
Invariants |
|
Bundle.link | |
Definition | A series of links that provide context to this bundle. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | 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. |
Invariants |
|
Bundle.link.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.link.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.link.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.link.relation | |
Definition | A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.link.url | |
Definition | The reference details for the link. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Invariants |
|
Bundle.entry | |
Definition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.link | |
Definition | A series of links that provide context to this entry. |
Cardinality | 0...* |
Type | see (link) |
Summary | True |
Invariants |
|
Bundle.entry.fullUrl | |
Definition | The National Medication List uses fullUrl in the form of the urn:uuid of the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Comments | 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). |
Invariants |
|
Bundle.entry.resource | |
Definition | MedicationRequest in the National Swedish Medication List is used for prescriptions for a patient. A prescription can be made for either a medicine package or for a reimbursed consumable. |
Cardinality | 1...1 |
Type | NLLMedicationRequest |
Must Support | True |
Alias | Prescription, Order |
Invariants |
|
Mappings |
|
Bundle.entry.search | |
Definition | Information about the search process that lead to the creation of this entry. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Bundle.entry.search.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.search.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.search.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.search.mode | |
Definition | Why 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. |
Cardinality | 0...1 |
Type | code |
Binding | 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. |
Summary | True |
Comments | 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. |
Invariants |
|
Bundle.entry.search.score | |
Definition | When searching, the server's search ranking score for the entry. |
Cardinality | 0...1 |
Type | decimal |
Summary | True |
Comments | 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. |
Invariants |
|
Bundle.entry.request | |
Definition | Additional 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. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.request.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails | |
Definition | Provenance details for a resource. |
Cardinality | 1...1 |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason | |
Definition | The Provenance reason for the resource. |
Cardinality | 1...1 |
Type | Extension |
Binding | http://electronichealth.se/fhir/ValueSet/nll-reason-for-provenance (required) |
Must Support | True |
Alias | extensions, user content |
Comments | |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | reason |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:reason.value[x].text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity | |
Definition | The Provenance activity for the resource. |
Cardinality | 1...1 |
Type | Extension |
Binding | provenance-activity-types (required) |
Must Support | True |
Alias | extensions, user content |
Comments | |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | activity |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.extension:activity.value[x].text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | 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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLProvenanceDetails |
Mappings |
|
Bundle.entry.request.extension:nllProvenanceDetails.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Bundle.entry.request.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.request.method | |
Definition | In 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. |
Cardinality | 1...1 |
Type | code |
Binding | HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.request.url | |
Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Comments | 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]". |
Invariants |
|
Bundle.entry.request.ifNoneMatch | |
Definition | If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.request.ifModifiedSince | |
Definition | Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread). |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Invariants |
|
Bundle.entry.request.ifMatch | |
Definition | Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.request.ifNoneExist | |
Definition | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?"). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Bundle.entry.response | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.response.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Bundle.entry.response.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.response.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Bundle.entry.response.status | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.response.location | |
Definition | The location header created by processing this operation, populated if the operation returns a location. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.response.etag | |
Definition | The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. |
Invariants |
|
Bundle.entry.response.lastModified | |
Definition | The date/time that the resource was modified on the server. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. |
Invariants |
|
Bundle.entry.response.outcome | |
Definition | An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. |
Cardinality | 0...1 |
Type | Resource |
Must Support | True |
Summary | True |
Comments | 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. |
Bundle.signature | |
Definition | Digital Signature - base64 encoded. XML-DSig or a JWT. |
Cardinality | 0...1 |
Type | Signature |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="https://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionBundle" /> <version value="1.0.1" /> <name value="NLLPrescriptionBundle" /> <status value="active" /> <date value="2024-04-10" /> <publisher value="Swedish eHealth Agency" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="EHM" /> <name value="E-hälsomyndigheten concept" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Bundle" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" /> <derivation value="constraint" /> <differential> <element id="Bundle.type"> <path value="Bundle.type" /> <short value="transaction | transaction-response" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/ValueSet/transaction-bundle-types" /> </binding> </element> <element id="Bundle.entry"> <path value="Bundle.entry" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.fullUrl"> <path value="Bundle.entry.fullUrl" /> <short value="URI for resource, UUID" /> <definition value="The National Medication List uses fullUrl in the form of the urn:uuid of the resource.\nThe fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified." /> <mustSupport value="true" /> </element> <element id="Bundle.entry.resource"> <path value="Bundle.entry.resource" /> <min value="1" /> <type> <code value="Resource" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLMedicationRequest" /> </type> <mustSupport value="true" /> </element> <element id="Bundle.entry.search"> <path value="Bundle.entry.search" /> <max value="0" /> </element> <element id="Bundle.entry.request"> <path value="Bundle.entry.request" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.request.extension"> <path value="Bundle.entry.request.extension" /> <min value="1" /> </element> <element id="Bundle.entry.request.extension:nllProvenanceDetails"> <path value="Bundle.entry.request.extension" /> <sliceName value="nllProvenanceDetails" /> <min value="1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://electronichealth.se/fhir/StructureDefinition/NLLProvenanceDetails" /> </type> <isModifier value="false" /> </element> <element id="Bundle.entry.request.extension:nllProvenanceDetails.extension"> <path value="Bundle.entry.request.extension.extension" /> <min value="2" /> </element> <element id="Bundle.entry.request.extension:nllProvenanceDetails.extension:reason"> <path value="Bundle.entry.request.extension.extension" /> <sliceName value="reason" /> <comment value="-" /> <min value="1" /> </element> <element id="Bundle.entry.request.extension:nllProvenanceDetails.extension:activity"> <path value="Bundle.entry.request.extension.extension" /> <sliceName value="activity" /> <comment value="-" /> </element> <element id="Bundle.entry.request.method"> <path value="Bundle.entry.request.method" /> <short value="POST | PUT" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://electronichealth.se/fhir/ValueSet/transaction-operations" /> </binding> </element> <element id="Bundle.entry.request.url"> <path value="Bundle.entry.request.url" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.response"> <path value="Bundle.entry.response" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.response.status"> <path value="Bundle.entry.response.status" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.response.location"> <path value="Bundle.entry.response.location" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.response.outcome"> <path value="Bundle.entry.response.outcome" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "https://electronichealth.se/fhir/StructureDefinition/NLLPrescriptionBundle", "version": "1.0.1", "name": "NLLPrescriptionBundle", "status": "active", "date": "2024-04-10", "publisher": "Swedish eHealth Agency", "fhirVersion": "4.0.1", "mapping": [ { "identity": "EHM", "name": "E-hälsomyndigheten concept" } ], "kind": "resource", "abstract": false, "type": "Bundle", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle", "derivation": "constraint", "differential": { "element": [ { "id": "Bundle.type", "path": "Bundle.type", "short": "transaction | transaction-response", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/ValueSet/transaction-bundle-types" } }, { "id": "Bundle.entry", "path": "Bundle.entry", "min": 1, "mustSupport": true }, { "id": "Bundle.entry.fullUrl", "path": "Bundle.entry.fullUrl", "short": "URI for resource, UUID", "definition": "The National Medication List uses fullUrl in the form of the urn:uuid of the resource.\nThe fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "mustSupport": true }, { "id": "Bundle.entry.resource", "path": "Bundle.entry.resource", "min": 1, "type": [ { "code": "Resource", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLMedicationRequest" ] } ], "mustSupport": true }, { "id": "Bundle.entry.search", "path": "Bundle.entry.search", "max": "0" }, { "id": "Bundle.entry.request", "path": "Bundle.entry.request", "mustSupport": true }, { "id": "Bundle.entry.request.extension", "path": "Bundle.entry.request.extension", "min": 1 }, { "id": "Bundle.entry.request.extension:nllProvenanceDetails", "path": "Bundle.entry.request.extension", "sliceName": "nllProvenanceDetails", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLProvenanceDetails" ] } ], "isModifier": false }, { "id": "Bundle.entry.request.extension:nllProvenanceDetails.extension", "path": "Bundle.entry.request.extension.extension", "min": 2 }, { "id": "Bundle.entry.request.extension:nllProvenanceDetails.extension:reason", "path": "Bundle.entry.request.extension.extension", "sliceName": "reason", "comment": "-", "min": 1 }, { "id": "Bundle.entry.request.extension:nllProvenanceDetails.extension:activity", "path": "Bundle.entry.request.extension.extension", "sliceName": "activity", "comment": "-" }, { "id": "Bundle.entry.request.method", "path": "Bundle.entry.request.method", "short": "POST | PUT", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://electronichealth.se/fhir/ValueSet/transaction-operations" } }, { "id": "Bundle.entry.request.url", "path": "Bundle.entry.request.url", "mustSupport": true }, { "id": "Bundle.entry.response", "path": "Bundle.entry.response", "mustSupport": true }, { "id": "Bundle.entry.response.status", "path": "Bundle.entry.response.status", "mustSupport": true }, { "id": "Bundle.entry.response.location", "path": "Bundle.entry.response.location", "mustSupport": true }, { "id": "Bundle.entry.response.outcome", "path": "Bundle.entry.response.outcome", "mustSupport": true } ] } }
Bundle | .. | |
Bundle.type | .. | |
Bundle.entry | 1.. | |
Bundle.entry.fullUrl | .. | |
Bundle.entry.resource | NLLMedicationRequest | 1.. |
Bundle.entry.search | ..0 | |
Bundle.entry.request | .. | |
Bundle.entry.request.extension | 1.. | |
Bundle.entry.request.extension | Extension | 1..1 |
Bundle.entry.request.extension.extension | 2.. | |
Bundle.entry.request.extension.extension | 1.. | |
Bundle.entry.request.extension.extension | .. | |
Bundle.entry.request.method | .. | |
Bundle.entry.request.url | .. | |
Bundle.entry.response | .. | |
Bundle.entry.response.status | .. | |
Bundle.entry.response.location | .. | |
Bundle.entry.response.outcome | .. |
Details
Description of all elements can be found here, Element descriptions.
Provenance details, reason and activity
The updated prescriptions may be updated due to separate activities and for separate resaons. Therefore this data, which usually is provided in the header x-provenance, is now sent per prescription within the bundle. This is done on the extension Bundle.entry.request.extension:nllProvenanceDetails NLLProvenanceDetails which gives the possibility to provide a unique "reason" and "activity" for each MedicationRequest in the request.
Error handling
If an error is detected on one of the medication request resources in the bundle the whole set of medication requests are rejected with an HTTP status of 4xx. The returned OperationOutcome will contain information about the detected issues and errors.
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
POST | yes | See comment below |
A new medication request is created by setting entry.request.method to POST. An existing medication request is updated by setting entry.request.method to PUT.
The result is eighter a Bundle of type transaction-response with one entry per entry in the incoming Bundle or an OperationOutcome if the request was rejected.
When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.
Query operations
Search is not supported for this resource.