Profile: ITK-Document-Bundle-1
Bundle | I | Bundle | |
identifier | Σ | 1..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
coding | Σ | 0..* | Coding |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 0..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(CareConnect-Organization-1) |
reference | Σ I | 1..1 | string |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
type | Σ | 1..1 | codeBindingFixed Value |
total | Σ I | 0..0 | unsignedInt |
link | Σ | 0..0 | BackboneElement |
entry | Σ I | 1..* | BackboneElement |
link | Σ | 0..0 | see (link) |
fullUrl | Σ | 0..1 | uri |
resource | Σ | 1..1 | Resource |
search | Σ I | 0..0 | BackboneElement |
request | Σ I | 0..0 | BackboneElement |
response | Σ I | 0..0 | BackboneElement |
signature | Σ | 0..0 | Signature |
Bundle | |
Definition | A container for a collection of resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Bundle.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
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. |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Invariants |
|
Mappings |
|
Bundle.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. Common Languages (extensible) |
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 |
|
Mappings |
|
Bundle.identifier | |
Definition | A persistent identifier for the batch that won't change as a batch is copied from server to server. |
Cardinality | 1...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.identifier.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.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. |
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.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . IdentifierUse (required) |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Bundle.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.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. |
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.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.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. |
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.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Bundle.identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Bundle.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient General https://tools.ietf.org/html/rfc4122, if the identifier.value is a UUID |
Mappings |
|
Bundle.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Invariants |
|
Examples | General 123456 General 27dca674-d5a7-4184-b1d8-372ea339cbc9 |
Mappings |
|
Bundle.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(CareConnect-Organization-1) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner.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. |
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.identifier.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Invariants |
|
Mappings |
|
Bundle.identifier.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Bundle.type | |
Definition | Indicates the purpose of this bundle - how it was intended to be used. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates the purpose of a bundle - how it was intended to be used. BundleType (required) |
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 | document |
Mappings |
|
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). |
Cardinality | 0...0 |
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 |
|
Mappings |
|
Bundle.link | |
Definition | A series of links that provide context to this bundle. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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. |
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.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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | 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. |
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.link.url | |
Definition | The reference details for the link. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Bundle.entry | |
Definition | An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Bundle.entry.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.link | |
Definition | A series of links that provide context to this entry. |
Cardinality | 0...0 |
Type | see (link) |
Summary | True |
Bundle.entry.fullUrl | |
Definition | The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. 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 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. |
Invariants |
|
Mappings |
|
Bundle.entry.resource | |
Definition | The Resources for the entry. |
Cardinality | 1...1 |
Type | Resource |
Summary | True |
Mappings |
|
Bundle.entry.search | |
Definition | Information about the search process that lead to the creation of this entry. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | 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. |
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. |
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. SearchEntryMode (required) |
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 |
|
Mappings |
|
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. |
Invariants |
|
Mappings |
|
Bundle.entry.request | |
Definition | Additional information about how this entry should be processed as part of a transaction. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.request.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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | 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. |
Invariants |
|
Mappings |
|
Bundle.entry.request.method | |
Definition | The HTTP verb for this entry in either a change history, or a transaction/ transaction response. |
Cardinality | 1...1 |
Type | code |
Binding | HTTP verbs (in the HTTP command line). HTTPVerb (required) |
Summary | True |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.entry.request.url | |
Definition | The URL for this entry, relative to the root (the address to which the request is posted). |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Comments | E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT, and the URL would be "Patient/[id]". |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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 |
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 |
Invariants |
|
Mappings |
|
Bundle.entry.request.ifMatch | |
Definition | Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.entry.response | |
Definition | Additional information about how this entry should be processed as part of a transaction. |
Cardinality | 0...0 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Bundle.entry.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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | 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. |
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
Bundle.entry.response.location | |
Definition | The location header created by processing this operation. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Bundle.entry.response.etag | |
Definition | The etag for the resource, it 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 |
|
Mappings |
|
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 if a resource is included. |
Invariants |
|
Mappings |
|
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. |
Mappings |
|
Bundle.signature | |
Definition | Digital Signature - base64 encoded. XML-DSIg or a JWT. |
Cardinality | 0...0 |
Type | Signature |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Elements required for capability
Element | Use | CareConnect | UK Core |
---|---|---|---|
id | |||
meta.lastUpdated | |||
identifier | |||
type | |||
entry (CareConnect-GPC-Composition-1) | |||
entry (CareConnect-GPC-Patient-1) | |||
entry (CareConnect-GPC-Organization-1) | |||
entry (CareConnect-GPC-Practitioner-1) | |||
entry (CareConnect-GPC-PractitionerRole-1) | |||
entry (CareConnect-GPC-Encounter-1) | |||
entry (CareConnect-GPC-MedicationDispense-1) | |||
entry (CareConnect-GPC-Observation-1) | |||
entry (ClinicalImpression) | |||
entry (CareConnect-GPC-Condition-1) | |||
entry (CareConnect-Flag-1) |
id
Usage
Optional
Guidance
The id
is the logical identifier for the ITK-Document-Bundle-1
profile.
Example
<id value="28920226-5aba-11ed-9b6a-0242ac120002" />
meta.lastUpdated
Usage
Optional
document
which states this value must be populated. See https://www.hl7.org/fhir/STU3/documents.html for more information.
Example
<meta> <lastUpdated value="2023-08-02T13:42:00+00:00" /> </meta>
identifier
Usage
Mandatory
Guidance
The identifier
MUST be present and unique for each message.
Example
<identifier> <system value="https://tools.ietf.org/html/rfc4122" /> <value value="73c52d0f-8584-43fe-b492-3a4d3017ac22" /> </identifier>
type
Usage
Mandatory
Guidance
The type
MUST have a fixed value of document
, from the BundleType
valueset.
Example
<type value="document" />
entry
entry
elements which are outlined below.
entry (CareConnect-Composition-1)
Usage
Mandatory
Guidance
The entry
MUST contain a Composition
resource profiled to the CareConnect-Composition-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-Composition-1
entry (CareConnect-GPC-Patient-1)
Usage
Mandatory
Guidance
The entry
MUST contain a Patient
resource profiled to the CareConnect-GPC-Patient-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Patient-1
entry (CareConnect-GPC-Practitioner-1)
Usage
Mandatory
Guidance
The entry
MUST contain a Practitioner
resource profiled to the CareConnect-GPC-Practitioner-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Practitioner-1
entry (CareConnect-GPC-PractitionerRole-1)
Usage
Mandatory
Guidance
The entry
MAY contain a PractitionerRole
resource profiled to the CareConnect-GPC-PractitionerRole-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-PractitionerRole-1
entry (CareConnect-GPC-Organization-1)
Usage
Mandatory
Guidance
The entry
MUST contain a Organization
resource profiled to the CareConnect-GPC-Organization-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Organization-1
entry (CareConnect-GPC-Encounter-1)
Usage
Mandatory
Guidance
The entry
MUST contain a entry profiled to the CareConnect-GPC-Encounter-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Encounter-1
entry (CareConnect-GPC-MedicationDispense-1)
Usage
Required
Guidance
The entry
can contain a entry profiled to the STU3 CareConnect-MedicationDispense-1 structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-MedicationDispense-1
entry (CareConnect-GPC-Observation-1)
Usage
Required
Guidance
The entry
MAY contain a entry profiled to the CareConnect-GPC-Observation-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Observation-1
entry (CareConnect-GPC-ClinicalImpression)-1
Usage
Mandatory
Guidance
The entry
MUST contain a entry profiled to the ClinicalImpression
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
entry (CareConnect-GPC-Condition-1)
Usage
Required
Guidance
The entry
MAY contain a entry profiled to the CareConnect-GPC-Condition-1
structure definition.
More information about how to populate this resource can be found in this guide using the link below.
Profile: CareConnect-GPC-Condition-1