DDS-Bundle-1
Bundle | |
Definition | |
Control | 0..* |
Comments | |
Bundle.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
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. Bundles always have an id, though it is usually a generated UUID. |
Bundle.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
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. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | 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 as much as possible. |
Bundle.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
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). |
Bundle.type | |
Definition |
Indicates the purpose of this bundle- how it was intended to be used. |
Control | 1..1 ? |
Binding |
Indicates the purpose of a bundle - how it was intended to be used. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/bundle-type |
Type | Code |
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. |
Bundle.total | |
Definition |
If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle). |
Control | 0..1 ? |
Type | UnsignedInt |
Comments |
Only used if the bundle is a search result set. |
Bundle.link(link) | |
Definition |
A series of links that provide context to this bundle. |
Control | 0..* ? |
Type | BackboneElement |
Comments | |
Bundle.link.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.link.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
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]]. |
Control | 1..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.link.url | |
Definition |
The reference details for the link. |
Control | 1..1 ? |
Type | Uri |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Bundle.entry | |
Definition |
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
Control | 0..* ? |
Type | BackboneElement |
Comments | |
Bundle.entry.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.entry.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Bundle.entry.link | |
Definition |
A series of links that provide context to this entry. |
Control | 0..* |
Type | See link |
Comments | |
Bundle.entry.fullUrl | |
Definition |
The Absolute URL for the resource. This must be provided for all resources. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. |
Control | 0..1 ? |
Type | Uri |
Comments |
fullUrl may 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 absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id. |
Bundle.entry.resource | |
Definition | |
Control | 0..* |
Type | Resource |
Comments | |
Bundle.entry.resource.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
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. Bundles always have an id, though it is usually a generated UUID. |
Bundle.entry.resource.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
Bundle.entry.resource.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. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | 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 as much as possible. |
Bundle.entry.resource.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
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). |
Bundle.entry.search | |
Definition |
Information about the search process that lead to the creation of this entry. |
Control | 0..1 ? |
Type | BackboneElement |
Comments | |
Bundle.entry.search.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.entry.search.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
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. |
Control | 0..1 ? |
Binding |
Why an entry is in the result set - whether it's included as a match or because of an _include requirement. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/search-entry-mode |
Type | Code |
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. |
Bundle.entry.search.score | |
Definition |
When searching, the server's search ranking score for the entry. |
Control | 0..1 ? |
Type | Decimal |
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. |
Bundle.entry.request | |
Definition |
Additional information about how this entry should be processed as part of a transaction. |
Control | 0..1 ? |
Type | BackboneElement |
Comments | |
Bundle.entry.request.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.entry.request.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Bundle.entry.request.method | |
Definition |
The HTTP verb for this entry in either a update history, or a transaction/ transaction response. |
Control | 1..1 ? |
Binding |
HTTP verbs (in the HTTP command line). The codes SHALL be taken from http://hl7.org/fhir/ValueSet/http-verb |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.entry.request.url | |
Definition |
The URL for this entry, relative to the root (the address to which the request is posted). |
Control | 1..1 ? |
Type | Uri |
Comments |
E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]". |
Bundle.entry.request.ifNoneMatch | |
Definition |
If the ETag values match, return a 304 Not modified status. See the API documentation for "Conditional Read". |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.entry.request.ifModifiedSince | |
Definition |
Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". |
Control | 0..1 ? |
Type | Instant |
Comments |
Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required |
Bundle.entry.request.ifMatch | |
Definition |
Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
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". This is just the query portion of the URL - what follows the "?" (not including the "?"). |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.entry.response | |
Definition |
Additional information about how this entry should be processed as part of a transaction. |
Control | 0..1 ? |
Type | BackboneElement |
Comments | |
Bundle.entry.response.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.entry.response.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Bundle.entry.response.status | |
Definition |
The status code returned by processing this entry. |
Control | 1..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.entry.response.location | |
Definition |
The location header created by processing this operation. |
Control | 0..1 ? |
Type | Uri |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Bundle.entry.response.etag | |
Definition |
The etag for the resource, it the operation for the entry produced a versioned resource. |
Control | 0..1 ? |
Type | String |
Comments |
This has to match the version id in the header if a resource is included. |
Bundle.entry.response.lastModified | |
Definition |
The date/time that the resource was modified on the server. |
Control | 0..1 ? |
Type | Instant |
Comments |
This has to match the same time in the meta header if a resource is included. |
Bundle.signature | |
Definition |
Digital Signature - base64 encoded. XML DigSIg or a JWT. |
Control | 0..1 ? |
Type | Signature |
Requirements |
This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may 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. |
Bundle.signature.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.signature.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
Bundle.signature.type | |
Definition |
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. |
Control | 1..* ? |
Binding |
An indication of the reason that an entity signed the object The codes SHOULD be taken from http://hl7.org/fhir/ValueSet/signature-type ; other codes may be used where these codes are not suitable |
Type | Coding |
Comments |
Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication". |
Bundle.signature.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Bundle.signature.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
Bundle.signature.type.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Bundle.signature.type.version | |
Definition |
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 ? |
Type | String |
Comments |
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Bundle.signature.type.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.signature.type.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.signature.type.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments |
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Bundle.signature.when | |
Definition |
When the digital signature was signed. |
Control | 1..1 ? |
Type | Instant |
Comments |
This should agree with the information in the signature. |
Bundle.signature.who[x] | |
Definition |
A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key). |
Control | 1..1 ? |
Type | Choice of: |
Comments |
This should agree with the information in the signature. |
Bundle.signature.contentType | |
Definition |
A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature. |
Control | 1..1 ? |
Binding |
The mime type of an attachment. Any valid mime type is allowed. The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Bundle.signature.blob | |
Definition |
The base64 encoding of the Signature content. |
Control | 1..1 ? |
Type | Base64Binary |
Comments |
Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form. |