{
"description": "A container for a collection of resources.",
"_filename": "Bundle.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2021-12-31T11:10:15.2517326+00:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2021-12-31T11:12:04.420+00:00"
},
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"fhirVersion": "4.0.1",
"name": "Bundle",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Bundle",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Other"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 5
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "not-classified"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"status": "active",
"id": "e090dd6e-44eb-4153-a77e-7307c92cc798",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/Bundle",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "Bundle",
"path": "Bundle",
"short": "Contains a collection of resources",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "ClinicalDocument, if bundle.type = document",
"identity": "cda"
} ],
"constraint": [ {
"key": "bdl-7",
"human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)",
"xpath": "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()"
}, {
"key": "bdl-9",
"human": "A document must have an identifier with a system and a value",
"xpath": "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())"
}, {
"key": "bdl-3",
"human": "entry.request mandatory for batch/transaction/history, otherwise prohibited",
"xpath": "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))"
}, {
"key": "bdl-4",
"human": "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited",
"xpath": "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))"
}, {
"key": "bdl-12",
"human": "A message must have a MessageHeader as the first resource",
"xpath": "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "type = 'message' implies entry.first().resource.is(MessageHeader)"
}, {
"key": "bdl-1",
"human": "total only when a search or history",
"xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "total.empty() or (type = 'searchset') or (type = 'history')"
}, {
"key": "bdl-2",
"human": "entry.search only when a search",
"xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "entry.search.empty() or (type = 'searchset')"
}, {
"key": "bdl-11",
"human": "A document must have a Composition as the first resource",
"xpath": "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "type = 'document' implies entry.first().resource.is(Composition)"
}, {
"key": "bdl-10",
"human": "A document must have a date",
"xpath": "not(f:type/@value = 'document') or exists(f:timestamp/@value)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "type = 'document' implies (timestamp.hasValue())"
} ],
"definition": "A container for a collection of resources."
}, {
"path": "Bundle.identifier",
"definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.",
"short": "Persistent identifier for the bundle",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "ClinicalDocument.id",
"identity": "cda"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Bundle.identifier",
"comment": "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.",
"isSummary": true
}, {
"path": "Bundle.type",
"min": 1,
"definition": "Indicates the purpose of this bundle - how it is intended to be used.",
"short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BundleType"
} ],
"description": "Indicates the purpose of a bundle - how it is intended to be used."
},
"max": "1",
"id": "Bundle.type",
"comment": "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.",
"isSummary": true
}, {
"path": "Bundle.timestamp",
"definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.",
"short": "When the bundle was assembled",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "ClinicalDocument.effectiveTime",
"identity": "cda"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "Bundle.timestamp",
"comment": "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. \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe 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.",
"isSummary": true
}, {
"path": "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.",
"short": "If search, the total number of matches",
"type": [ {
"code": "unsignedInt"
} ],
"max": "1",
"id": "Bundle.total",
"condition": [ "bdl-1" ],
"comment": "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.",
"isSummary": true
}, {
"id": "Bundle.link",
"path": "Bundle.link",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Links related to this Bundle",
"comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"isSummary": true,
"definition": "A series of links that provide context to this bundle."
}, {
"id": "Bundle.link.relation",
"max": "1",
"min": 1,
"path": "Bundle.link.relation",
"type": [ {
"code": "string"
} ],
"short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"isSummary": true,
"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)."
}, {
"id": "Bundle.link.url",
"max": "1",
"min": 1,
"path": "Bundle.link.url",
"type": [ {
"code": "uri"
} ],
"short": "Reference details for the link",
"isSummary": true,
"definition": "The reference details for the link."
}, {
"id": "Bundle.entry",
"path": "Bundle.entry",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Entry in the bundle - will have a resource or information",
"isSummary": true,
"constraint": [ {
"key": "bdl-8",
"human": "fullUrl cannot be a version specific reference",
"xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "fullUrl.contains('/_history/').not()"
}, {
"key": "bdl-5",
"human": "must be a resource unless there's a request or response",
"xpath": "exists(f:resource) or exists(f:request) or exists(f:response)",
"source": "http://hl7.org/fhir/StructureDefinition/Bundle",
"severity": "error",
"expression": "resource.exists() or request.exists() or response.exists()"
} ],
"definition": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).",
"orderMeaning": "For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type"
}, {
"id": "Bundle.entry.link",
"path": "Bundle.entry.link",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Links related to this Bundle",
"comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.",
"isSummary": true,
"definition": "A series of links that provide context to this bundle."
}, {
"id": "Bundle.entry.link.relation",
"max": "1",
"min": 1,
"path": "Bundle.entry.link.relation",
"type": [ {
"code": "string"
} ],
"short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1",
"isSummary": true,
"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)."
}, {
"id": "Bundle.entry.link.url",
"max": "1",
"min": 1,
"path": "Bundle.entry.link.url",
"type": [ {
"code": "uri"
} ],
"short": "Reference details for the link",
"isSummary": true,
"definition": "The reference details for the link."
}, {
"id": "Bundle.entry.fullUrl",
"max": "1",
"path": "Bundle.entry.fullUrl",
"type": [ {
"code": "uri"
} ],
"short": "URI for resource (Absolute URL server address or URI for UUID/OID)",
"comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), 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](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote 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).",
"isSummary": true,
"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: \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."
}, {
"id": "Bundle.entry.resource",
"max": "1",
"path": "Bundle.entry.resource",
"type": [ {
"code": "Resource"
} ],
"short": "A resource in the bundle",
"isSummary": true,
"definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type."
}, {
"id": "Bundle.entry.search",
"max": "1",
"path": "Bundle.entry.search",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Search related information",
"condition": [ "bdl-2" ],
"isSummary": true,
"definition": "Information about the search process that lead to the creation of this entry."
}, {
"path": "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.",
"short": "match | include | outcome - why this is in the result set",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SearchEntryMode"
} ],
"description": "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."
},
"max": "1",
"id": "Bundle.entry.search.mode",
"comment": "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.",
"isSummary": true
}, {
"id": "Bundle.entry.search.score",
"max": "1",
"path": "Bundle.entry.search.score",
"type": [ {
"code": "decimal"
} ],
"short": "Search ranking (between 0 and 1)",
"comment": "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.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.",
"isSummary": true,
"definition": "When searching, the server's search ranking score for the entry."
}, {
"id": "Bundle.entry.request",
"max": "1",
"path": "Bundle.entry.request",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Additional execution information (transaction/batch/history)",
"condition": [ "bdl-3" ],
"isSummary": true,
"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."
}, {
"path": "Bundle.entry.request.method",
"min": 1,
"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.",
"short": "GET | HEAD | POST | PUT | DELETE | PATCH",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "HTTPVerb"
} ],
"description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details."
},
"max": "1",
"id": "Bundle.entry.request.method",
"isSummary": true
}, {
"path": "Bundle.entry.request.url",
"min": 1,
"definition": "The URL for this entry, relative to the root (the address to which the request is posted).",
"short": "URL for HTTP equivalent of this entry",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Bundle.entry.request.url",
"comment": "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]\".",
"isSummary": true
}, {
"id": "Bundle.entry.request.ifNoneMatch",
"max": "1",
"path": "Bundle.entry.request.ifNoneMatch",
"type": [ {
"code": "string"
} ],
"short": "For managing cache currency",
"isSummary": true,
"definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread)."
}, {
"id": "Bundle.entry.request.ifModifiedSince",
"max": "1",
"path": "Bundle.entry.request.ifModifiedSince",
"type": [ {
"code": "instant"
} ],
"short": "For managing cache currency",
"isSummary": true,
"definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread)."
}, {
"id": "Bundle.entry.request.ifMatch",
"max": "1",
"path": "Bundle.entry.request.ifMatch",
"type": [ {
"code": "string"
} ],
"short": "For managing update contention",
"isSummary": true,
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency)."
}, {
"id": "Bundle.entry.request.ifNoneExist",
"max": "1",
"path": "Bundle.entry.request.ifNoneExist",
"type": [ {
"code": "string"
} ],
"short": "For conditional creates",
"isSummary": true,
"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 \"?\")."
}, {
"id": "Bundle.entry.response",
"max": "1",
"path": "Bundle.entry.response",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Results of execution (transaction/batch/history)",
"condition": [ "bdl-4" ],
"isSummary": true,
"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."
}, {
"id": "Bundle.entry.response.status",
"max": "1",
"min": 1,
"path": "Bundle.entry.response.status",
"type": [ {
"code": "string"
} ],
"short": "Status response code (text optional)",
"isSummary": true,
"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."
}, {
"id": "Bundle.entry.response.location",
"max": "1",
"path": "Bundle.entry.response.location",
"type": [ {
"code": "uri"
} ],
"short": "The location (if the operation returns a location)",
"isSummary": true,
"definition": "The location header created by processing this operation, populated if the operation returns a location."
}, {
"id": "Bundle.entry.response.etag",
"max": "1",
"path": "Bundle.entry.response.etag",
"type": [ {
"code": "string"
} ],
"short": "The Etag for the resource (if relevant)",
"comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.",
"isSummary": true,
"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))."
}, {
"id": "Bundle.entry.response.lastModified",
"max": "1",
"path": "Bundle.entry.response.lastModified",
"type": [ {
"code": "instant"
} ],
"short": "Server's date time modified",
"comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.",
"isSummary": true,
"definition": "The date/time that the resource was modified on the server."
}, {
"id": "Bundle.entry.response.outcome",
"max": "1",
"path": "Bundle.entry.response.outcome",
"type": [ {
"code": "Resource"
} ],
"short": "OperationOutcome with hints and warnings (for batch/transaction)",
"comment": "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.\n\nThis 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.",
"isSummary": true,
"definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction."
}, {
"path": "Bundle.signature",
"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.",
"definition": "Digital Signature - base64 encoded. XML-DSig or a JWT.",
"short": "Digital Signature",
"type": [ {
"code": "Signature"
} ],
"max": "1",
"id": "Bundle.signature",
"comment": "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.",
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Resource"
}