[ITI-81] Retrieve ATNA Audit Event

Validation description

Name
[ITI-81] Retrieve ATNA Audit Event
OID
1.3.6.1.4.1.12559.11.25.1.20.2
Profile
ATC
Descriminator
EPR
Status
Available
Execute schema validation ?
true
Execute schematron validation ?
true
URL
http://fhir.ch/ig/ch-atc/StructureDefinition/CH-ATC.ITI-81.Response
Base definition
http://fhir.ch/ig/ch-atc/StructureDefinition/CH-ATC.ITI-81.Response

Structure Definition (SNAPSHOT computed)

Contextual information
Id
CH-ATC.ITI-81.Response
Name
ChAtcIti81Response
Title
Description
ImplementationGuide for CH:ATC see Audit Trail Consumption
FHIR version
3.0.1
Type
Bundle
Status
active
URL
http://fhir.ch/ig/ch-atc/StructureDefinition/CH-ATC.ITI-81.Response
Base definition
http://hl7.org/fhir/StructureDefinition/Bundle
Derivation
constraint
Experimental ?
false
Abstract ?
false
Kind
resource
Last update date
2018-05-14T00:00:00+00:00
Publisher
Federal Office of Public Health (FOPH)
Copyright
CC-BY-SA-4.0
Contact(s)
Mappings
Identity URI Name
v2 http://hl7.org/v2 HL7 v2 Mapping
rim http://hl7.org/v3 RIM Mapping
w5 http://hl7.org/fhir/w5 W5 Mapping
Details
Path
Cardinality
Type
[0..*]
Bundle 6
[0..1]
id
[0..1]
Meta
[0..1]
uri
[0..1]
code B
[0..1]
Identifier
[1..1]
code F B
[0..1]
unsignedInt
[0..*]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string
[1..1]
uri
[0..*]
BackboneElement 3
[0..*]
BackboneElement 3
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..*]
Bundle.entry.link
[0..1]
uri
[1..1]
AuditEvent
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
code B
[0..1]
decimal
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
code B
[1..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
string
[0..1]
string
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string
[0..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
Resource
[0..*]
BackboneElement 3
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..*]
Bundle.entry.link
[0..1]
uri
[0..1]
AuditEvent
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
code B
[0..1]
decimal
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
code B
[1..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
string
[0..1]
string
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string
[0..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
Resource
[0..*]
BackboneElement 3
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..*]
Bundle.entry.link
[0..1]
uri
[0..1]
AuditEvent
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
code B
[0..1]
decimal
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
code B
[1..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
string
[0..1]
string
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string
[0..1]
uri
[0..1]
string
[0..1]
instant
[0..1]
Resource
[0..1]
Signature
Bundle Constrained
Path
Bundle
Cardinality
0..*
Short Description
Contains a collection of resources
Definition
A container for a collection of resources.
Base
Bundle [0..*]
Mapping
  • rim:Entity. Role, or Act
  • v2:N/A
  • rim:N/A
  • w5:infrastructure.structure
Constraints
Severity
errorbdl-7
Description
FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
Expression
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
XPath
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
Bundle
Severity
errorbdl-9
Description
A document must have an identifier with a system and a value
Expression
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
XPath
not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)
Source
Bundle
Severity
errorbdl-3
Description
entry.request only for some types of bundles
Expression
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
XPath
not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')
Source
Bundle
Severity
errorbdl-4
Description
entry.response only for some types of bundles
Expression
entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
XPath
not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response')
Source
Bundle
Severity
errorbdl-1
Description
total only when a search or history
Expression
total.empty() or (type = 'searchset') or (type = 'history')
XPath
not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')
Source
Bundle
Severity
errorbdl-2
Description
entry.search only when a search
Expression
entry.search.empty() or (type = 'searchset')
XPath
not(f:entry/f:search) or (f:type/@value = 'searchset')
Source
Bundle
Bundle.id
Path
Bundle.id
Cardinality
0..1
Part of a summary ?
true
Short Description
Logical id of this artifact
Definition
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Base
Resource.id [0..1]
Comment
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Type
id
Bundle.meta
Path
Bundle.meta
Cardinality
0..1
Part of a summary ?
true
Short Description
Metadata about the resource
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.
Base
Resource.meta [0..1]
Type
Meta
Bundle.implicitRules
Path
Bundle.implicitRules
Cardinality
0..1
Part of a summary ?
true
Short Description
A set of rules under which this content was created
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.
Base
Resource.implicitRules [0..1]
Comment
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.
Type
uri
Bundle.language Binding
Path
Bundle.language
Cardinality
0..1
Short Description
Language of the resource content
Definition
The base language in which the resource is written.
Base
Resource.language [0..1]
Comment
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).
Type
code
Binding
Language(extensible) : A human language.
Bundle.identifier
Path
Bundle.identifier
Cardinality
0..1
Part of a summary ?
true
Short Description
Persistent identifier for the bundle
Definition
A persistent identifier for the batch that won't change as a batch is copied from server to server.
Base
Bundle.identifier [0..1]
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.
Type
Identifier
Mapping
  • w5:id
Bundle.type Fixed value Binding
Path
Bundle.type
Cardinality
1..1
Part of a summary ?
true
Short Description
searchset
Definition
Indicates the purpose of this bundle - how it was intended to be used.
Base
Bundle.type [1..1]
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.
Type
code
Fixed code
searchset
Binding
BundleType(required) : Indicates the purpose of a bundle - how it was intended to be used.
Mapping
  • w5:class
Bundle.total
Path
Bundle.total
Cardinality
0..1
Part of a summary ?
true
Short Description
If search, the total number of matches
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).
Base
Bundle.total [0..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.
Type
unsignedInt
Path
Bundle.link
Cardinality
0..*
Part of a summary ?
true
Short Description
Links related to this Bundle
Definition
A series of links that provide context to this bundle.
Base
Bundle.link [0..*]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.link.id
Path
Bundle.link.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.link.extension
Path
Bundle.link.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.link.modifierExtension
Path
Bundle.link.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.link.relation
Path
Bundle.link.relation
Cardinality
1..1
Part of a summary ?
true
Short Description
See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
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).
Base
Bundle.link.relation [1..1]
Type
string
Bundle.link.url
Path
Bundle.link.url
Cardinality
1..1
Part of a summary ?
true
Short Description
Reference details for the link
Definition
The reference details for the link.
Base
Bundle.link.url [1..1]
Type
uri
Bundle.entry Constrained
Path
Bundle.entry
Cardinality
0..*
Part of a summary ?
true
Slicing
  • Descriminator type:profile
  • Descriminator path:resource
  • Rules:closed
Short Description
Entry in the bundle - will have a resource, or information
Definition
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Base
Bundle.entry [0..*]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorbdl-8
Description
fullUrl cannot be a version specific reference
Expression
fullUrl.contains('/_history/').not()
XPath
not(exists(f:fullUrl[contains(string(@value), '/_history/')]))
Source
Bundle.entry
Severity
errorbdl-5
Description
must be a resource unless there's a request or response
Expression
resource.exists() or request.exists() or response.exists()
XPath
exists(f:resource) or exists(f:request) or exists(f:response)
Source
Bundle.entry
Bundle.entry:documentauditevent Constrained
Path
Bundle.entry
Cardinality
0..*
Part of a summary ?
true
Short Description
AuditEvent
Slice name
DocumentAuditEvent
Definition
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Base
Bundle.entry [0..*]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorbdl-8
Description
fullUrl cannot be a version specific reference
Expression
fullUrl.contains('/_history/').not()
XPath
not(exists(f:fullUrl[contains(string(@value), '/_history/')]))
Source
Bundle.entry
Severity
errorbdl-5
Description
must be a resource unless there's a request or response
Expression
resource.exists() or request.exists() or response.exists()
XPath
exists(f:resource) or exists(f:request) or exists(f:response)
Source
Bundle.entry
Bundle.entry:documentauditevent.id
Path
Bundle.entry.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.extension
Path
Bundle.entry.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.modifierExtension
Path
Bundle.entry.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Path
Bundle.entry.link
Cardinality
0..*
Part of a summary ?
true
Short Description
Links related to this entry
Definition
A series of links that provide context to this entry.
Base
Bundle.entry.link [0..*]
Bundle.entry:documentauditevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..1
Part of a summary ?
true
Short Description
Absolute URL for resource (server address, or UUID/OID)
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.
Base
Bundle.entry.fullUrl [0..1]
Comment
fullUrl may 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 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](references.html#regex), then it SHALL end with the Resource.id.
Type
uri
Bundle.entry:documentauditevent.resource
Path
Bundle.entry.resource
Cardinality
1..1
Must support ?
true
Part of a summary ?
true
Short Description
A resource in the bundle
Definition
The Resources for the entry.
Base
Bundle.entry.resource [0..1]
Type
AuditEvent
Bundle.entry:documentauditevent.search Constrained
Path
Bundle.entry.search
Cardinality
0..1
Part of a summary ?
true
Short Description
Search related information
Definition
Information about the search process that lead to the creation of this entry.
Base
Bundle.entry.search [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:documentauditevent.search.id
Path
Bundle.entry.search.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.search.extension
Path
Bundle.entry.search.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.search.modifierExtension
Path
Bundle.entry.search.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:documentauditevent.search.mode Binding
Path
Bundle.entry.search.mode
Cardinality
0..1
Part of a summary ?
true
Short Description
match | include | outcome - why this is in the result set
Definition
Why this entry is in the result set - whether it's included as a match or because of an _include requirement.
Base
Bundle.entry.search.mode [0..1]
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.
Type
code
Binding
SearchEntryMode(required) : Why an entry is in the result set - whether it's included as a match or because of an _include requirement.
Bundle.entry:documentauditevent.search.score
Path
Bundle.entry.search.score
Cardinality
0..1
Part of a summary ?
true
Short Description
Search ranking (between 0 and 1)
Definition
When searching, the server's search ranking score for the entry.
Base
Bundle.entry.search.score [0..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.
Type
decimal
Bundle.entry:documentauditevent.request Constrained
Path
Bundle.entry.request
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.request [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:documentauditevent.request.id
Path
Bundle.entry.request.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.request.extension
Path
Bundle.entry.request.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.request.modifierExtension
Path
Bundle.entry.request.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:documentauditevent.request.method Binding
Path
Bundle.entry.request.method
Cardinality
1..1
Part of a summary ?
true
Short Description
GET | POST | PUT | DELETE
Definition
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
Base
Bundle.entry.request.method [1..1]
Type
code
Binding
HTTPVerb(required) : HTTP verbs (in the HTTP command line).
Bundle.entry:documentauditevent.request.url
Path
Bundle.entry.request.url
Cardinality
1..1
Part of a summary ?
true
Short Description
URL for HTTP equivalent of this entry
Definition
The URL for this entry, relative to the root (the address to which the request is posted).
Base
Bundle.entry.request.url [1..1]
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]".
Type
uri
Bundle.entry:documentauditevent.request.ifNoneMatch
Path
Bundle.entry.request.ifNoneMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing cache currency
Definition
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifNoneMatch [0..1]
Type
string
Bundle.entry:documentauditevent.request.ifModifiedSince
Path
Bundle.entry.request.ifModifiedSince
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifModifiedSince [0..1]
Type
instant
Bundle.entry:documentauditevent.request.ifMatch
Path
Bundle.entry.request.ifMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Base
Bundle.entry.request.ifMatch [0..1]
Type
string
Bundle.entry:documentauditevent.request.ifNoneExist
Path
Bundle.entry.request.ifNoneExist
Cardinality
0..1
Part of a summary ?
true
Short Description
For conditional creates
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 "?").
Base
Bundle.entry.request.ifNoneExist [0..1]
Type
string
Bundle.entry:documentauditevent.response Constrained
Path
Bundle.entry.response
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.response [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:documentauditevent.response.id
Path
Bundle.entry.response.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.response.extension
Path
Bundle.entry.response.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:documentauditevent.response.modifierExtension
Path
Bundle.entry.response.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:documentauditevent.response.status
Path
Bundle.entry.response.status
Cardinality
1..1
Part of a summary ?
true
Short Description
Status response code (text optional)
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.
Base
Bundle.entry.response.status [1..1]
Type
string
Bundle.entry:documentauditevent.response.location
Path
Bundle.entry.response.location
Cardinality
0..1
Part of a summary ?
true
Short Description
The location, if the operation returns a location
Definition
The location header created by processing this operation.
Base
Bundle.entry.response.location [0..1]
Type
uri
Bundle.entry:documentauditevent.response.etag
Path
Bundle.entry.response.etag
Cardinality
0..1
Part of a summary ?
true
Short Description
The etag for the resource (if relevant)
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)).
Base
Bundle.entry.response.etag [0..1]
Comment
Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Type
string
Bundle.entry:documentauditevent.response.lastModified
Path
Bundle.entry.response.lastModified
Cardinality
0..1
Part of a summary ?
true
Short Description
Server's date time modified
Definition
The date/time that the resource was modified on the server.
Base
Bundle.entry.response.lastModified [0..1]
Comment
This has to match the same time in the meta header if a resource is included.
Type
instant
Bundle.entry:documentauditevent.response.outcome
Path
Bundle.entry.response.outcome
Cardinality
0..1
Part of a summary ?
true
Short Description
OperationOutcome with hints and warnings (for batch/transaction)
Definition
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Base
Bundle.entry.response.outcome [0..1]
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.
Type
Resource
Bundle.entry:policyauditevent Constrained
Path
Bundle.entry
Cardinality
0..*
Part of a summary ?
true
Short Description
AuditEvent
Slice name
PolicyAuditEvent
Definition
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Base
Bundle.entry [0..*]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorbdl-8
Description
fullUrl cannot be a version specific reference
Expression
fullUrl.contains('/_history/').not()
XPath
not(exists(f:fullUrl[contains(string(@value), '/_history/')]))
Source
Bundle.entry
Severity
errorbdl-5
Description
must be a resource unless there's a request or response
Expression
resource.exists() or request.exists() or response.exists()
XPath
exists(f:resource) or exists(f:request) or exists(f:response)
Source
Bundle.entry
Bundle.entry:policyauditevent.id
Path
Bundle.entry.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.extension
Path
Bundle.entry.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.modifierExtension
Path
Bundle.entry.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Path
Bundle.entry.link
Cardinality
0..*
Part of a summary ?
true
Short Description
Links related to this entry
Definition
A series of links that provide context to this entry.
Base
Bundle.entry.link [0..*]
Bundle.entry:policyauditevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..1
Part of a summary ?
true
Short Description
Absolute URL for resource (server address, or UUID/OID)
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.
Base
Bundle.entry.fullUrl [0..1]
Comment
fullUrl may 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 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](references.html#regex), then it SHALL end with the Resource.id.
Type
uri
Bundle.entry:policyauditevent.resource
Path
Bundle.entry.resource
Cardinality
0..1
Must support ?
true
Part of a summary ?
true
Short Description
A resource in the bundle
Definition
The Resources for the entry.
Base
Bundle.entry.resource [0..1]
Type
AuditEvent
Bundle.entry:policyauditevent.search Constrained
Path
Bundle.entry.search
Cardinality
0..1
Part of a summary ?
true
Short Description
Search related information
Definition
Information about the search process that lead to the creation of this entry.
Base
Bundle.entry.search [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:policyauditevent.search.id
Path
Bundle.entry.search.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.search.extension
Path
Bundle.entry.search.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.search.modifierExtension
Path
Bundle.entry.search.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:policyauditevent.search.mode Binding
Path
Bundle.entry.search.mode
Cardinality
0..1
Part of a summary ?
true
Short Description
match | include | outcome - why this is in the result set
Definition
Why this entry is in the result set - whether it's included as a match or because of an _include requirement.
Base
Bundle.entry.search.mode [0..1]
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.
Type
code
Binding
SearchEntryMode(required) : Why an entry is in the result set - whether it's included as a match or because of an _include requirement.
Bundle.entry:policyauditevent.search.score
Path
Bundle.entry.search.score
Cardinality
0..1
Part of a summary ?
true
Short Description
Search ranking (between 0 and 1)
Definition
When searching, the server's search ranking score for the entry.
Base
Bundle.entry.search.score [0..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.
Type
decimal
Bundle.entry:policyauditevent.request Constrained
Path
Bundle.entry.request
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.request [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:policyauditevent.request.id
Path
Bundle.entry.request.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.request.extension
Path
Bundle.entry.request.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.request.modifierExtension
Path
Bundle.entry.request.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:policyauditevent.request.method Binding
Path
Bundle.entry.request.method
Cardinality
1..1
Part of a summary ?
true
Short Description
GET | POST | PUT | DELETE
Definition
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
Base
Bundle.entry.request.method [1..1]
Type
code
Binding
HTTPVerb(required) : HTTP verbs (in the HTTP command line).
Bundle.entry:policyauditevent.request.url
Path
Bundle.entry.request.url
Cardinality
1..1
Part of a summary ?
true
Short Description
URL for HTTP equivalent of this entry
Definition
The URL for this entry, relative to the root (the address to which the request is posted).
Base
Bundle.entry.request.url [1..1]
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]".
Type
uri
Bundle.entry:policyauditevent.request.ifNoneMatch
Path
Bundle.entry.request.ifNoneMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing cache currency
Definition
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifNoneMatch [0..1]
Type
string
Bundle.entry:policyauditevent.request.ifModifiedSince
Path
Bundle.entry.request.ifModifiedSince
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifModifiedSince [0..1]
Type
instant
Bundle.entry:policyauditevent.request.ifMatch
Path
Bundle.entry.request.ifMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Base
Bundle.entry.request.ifMatch [0..1]
Type
string
Bundle.entry:policyauditevent.request.ifNoneExist
Path
Bundle.entry.request.ifNoneExist
Cardinality
0..1
Part of a summary ?
true
Short Description
For conditional creates
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 "?").
Base
Bundle.entry.request.ifNoneExist [0..1]
Type
string
Bundle.entry:policyauditevent.response Constrained
Path
Bundle.entry.response
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.response [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:policyauditevent.response.id
Path
Bundle.entry.response.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.response.extension
Path
Bundle.entry.response.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:policyauditevent.response.modifierExtension
Path
Bundle.entry.response.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:policyauditevent.response.status
Path
Bundle.entry.response.status
Cardinality
1..1
Part of a summary ?
true
Short Description
Status response code (text optional)
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.
Base
Bundle.entry.response.status [1..1]
Type
string
Bundle.entry:policyauditevent.response.location
Path
Bundle.entry.response.location
Cardinality
0..1
Part of a summary ?
true
Short Description
The location, if the operation returns a location
Definition
The location header created by processing this operation.
Base
Bundle.entry.response.location [0..1]
Type
uri
Bundle.entry:policyauditevent.response.etag
Path
Bundle.entry.response.etag
Cardinality
0..1
Part of a summary ?
true
Short Description
The etag for the resource (if relevant)
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)).
Base
Bundle.entry.response.etag [0..1]
Comment
Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Type
string
Bundle.entry:policyauditevent.response.lastModified
Path
Bundle.entry.response.lastModified
Cardinality
0..1
Part of a summary ?
true
Short Description
Server's date time modified
Definition
The date/time that the resource was modified on the server.
Base
Bundle.entry.response.lastModified [0..1]
Comment
This has to match the same time in the meta header if a resource is included.
Type
instant
Bundle.entry:policyauditevent.response.outcome
Path
Bundle.entry.response.outcome
Cardinality
0..1
Part of a summary ?
true
Short Description
OperationOutcome with hints and warnings (for batch/transaction)
Definition
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Base
Bundle.entry.response.outcome [0..1]
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.
Type
Resource
Bundle.entry:accessaudittrailevent Constrained
Path
Bundle.entry
Cardinality
0..*
Part of a summary ?
true
Short Description
AuditEvent
Slice name
AccessAuditTrailEvent
Definition
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Base
Bundle.entry [0..*]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorbdl-8
Description
fullUrl cannot be a version specific reference
Expression
fullUrl.contains('/_history/').not()
XPath
not(exists(f:fullUrl[contains(string(@value), '/_history/')]))
Source
Bundle.entry
Severity
errorbdl-5
Description
must be a resource unless there's a request or response
Expression
resource.exists() or request.exists() or response.exists()
XPath
exists(f:resource) or exists(f:request) or exists(f:response)
Source
Bundle.entry
Bundle.entry:accessaudittrailevent.id
Path
Bundle.entry.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.extension
Path
Bundle.entry.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.modifierExtension
Path
Bundle.entry.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Path
Bundle.entry.link
Cardinality
0..*
Part of a summary ?
true
Short Description
Links related to this entry
Definition
A series of links that provide context to this entry.
Base
Bundle.entry.link [0..*]
Bundle.entry:accessaudittrailevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..1
Part of a summary ?
true
Short Description
Absolute URL for resource (server address, or UUID/OID)
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.
Base
Bundle.entry.fullUrl [0..1]
Comment
fullUrl may 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 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](references.html#regex), then it SHALL end with the Resource.id.
Type
uri
Bundle.entry:accessaudittrailevent.resource
Path
Bundle.entry.resource
Cardinality
0..1
Must support ?
true
Part of a summary ?
true
Short Description
A resource in the bundle
Definition
The Resources for the entry.
Base
Bundle.entry.resource [0..1]
Type
AuditEvent
Bundle.entry:accessaudittrailevent.search Constrained
Path
Bundle.entry.search
Cardinality
0..1
Part of a summary ?
true
Short Description
Search related information
Definition
Information about the search process that lead to the creation of this entry.
Base
Bundle.entry.search [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:accessaudittrailevent.search.id
Path
Bundle.entry.search.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.search.extension
Path
Bundle.entry.search.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.search.modifierExtension
Path
Bundle.entry.search.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:accessaudittrailevent.search.mode Binding
Path
Bundle.entry.search.mode
Cardinality
0..1
Part of a summary ?
true
Short Description
match | include | outcome - why this is in the result set
Definition
Why this entry is in the result set - whether it's included as a match or because of an _include requirement.
Base
Bundle.entry.search.mode [0..1]
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.
Type
code
Binding
SearchEntryMode(required) : Why an entry is in the result set - whether it's included as a match or because of an _include requirement.
Bundle.entry:accessaudittrailevent.search.score
Path
Bundle.entry.search.score
Cardinality
0..1
Part of a summary ?
true
Short Description
Search ranking (between 0 and 1)
Definition
When searching, the server's search ranking score for the entry.
Base
Bundle.entry.search.score [0..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.
Type
decimal
Bundle.entry:accessaudittrailevent.request Constrained
Path
Bundle.entry.request
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.request [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:accessaudittrailevent.request.id
Path
Bundle.entry.request.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.request.extension
Path
Bundle.entry.request.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.request.modifierExtension
Path
Bundle.entry.request.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:accessaudittrailevent.request.method Binding
Path
Bundle.entry.request.method
Cardinality
1..1
Part of a summary ?
true
Short Description
GET | POST | PUT | DELETE
Definition
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
Base
Bundle.entry.request.method [1..1]
Type
code
Binding
HTTPVerb(required) : HTTP verbs (in the HTTP command line).
Bundle.entry:accessaudittrailevent.request.url
Path
Bundle.entry.request.url
Cardinality
1..1
Part of a summary ?
true
Short Description
URL for HTTP equivalent of this entry
Definition
The URL for this entry, relative to the root (the address to which the request is posted).
Base
Bundle.entry.request.url [1..1]
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]".
Type
uri
Bundle.entry:accessaudittrailevent.request.ifNoneMatch
Path
Bundle.entry.request.ifNoneMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing cache currency
Definition
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifNoneMatch [0..1]
Type
string
Bundle.entry:accessaudittrailevent.request.ifModifiedSince
Path
Bundle.entry.request.ifModifiedSince
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Base
Bundle.entry.request.ifModifiedSince [0..1]
Type
instant
Bundle.entry:accessaudittrailevent.request.ifMatch
Path
Bundle.entry.request.ifMatch
Cardinality
0..1
Part of a summary ?
true
Short Description
For managing update contention
Definition
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Base
Bundle.entry.request.ifMatch [0..1]
Type
string
Bundle.entry:accessaudittrailevent.request.ifNoneExist
Path
Bundle.entry.request.ifNoneExist
Cardinality
0..1
Part of a summary ?
true
Short Description
For conditional creates
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 "?").
Base
Bundle.entry.request.ifNoneExist [0..1]
Type
string
Bundle.entry:accessaudittrailevent.response Constrained
Path
Bundle.entry.response
Cardinality
0..1
Part of a summary ?
true
Short Description
Transaction Related Information
Definition
Additional information about how this entry should be processed as part of a transaction.
Base
Bundle.entry.response [0..1]
Type
BackboneElement
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Bundle.entry:accessaudittrailevent.response.id
Path
Bundle.entry.response.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.response.extension
Path
Bundle.entry.response.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
Bundle.entry:accessaudittrailevent.response.modifierExtension
Path
Bundle.entry.response.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
Bundle.entry:accessaudittrailevent.response.status
Path
Bundle.entry.response.status
Cardinality
1..1
Part of a summary ?
true
Short Description
Status response code (text optional)
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.
Base
Bundle.entry.response.status [1..1]
Type
string
Bundle.entry:accessaudittrailevent.response.location
Path
Bundle.entry.response.location
Cardinality
0..1
Part of a summary ?
true
Short Description
The location, if the operation returns a location
Definition
The location header created by processing this operation.
Base
Bundle.entry.response.location [0..1]
Type
uri
Bundle.entry:accessaudittrailevent.response.etag
Path
Bundle.entry.response.etag
Cardinality
0..1
Part of a summary ?
true
Short Description
The etag for the resource (if relevant)
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)).
Base
Bundle.entry.response.etag [0..1]
Comment
Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Type
string
Bundle.entry:accessaudittrailevent.response.lastModified
Path
Bundle.entry.response.lastModified
Cardinality
0..1
Part of a summary ?
true
Short Description
Server's date time modified
Definition
The date/time that the resource was modified on the server.
Base
Bundle.entry.response.lastModified [0..1]
Comment
This has to match the same time in the meta header if a resource is included.
Type
instant
Bundle.entry:accessaudittrailevent.response.outcome
Path
Bundle.entry.response.outcome
Cardinality
0..1
Part of a summary ?
true
Short Description
OperationOutcome with hints and warnings (for batch/transaction)
Definition
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
Base
Bundle.entry.response.outcome [0..1]
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.
Type
Resource
Bundle.signature
Path
Bundle.signature
Cardinality
0..1
Part of a summary ?
true
Short Description
Digital Signature
Definition
Digital Signature - base64 encoded. XML-DSIg or a JWT.
Base
Bundle.signature [0..1]
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.
Type
Signature
Bundle
Path
Bundle
Cardinality
0..*
Bundle.type Fixed value
Path
Bundle.type
Cardinality
0..*
Short Description
searchset
Fixed code
searchset
Bundle.entry
Path
Bundle.entry
Cardinality
0..*
Slicing
  • Descriminator type:profile
  • Descriminator path:resource
  • Rules:closed
Bundle.entry:documentauditevent
Path
Bundle.entry
Cardinality
0..*
Short Description
AuditEvent
Slice name
DocumentAuditEvent
Bundle.entry:documentauditevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..*
Bundle.entry:documentauditevent.resource
Path
Bundle.entry.resource
Cardinality
1..*
Must support ?
true
Type
AuditEvent
Bundle.entry:policyauditevent
Path
Bundle.entry
Cardinality
0..*
Short Description
AuditEvent
Slice name
PolicyAuditEvent
Bundle.entry:policyauditevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..*
Bundle.entry:policyauditevent.resource
Path
Bundle.entry.resource
Cardinality
0..*
Must support ?
true
Type
AuditEvent
Bundle.entry:accessaudittrailevent
Path
Bundle.entry
Cardinality
0..*
Short Description
AuditEvent
Slice name
AccessAuditTrailEvent
Bundle.entry:accessaudittrailevent.fullUrl
Path
Bundle.entry.fullUrl
Cardinality
0..*
Bundle.entry:accessaudittrailevent.resource
Path
Bundle.entry.resource
Cardinality
0..*
Must support ?
true
Type
AuditEvent