Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions

ConceptMap: R4BundleElementMapToR5

Official URL: http://hl7.org/fhir/uv/xver/ConceptMap/R4-Bundle-element-map-to-R5 Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: R4BundleElementMapToR5

This ConceptMap represents cross-version mappings for elements from a FHIR R4 Bundle to FHIR R5.

Mapping from http://hl7.org/fhir/4.0 to http://hl7.org/fhir/5.0


Group 1 Mapping from http://hl7.org/fhir/StructureDefinition/Bundle|4.0.1 to Bundleversion: 5.0.0)

Source CodeRelationshipTarget CodeComment
Bundle.meta (meta)is equivalent toBundle.metaElement `Bundle.meta` is mapped to FHIR R5 element `Bundle.meta` as `Equivalent`.
Bundle.implicitRules (implicitRules)is equivalent toBundle.implicitRulesElement `Bundle.implicitRules` is mapped to FHIR R5 element `Bundle.implicitRules` as `Equivalent`. 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.
Bundle.language (language)is equivalent toBundle.languageElement `Bundle.language` is mapped to FHIR R5 element `Bundle.language` as `Equivalent`. 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).
Bundle.identifier (identifier)is equivalent toBundle.identifierElement `Bundle.identifier` is mapped to FHIR R5 element `Bundle.identifier` as `Equivalent`. 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.
Bundle.type (type)is equivalent toBundle.typeElement `Bundle.type` is mapped to FHIR R5 element `Bundle.type` as `SourceIsNarrowerThanTarget`. The mappings for `Bundle.type` do not allow expression of the necessary codes, per the bindings on the source and target. 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.
Bundle.timestamp (timestamp)is equivalent toBundle.timestampElement `Bundle.timestamp` is mapped to FHIR R5 element `Bundle.timestamp` as `Equivalent`. 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: * 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 * 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 * history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates * 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 * transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning 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.
Bundle.total (total)is equivalent toBundle.totalElement `Bundle.total` is mapped to FHIR R5 element `Bundle.total` as `Equivalent`. 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.
Bundle.link (link)is broader thanBundle.linkElement `Bundle.link` is mapped to FHIR R5 element `Bundle.link` as `Equivalent`. 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)). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](https://hl7.org/fhir/http..html#read) directly. This specification defines some specific uses of Bundle.link for [searching](https://hl7.org/fhir/search.html#.html#conformance) and [paging](https://hl7.org/fhir/http.ht.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.
Bundle.link.relation (relation)is equivalent toBundle.link.relationElement `Bundle.link.relation` is mapped to FHIR R5 element `Bundle.link.relation` as `Equivalent`.
Bundle.link.url (url)is equivalent toBundle.link.urlElement `Bundle.link.url` is mapped to FHIR R5 element `Bundle.link.url` as `Equivalent`.
Bundle.entry (entry)is broader thanBundle.entryElement `Bundle.entry` is mapped to FHIR R5 element `Bundle.entry` as `Equivalent`.
Bundle.entry.link (link)is equivalent toBundle.entry.linkElement `Bundle.entry.link` is mapped to FHIR R5 element `Bundle.entry.link` as `Equivalent`.
Bundle.entry.fullUrl (fullUrl)is equivalent toBundle.entry.fullUrlElement `Bundle.entry.fullUrl` is mapped to FHIR R5 element `Bundle.entry.fullUrl` as `Equivalent`. fullUrl might not be [unique in the context of a resource](https://hl7.org/fhir/bundle.html#bu.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](https://hl7.org/fhir/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](https://hl7.org/fhir/refere.html#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).
Bundle.entry.resource (resource)is equivalent toBundle.entry.resourceElement `Bundle.entry.resource` is mapped to FHIR R5 element `Bundle.entry.resource` as `Equivalent`.
Bundle.entry.search (search)is broader thanBundle.entry.searchElement `Bundle.entry.search` is mapped to FHIR R5 element `Bundle.entry.search` as `Equivalent`.
Bundle.entry.search.mode (mode)is equivalent toBundle.entry.search.modeElement `Bundle.entry.search.mode` is mapped to FHIR R5 element `Bundle.entry.search.mode` as `Equivalent`. 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.
Bundle.entry.search.score (score)is equivalent toBundle.entry.search.scoreElement `Bundle.entry.search.score` is mapped to FHIR R5 element `Bundle.entry.search.score` as `Equivalent`. 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](https://hl7.org/fhir/patient-operation-match.html) for the EMPI search which relates to this element.
Bundle.entry.request (request)is broader thanBundle.entry.requestElement `Bundle.entry.request` is mapped to FHIR R5 element `Bundle.entry.request` as `Equivalent`.
Bundle.entry.request.method (method)is equivalent toBundle.entry.request.methodElement `Bundle.entry.request.method` is mapped to FHIR R5 element `Bundle.entry.request.method` as `Equivalent`.
Bundle.entry.request.url (url)is equivalent toBundle.entry.request.urlElement `Bundle.entry.request.url` is mapped to FHIR R5 element `Bundle.entry.request.url` as `Equivalent`. 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]".
Bundle.entry.request.ifNoneMatch (ifNoneMatch)is equivalent toBundle.entry.request.ifNoneMatchElement `Bundle.entry.request.ifNoneMatch` is mapped to FHIR R5 element `Bundle.entry.request.ifNoneMatch` as `Equivalent`.
Bundle.entry.request.ifModifiedSince (ifModifiedSince)is equivalent toBundle.entry.request.ifModifiedSinceElement `Bundle.entry.request.ifModifiedSince` is mapped to FHIR R5 element `Bundle.entry.request.ifModifiedSince` as `Equivalent`.
Bundle.entry.request.ifMatch (ifMatch)is equivalent toBundle.entry.request.ifMatchElement `Bundle.entry.request.ifMatch` is mapped to FHIR R5 element `Bundle.entry.request.ifMatch` as `Equivalent`.
Bundle.entry.request.ifNoneExist (ifNoneExist)is equivalent toBundle.entry.request.ifNoneExistElement `Bundle.entry.request.ifNoneExist` is mapped to FHIR R5 element `Bundle.entry.request.ifNoneExist` as `Equivalent`.
Bundle.entry.response (response)is broader thanBundle.entry.responseElement `Bundle.entry.response` is mapped to FHIR R5 element `Bundle.entry.response` as `Equivalent`.
Bundle.entry.response.status (status)is equivalent toBundle.entry.response.statusElement `Bundle.entry.response.status` is mapped to FHIR R5 element `Bundle.entry.response.status` as `Equivalent`.
Bundle.entry.response.location (location)is equivalent toBundle.entry.response.locationElement `Bundle.entry.response.location` is mapped to FHIR R5 element `Bundle.entry.response.location` as `Equivalent`.
Bundle.entry.response.etag (etag)is equivalent toBundle.entry.response.etagElement `Bundle.entry.response.etag` is mapped to FHIR R5 element `Bundle.entry.response.etag` as `Equivalent`. Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Bundle.entry.response.lastModified (lastModified)is equivalent toBundle.entry.response.lastModifiedElement `Bundle.entry.response.lastModified` is mapped to FHIR R5 element `Bundle.entry.response.lastModified` as `Equivalent`. This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
Bundle.entry.response.outcome (outcome)is equivalent toBundle.entry.response.outcomeElement `Bundle.entry.response.outcome` is mapped to FHIR R5 element `Bundle.entry.response.outcome` as `Equivalent`. 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 (signature)is equivalent toBundle.signatureElement `Bundle.signature` is mapped to FHIR R5 element `Bundle.signature` as `Equivalent`. 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.