Profil: Batch Request (Bundle)
Fachlicher Kontext
Dieses Profil bündelt mehrere Requests, die als batch von den Systemen des 116117 Terminservices abgearbeitet werden sollen. Das bedeutet, dass ein TVS mehrere Einzel-Requests über ein Batch Request Bundle abbilden und im Rahmen eines batch requests an die Systeme des 116117 Terminservices schicken kann.
Dabei ist Folgendes zu beachten:
Bei einem batch request werden alle Einzel-Requests, die in dem Batch Request Bundle enthalten sind, abgearbeitet. Kommt es bei einem oder mehreren dieser Einzel-Requests zu einem Fehler, werden die anderen Einzel-Requests dennoch verarbeitet.
Aktuell können nur zwei Aktionen als batch ausgeführt werden: Terminslots anlegen und Terminslots löschen
Pro batch request kann nur eine Art von Aktion vorgenommen werden. Das bedeutet, dass in einem batch entweder neue Terminslots angelegt ODER vorhandene Terminslots gelöscht werden können. Sollen sowohl neue Terminslots angelegt als auch vorhandene gelöscht werden, sind zwei separate batch requests erforderlich.
Nach der Verarbeitung eines batch requests kommt ein Batch Response Bundle als Rückgabe-Ressource zurück, in der zu allen Einzel-Requests die jeweiligen Responses enthalten sind.
FHIR-Profil
Name | KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request |
---|---|
Type | Bundle |
Base Definition | http://hl7.org/fhir/StructureDefinition/Bundle (Version: R4) |
Canonical URL | https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request |
Beschreibung |
---|
Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen. |
KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request (Bundle) | I | Bundle | |
id | Σ | 0..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 1..* | canonical(StructureDefinition) |
kvdigitalProfil | Σ | 1..1 | canonical(StructureDefinition)Pattern |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
identifier | Σ | 0..1 | Identifier |
type | S Σ | 1..1 | codeBindingFixed Value |
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 | S | 1..1 | string |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
link | Σ | 0..* | see (link) |
fullUrl | Σ | 0..1 | uri |
resource | S I | 0..1 | KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot |
search | Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
mode | Σ | 0..1 | codeBinding |
score | Σ | 0..1 | decimal |
request | S Σ I | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
method | S Σ | 1..1 | codeBinding |
url | S Σ | 1..1 | uri |
ifNoneMatch | Σ | 0..1 | string |
ifModifiedSince | Σ | 0..1 | instant |
ifMatch | S Σ | 0..1 | string |
ifNoneExist | Σ | 0..1 | string |
response | Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
status | Σ | 1..1 | string |
location | Σ | 0..1 | uri |
etag | Σ | 0..1 | string |
lastModified | Σ | 0..1 | instant |
outcome | Σ | 0..1 | Resource |
signature | Σ | 0..1 | Signature |
Bundle | |
Definition | Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen. |
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 | 1...1 |
Type | Meta |
Summary | True |
Invariants |
|
Bundle.meta.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.meta.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.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Bundle.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
Bundle.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Bundle.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Bundle.meta.profile:kvdigitalProfil | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Pattern | https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request|1.0.0 |
Bundle.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Bundle.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
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 |
|
Fixed Value | batch |
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 | Requests, die nacheinander als batch ausgeführt werden sollen |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Bundle.entry.id | |
Definition | Die vom Anfragenden gesetzte ID eines einzelnen Requests wird in das Batch Response Bundle übernommen, um die Zuordnung zwischen den einzelnen Requests und den zugehörigen Responses der batch interaction zu vereinfachen. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
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 Absolute URL for the resource. 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. 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 |
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 | Diese Ressource beschreibt einen Zeitslot, an dem ein Termin stattfinden kann. |
Cardinality | 0...1 |
Type | KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot |
Must Support | True |
Comments | Der Terminslot darf nur bei einem POST-Request übergeben werden. |
Invariants |
|
Mappings |
|
Bundle.entry.search | |
Definition | Information about the search process that lead to the creation of this entry. |
Cardinality | 0...1 |
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 | Details zu einem einzelnen Request |
Cardinality | 1...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 | 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.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 | Soll ein neuer Slot erstellt werden, muss hier "POST" angegeben. Soll ein bestehender Slot gelöscht werden, muss hier "DELETE" angegeben werden. |
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 | Die relative URL für den Request verweist entweder auf die zu löschende Ressource oder auf den Typ der Ressource, die erstellt werden soll. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Comments | Soll ein neuer Slot erstellt werden, muss hier "Slot" angegeben. Soll ein bestehender Slot gelöscht werden, muss hier "Slot/[id]" angegeben werden. |
Invariants |
|
Examples | create request Slot delete request Slot/b0481afd-281b-4f62-8255-da0af95087xx |
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 | Die Version eines konkreten Terminslots ist im Feld Slot.meta.versionId zu finden. Die Angabe der Version stellt sicher, dass die aktuellste Version des Slots bekannt ist, bevor dieser geändert wird. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Die versionId des Terminslots muss nur bei einem DELETE-Request angegeben werden. |
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 |
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 |
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 |
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 |
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"> <id value="KBV-PR-116117-TERMINSERVICE-TVS-TSYNCH-Bundle-Batch-Request" /> <text> <status value="generated" /> --- We have skipped the narrative for better readability of the resource --- </text> <url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request" /> <version value="1.0.0" /> <name value="KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request" /> <title value="KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request" /> <status value="active" /> <publisher value="kv.digital GmbH" /> <contact> <name value="kv.digital GmbH" /> <telecom> <system value="url" /> <value value="https://www.kv.digital" /> </telecom> </contact> <description value="Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen." /> <copyright value="Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Bundle" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" /> <derivation value="constraint" /> <differential> <element id="Bundle"> <path value="Bundle" /> <short value="Batch Request Bundle" /> <definition value="Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen." /> </element> <element id="Bundle.meta"> <path value="Bundle.meta" /> <min value="1" /> </element> <element id="Bundle.meta.profile"> <path value="Bundle.meta.profile" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> </element> <element id="Bundle.meta.profile:kvdigitalProfil"> <path value="Bundle.meta.profile" /> <sliceName value="kvdigitalProfil" /> <min value="1" /> <max value="1" /> <patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request|1.0.0" /> </element> <element id="Bundle.type"> <path value="Bundle.type" /> <fixedCode value="batch" /> <mustSupport value="true" /> </element> <element id="Bundle.entry"> <path value="Bundle.entry" /> <short value="Requests" /> <definition value="Requests, die nacheinander als batch ausgeführt werden sollen" /> <min value="1" /> <constraint> <key value="resource" /> <severity value="error" /> <human value="resource only for POST requests" /> <expression value="resource.exists() or (request.method = 'DELETE')" /> </constraint> <mustSupport value="true" /> </element> <element id="Bundle.entry.id"> <path value="Bundle.entry.id" /> <short value="ID des Requests" /> <definition value="Die vom Anfragenden gesetzte ID eines einzelnen Requests wird in das Batch Response Bundle übernommen, um die Zuordnung zwischen den einzelnen Requests und den zugehörigen Responses der batch interaction zu vereinfachen." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Bundle.entry.resource"> <path value="Bundle.entry.resource" /> <comment value="Der Terminslot darf nur bei einem POST-Request übergeben werden." /> <type> <code value="Resource" /> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot" /> </type> <mustSupport value="true" /> </element> <element id="Bundle.entry.request"> <path value="Bundle.entry.request" /> <short value="Details zum Request" /> <definition value="Details zu einem einzelnen Request" /> <min value="1" /> <constraint> <key value="regex-1" /> <severity value="error" /> <human value="Enforce format "Slot" for POST requests" /> <expression value="method = 'POST' implies url = 'Slot'" /> </constraint> <constraint> <key value="regex-2" /> <severity value="error" /> <human value="Enforce format "Slot/[uuid]" for DELETE requests" /> <expression value="method = 'DELETE' implies url.matches('Slot/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')" /> </constraint> <constraint> <key value="ifMatch" /> <severity value="error" /> <human value="ifMatch only for DELETE requests" /> <expression value="ifMatch.empty() or (method = 'DELETE')" /> </constraint> <mustSupport value="true" /> </element> <element id="Bundle.entry.request.method"> <path value="Bundle.entry.request.method" /> <short value="POST | DELETE" /> <definition value="Soll ein neuer Slot erstellt werden, muss hier "POST" angegeben.\nSoll ein bestehender Slot gelöscht werden, muss hier "DELETE" angegeben werden." /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Batch_Http_Methods" /> </binding> </element> <element id="Bundle.entry.request.url"> <path value="Bundle.entry.request.url" /> <short value="URL für den Request" /> <definition value="Die relative URL für den Request verweist entweder auf die zu löschende Ressource oder auf den Typ der Ressource, die erstellt werden soll." /> <comment value="Soll ein neuer Slot erstellt werden, muss hier "Slot" angegeben.\nSoll ein bestehender Slot gelöscht werden, muss hier "Slot/[id]" angegeben werden." /> <example> <label value="create request" /> <valueUri value="Slot" /> </example> <example> <label value="delete request" /> <valueUri value="Slot/b0481afd-281b-4f62-8255-da0af95087xx" /> </example> <mustSupport value="true" /> </element> <element id="Bundle.entry.request.ifMatch"> <path value="Bundle.entry.request.ifMatch" /> <short value="Version des Terminslots" /> <definition value="Die Version eines konkreten Terminslots ist im Feld Slot.meta.versionId zu finden. Die Angabe der Version stellt sicher, dass die aktuellste Version des Slots bekannt ist, bevor dieser geändert wird." /> <comment value="Die versionId des Terminslots muss nur bei einem DELETE-Request angegeben werden." /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "KBV-PR-116117-TERMINSERVICE-TVS-TSYNCH-Bundle-Batch-Request", "text": { "status": "generated", --- We have skipped the narrative for better readability of the resource --- }, "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request", "version": "1.0.0", "name": "KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request", "title": "KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request", "status": "active", "publisher": "kv.digital GmbH", "contact": [ { "name": "kv.digital GmbH", "telecom": [ { "system": "url", "value": "https://www.kv.digital" } ] } ], "description": "Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen.", "copyright": "Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Bundle", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle", "derivation": "constraint", "differential": { "element": [ { "id": "Bundle", "path": "Bundle", "short": "Batch Request Bundle", "definition": "Das Bundle stellt die Möglichkeit zur Verfügung, mehrere Terminslots über einen Request zu löschen oder anzulegen." }, { "id": "Bundle.meta", "path": "Bundle.meta", "min": 1 }, { "id": "Bundle.meta.profile", "path": "Bundle.meta.profile", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1 }, { "id": "Bundle.meta.profile:kvdigitalProfil", "path": "Bundle.meta.profile", "sliceName": "kvdigitalProfil", "min": 1, "max": "1", "patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request|1.0.0" }, { "id": "Bundle.type", "path": "Bundle.type", "fixedCode": "batch", "mustSupport": true }, { "id": "Bundle.entry", "path": "Bundle.entry", "short": "Requests", "definition": "Requests, die nacheinander als batch ausgeführt werden sollen", "min": 1, "constraint": [ { "key": "resource", "severity": "error", "human": "resource only for POST requests", "expression": "resource.exists() or (request.method = 'DELETE')" } ], "mustSupport": true }, { "id": "Bundle.entry.id", "path": "Bundle.entry.id", "short": "ID des Requests", "definition": "Die vom Anfragenden gesetzte ID eines einzelnen Requests wird in das Batch Response Bundle übernommen, um die Zuordnung zwischen den einzelnen Requests und den zugehörigen Responses der batch interaction zu vereinfachen.", "min": 1, "mustSupport": true }, { "id": "Bundle.entry.resource", "path": "Bundle.entry.resource", "comment": "Der Terminslot darf nur bei einem POST-Request übergeben werden.", "type": [ { "code": "Resource", "profile": [ "https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot" ] } ], "mustSupport": true }, { "id": "Bundle.entry.request", "path": "Bundle.entry.request", "short": "Details zum Request", "definition": "Details zu einem einzelnen Request", "min": 1, "constraint": [ { "key": "regex-1", "severity": "error", "human": "Enforce format \"Slot\" for POST requests", "expression": "method = 'POST' implies url = 'Slot'" }, { "key": "regex-2", "severity": "error", "human": "Enforce format \"Slot/[uuid]\" for DELETE requests", "expression": "method = 'DELETE' implies url.matches('Slot/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')" }, { "key": "ifMatch", "severity": "error", "human": "ifMatch only for DELETE requests", "expression": "ifMatch.empty() or (method = 'DELETE')" } ], "mustSupport": true }, { "id": "Bundle.entry.request.method", "path": "Bundle.entry.request.method", "short": "POST | DELETE", "definition": "Soll ein neuer Slot erstellt werden, muss hier \"POST\" angegeben.\nSoll ein bestehender Slot gelöscht werden, muss hier \"DELETE\" angegeben werden.", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Batch_Http_Methods" } }, { "id": "Bundle.entry.request.url", "path": "Bundle.entry.request.url", "short": "URL für den Request", "definition": "Die relative URL für den Request verweist entweder auf die zu löschende Ressource oder auf den Typ der Ressource, die erstellt werden soll.", "comment": "Soll ein neuer Slot erstellt werden, muss hier \"Slot\" angegeben.\nSoll ein bestehender Slot gelöscht werden, muss hier \"Slot/[id]\" angegeben werden.", "example": [ { "label": "create request", "valueUri": "Slot" }, { "label": "delete request", "valueUri": "Slot/b0481afd-281b-4f62-8255-da0af95087xx" } ], "mustSupport": true }, { "id": "Bundle.entry.request.ifMatch", "path": "Bundle.entry.request.ifMatch", "short": "Version des Terminslots", "definition": "Die Version eines konkreten Terminslots ist im Feld Slot.meta.versionId zu finden. Die Angabe der Version stellt sicher, dass die aktuellste Version des Slots bekannt ist, bevor dieser geändert wird.", "comment": "Die versionId des Terminslots muss nur bei einem DELETE-Request angegeben werden.", "mustSupport": true } ] } }
Anmerkungen
In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.
Feld | Anmerkung |
---|---|
Bundle.type |
Dieses Feld wird durch das Basis-Profil mit einer Kardinalität von 1..1 erzwungen und enthält immer den Wert batch aus dem ValueSet BundleType, da dies der einzig zutreffende Wert aus dem genannten ValueSet ist. |
Bundle.entry |
Dieses Feld muss alle Requests enthalten, die als batch abgearbeitet werden sollen. |
Bundle.entry.id |
Dieses Feld muss eine ID enthalten, die vom Anfragenden selbst definiert werden kann. Die ID soll die Zuordnung des Einzel-Requests zu der zugehörigen Response aus dem Batch Response Bundle vereinfachen. Weitere Details hierzu sind unter Profil: Batch Response (Bundle) zu finden. Bitte beachten: Die ID wird NICHT als Slot-ID übernommen, wenn es sich um einen POST-Request zum Anlegen eines Terminslots handelt. |
Bundle.entry.resource |
Dieses Feld muss bei einem POST-Request den Terminslot enthalten, der im 116117 Terminservice erstellt werden soll. |
Bundle.entry.request.method |
Dieses Feld muss die gewünschte HTTP-Aktion enthalten, die für den Terminslot ausgeführt werden soll. Bitte beachten: In einem Batch Request Bundle dürfen nur gleiche Aktionen vorhanden sein – also nur POST-Requests oder nur DELETE-Requests. Sollen neue Terminslots erstellt und vorhandene Terminslots gelöscht werden, sind zwei separate Requests notwendig. |
Bundle.entry.request.url |
Der Wert des Feldes hängt von der HTTP-Aktion ab:
|
Bundle.entry.request.ifMatch |
Dieses Feld muss bei DELETE-Requests befüllt sein und die Versionsnummer des zu löschenden Terminslots enthalten. Bei POST-Requests darf dieses Feld NICHT befüllt sein. |
Folgende (mit einem Must-Support-Flag gekennzeichnete) Elemente werden von den Systemen des 116117 Terminservices gespeichert, verarbeitet und zurückgegeben:
type
entry.id
entry.resource
entry.request
entry.request.method
entry.request.url
entry.request.ifMatch
Terminology Bindings
Folgende Terminologien sind abweichend vom Basisprofil definiert:
Feld | Bindungsgrad | ValueSet |
---|---|---|
Bundle.entry.request.method | required | https://fhir.kbv.de/ValueSet/KBV_VS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Batch_Http_Methods |
Operationen & Interaktionen
Folgende Operationen und Interaktionen haben diese Ressource als Eingabewert:
Beispiele
Alle Beispiele sind hier im vorliegenden Projekt und auch auf den jeweiligen Unterseiten zu den FHIR-Operationen und -Interaktionen zu finden.
<Bundle xmlns="http://hl7.org/fhir"> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request|1.0.0" /> </meta> <type value="batch" /> <timestamp value="2024-01-09T08:21:43+02:00" /> <entry id="8d62d98e-febf-4991-afc7-bff77d8b855c"> <resource> <Slot> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot|1.0.0" /> </meta> <text> <status value="extensions" /> <div xmlns="http://www.w3.org/1999/xhtml">Diese Slot-Instanz enthält einen Terminslot am 27.01.2024, von 10:15 bis 10:30 Uhr.</div> </text> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="50811001" /> <display value="Routine" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="103391001" /> <display value="Urgent" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="709122007" /> <display value="As soon as possible" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <version value="1.0.0" /> <code value="Praxis" /> <display value="Praxis" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <version value="1.0.0" /> <code value="TSS" /> <display value="Terminservicestellen" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <version value="1.0.0" /> <code value="Dritte" /> <display value="Anwendungen von Drittanbietern" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Foreign_Languages_For_Diagnostic_Outcome"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" /> <code value="83" /> <display value="Thai (Thailand)" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Foreign_Languages_For_Diagnostic_Outcome"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" /> <code value="107" /> <display value="Schottisch-Gälisch" /> </valueCoding> </extension> <serviceCategory> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> <code value="VR" /> <display value="virtual" /> </coding> </serviceCategory> <serviceType> <coding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAS_FACHGEBIET_GROB" /> <code value="09" /> <display value="Kinderarzt / Kinderärztin" /> </coding> </serviceType> <serviceType> <coding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_WBO" /> <code value="341" /> <display value="FÄ/FA Kinder- und Jugendmedizin" /> </coding> </serviceType> <schedule> <reference value="urn:uuid:3b6b4224-8ba0-4e8a-8dae-6f0a772d5cb4" /> </schedule> <status value="free" /> <start value="2024-01-27T10:15:00+01:00" /> <end value="2024-01-27T10:30:00+01:00" /> </Slot> </resource> <request> <method value="POST" /> <url value="Slot" /> </request> </entry> <entry id="170dd05b-ee67-4a94-b561-28cd4b4f5c5d"> <resource> <Slot> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot|1.0.0" /> </meta> <text> <status value="extensions" /> <div xmlns="http://www.w3.org/1999/xhtml">Diese Slot-Instanz enthält einen freien Terminslot am 01.05.2024, von 10:00 bis 10:45 Uhr.</div> </text> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="709122007" /> <display value="As soon as possible" /> </valueCoding> </extension> <serviceCategory> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> <code value="AMB" /> <display value="ambulatory" /> </coding> </serviceCategory> <schedule> <reference value="urn:uuid:1b8e277f-c971-433b-a22b-91a16eba9f2d" /> </schedule> <status value="free" /> <start value="2024-05-01T10:00:00+01:00" /> <end value="2024-05-01T10:45:00+01:00" /> </Slot> </resource> <request> <method value="POST" /> <url value="Slot" /> </request> </entry> <entry id="8f41841c-c21a-45a3-a031-6d85d0a016de"> <resource> <Slot> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot|1.0.0" /> </meta> <text> <status value="extensions" /> <div xmlns="http://www.w3.org/1999/xhtml">Diese Slot-Instanz enthält einen Terminslot am 27.01.2024, von 10:15 bis 10:30 Uhr.</div> </text> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="50811001" /> <display value="Routine" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Urgency"> <valueCoding> <system value="http://snomed.info/sct" /> <code value="103391001" /> <display value="Urgent" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <version value="1.0.0" /> <code value="Patient" /> <display value="Patient" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <code value="Praxis" /> <display value="Praxis" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Slot_Bookable_Through"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Roles" /> <code value="TSS" /> <display value="Terminservicestellen" /> </valueCoding> </extension> <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Foreign_Languages_For_Diagnostic_Outcome"> <valueCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" /> <code value="83" /> <display value="Thai (Thailand)" /> </valueCoding> </extension> <serviceCategory> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" /> <code value="VR" /> <display value="virtual" /> </coding> </serviceCategory> <serviceType> <coding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAS_FACHGEBIET_GROB" /> <code value="09" /> <display value="Kinderarzt / Kinderärztin" /> </coding> </serviceType> <schedule> <reference value="urn:uuid:3b6b4224-8ba0-4e8a-8dae-6f0a772d5cb4" /> </schedule> <status value="free" /> <start value="2024-01-27T10:15:00+01:00" /> <end value="2024-01-27T10:30:00+01:00" /> </Slot> </resource> <request> <method value="POST" /> <url value="Slot" /> </request> </entry> </Bundle>
<Bundle xmlns="http://hl7.org/fhir"> <meta> <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_116117_TERMINSERVICE_TVS_TERMINSYNCHRONISATION_Bundle_Batch_Request|1.0.0" /> </meta> <type value="batch" /> <timestamp value="2024-05-20T12:54:06+02:00" /> <entry id="8f41841c-c21a-45a3-a031-6d85d0a016de"> <request> <method value="DELETE" /> <url value="Slot/66f913bd-14e7-4114-b515-165374d3f963" /> <ifMatch value="2" /> </request> </entry> <entry id="34adedea-b115-4a7f-bd40-e178fa4e269a"> <request> <method value="DELETE" /> <url value="Slot/182233cb-c232-441d-a0ee-d4c9d234fd38" /> <ifMatch value="1" /> </request> </entry> <entry id="170dd05b-ee67-4a94-b561-28cd4b4f5c5d"> <request> <method value="DELETE" /> <url value="Slot/e448d2a1-12b2-4a26-85e2-289f7b9d15d4" /> <ifMatch value="5" /> </request> </entry> <entry id="e18e8628-b0dc-484d-9dae-288e347130f2"> <request> <method value="DELETE" /> <url value="Slot/b0481afd-281b-4f62-8255-da0af950876f" /> <ifMatch value="2" /> </request> </entry> </Bundle>