Page Status: draft updated 2025-11-04

Bundle - HVOOrganizationTransactionBundle

Page index

General information

A Bundle is a collection of resources. It can be used to return results in a search query or to perform an insert or update that requires multiple entries of resources.

Scope and Usage

This profile of Bundle is used in a request, filling the role of a transaction.

The transaction that can be used with this profiling of Bundle is that of updating or creating HVOOrganizations and HVOOrganizationalUnits. Using a transaction to handle these resources in one operation ensures that the relationships between them are created correctly, or maintained correctly when updating them.

Boundaries and Relationships

In order to perform read or search queries on these profiles, interact with them individually. See the supported queries on their respective pages.

Background and Context

Typically you want to create and update an organizational structure all at once - instead of creating or updating the organization and its units one by one. This makes it easier to build integrating systems with the catalog that perform continuous automatic updates to the hierarchy as well as front ends that offer a graphical interface to perform changes to the hierarchy and its members using the API.

Profile

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ C0..1Identifier
typeS Σ C1..1codeBindingFixed Value
timestampΣ C0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ C1..1codeBinding
urlΣ C1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
idS Σ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ C0..*Identifier
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ C0..1string
alias0..*string
descriptionΣ0..1markdown
contactC0..*ExtendedContactDetail
partOfΣ0..1Reference(Organization)
endpoint0..*Reference(Endpoint)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifier0..*Identifier
code1..1CodeableConcept
period0..1Period
issuer0..1Reference(Organization)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodS Σ C1..1codeBinding
urlS Σ1..1uriFixed Value
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
issuesΣ C0..1OperationOutcome
Bundle
ShortContains a collection of resources
Definition

A container for a collection of resources.

Cardinality0..*
Constraints
  • bdl-1: total only when a search or history
    total.empty() or (type = 'searchset') or (type = 'history')
  • bdl-2: entry.search only when a search
    (type = 'searchset') or entry.search.empty()
  • bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
  • bdl-9: A document must have an identifier with a system and a value
    type = 'document' implies (identifier.system.exists() and identifier.value.exists())
  • bdl-10: A document must have a date
    type = 'document' implies (timestamp.hasValue())
  • bdl-11: A document must have a Composition as the first resource
    type = 'document' implies entry.first().resource.is(Composition)
  • bdl-12: A message must have a MessageHeader as the first resource
    type = 'message' implies entry.first().resource.is(MessageHeader)
  • bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
    type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
  • bdl-14: entry.request.method PATCH not allowed for history
    type = 'history' implies entry.request.method != 'PATCH'
  • bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
    type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
  • bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
    issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
  • bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
    type = 'document' implies issues.empty()
  • bdl-18: Self link is required for searchsets.
    type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
  • bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
    type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
  • bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
    type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
  • bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
    type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
  • bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
    type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
Mappings
  • rim: Entity. Role, or Act,N/A
  • w5: infrastructure.structure
  • v2: N/A
  • cda: ClinicalDocument, if bundle.type = document
Bundle.id
ShortLogical 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.

Cardinality0..1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Bundle.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.implicitRules
ShortA 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.identifier
ShortPersistent identifier for the bundle
Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Cardinality0..1
TypeIdentifier
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-9
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • cda: ClinicalDocument.id
Bundle.type
Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Definition

Indicates the purpose of this bundle - how it is intended to be used.

Cardinality1..1
Typecode
Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (required)

Must SupportTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
transaction
Mappings
  • w5: FiveWs.class
Bundle.timestamp
ShortWhen the bundle was assembled
Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Cardinality0..1
Typeinstant
SummaryTrue
Comments

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

  • document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
  • message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
  • history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
  • searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
  • transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-10
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
  • cda: ClinicalDocument.effectiveTime
Bundle.total
ShortIf search, the total number of matches
Definition

If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Cardinality0..1
TypeunsignedInt
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.link
ShortLinks related to this Bundle
Definition

A series of links that provide context to this bundle.

Cardinality0..*
TypeBackboneElement
SummaryTrue
Comments

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.link.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.link.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.link.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.link.relation
ShortSee 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.

Cardinality1..1
Typecode
Binding

LinkRelationTypes (required)

SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.link.url
ShortReference details for the link
Definition

The reference details for the link.

Cardinality1..1
Typeuri
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry
ShortEntry 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).

Cardinality1..*
TypeBackboneElement
Must SupportTrue
SummaryTrue
Constraints
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.entry.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.entry.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.link
ShortLinks related to this entry
Definition

A series of links that provide context to this entry.

Cardinality0..*
Typesee (link)
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.fullUrl
ShortURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
Definition

The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:

  • invoking a create
  • invoking or responding to an operation where the body is not a single identified resource
  • invoking or returning the results of a search or history operation.
Cardinality0..1
Typeuri
SummaryTrue
Comments

fullUrl might 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 fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.resource
ShortA resource in the bundle
Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.

Cardinality1..1
TypeHVOOrganization, HVOOrganizationalUnit
Must SupportTrue
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5
Bundle.entry.resource.id
ShortUUID of Organization
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
Must SupportTrue
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Bundle.entry.resource.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.resource.implicitRules
ShortA 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.resource.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
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).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.resource.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
Bundle.entry.resource.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings
  • rim: N/A
Bundle.entry.resource.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.resource.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.resource.identifier
ShortIdentifies this organization across multiple systems
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality0..*
TypeIdentifier
SummaryTrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: XON.10 / XON.3
  • rim: .scopes[Role](classCode=IDENT)
  • interface: Participant.identifier
  • servd: ./Identifiers
Bundle.entry.resource.active
ShortWhether the organization's record is still in active use
Definition

Whether the organization's record is still in active use.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • v2: No equivalent in HL7 V2
  • rim: .status
  • interface: Participant.active
  • servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
Bundle.entry.resource.type
ShortKind of organization
Definition

The kind(s) of organization that this is.

Cardinality0..*
TypeCodeableConcept
Binding

Used to categorize the organization.

OrganizationType (example)

SummaryTrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: No equivalent in v2
  • rim: .code
  • servd: n/a
Bundle.entry.resource.name
ShortName used for the organization
Definition

A name associated with the organization.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to use the name as the label of the organization.

Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

ConditionsThe cardinality or value of this element may be affected by these constraints: org-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XON.1
  • rim: .name
  • interface: Participant.name
  • servd: .PreferredName/Name
Bundle.entry.resource.alias
ShortA list of alternate names that the organization is known as, or was known as in the past
Definition

A list of alternate names that the organization is known as, or was known as in the past.

Cardinality0..*
Typestring
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .name
Bundle.entry.resource.description
ShortAdditional details about the Organization that could be displayed as further information to identify the Organization beyond its name
Definition

Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.

Cardinality0..1
Typemarkdown
SummaryTrue
Requirements

Humans need additional information to verify a correct Organization has been selected.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity[classCode=PLC determinerCode=INSTANCE].desc
Bundle.entry.resource.contact
ShortOfficial contact details for the Organization
Definition

The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Cardinality0..*
TypeExtendedContactDetail
Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Organization itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • org-3: The telecom of an organization can never be of use 'home'
    telecom.where(use = 'home').empty()
  • org-4: The address of an organization can never be of use 'home'
    address.where(use = 'home').empty()
Mappings
  • rim: .contactParty
Bundle.entry.resource.partOf
ShortThe organization of which this organization forms a part
Definition

The organization of which this organization forms a part.

Cardinality0..1
TypeReference(Organization)
SummaryTrue
Requirements

Need to be able to track the hierarchy of organizations within an organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: No equivalent in HL7 V2
  • rim: .playedBy[classCode=Part].scoper
  • servd: n/a
Bundle.entry.resource.endpoint
ShortTechnical endpoints providing access to services operated for the organization
Definition

Technical endpoints providing access to services operated for the organization.

Cardinality0..*
TypeReference(Endpoint)
Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource.qualification
ShortQualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
Definition

The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.

For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.

Cardinality0..*
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CER?
  • rim: n/a
Bundle.entry.resource.qualification.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.entry.resource.qualification.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.entry.resource.qualification.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.resource.qualification.identifier
ShortAn identifier for this qualification for the organization
Definition

An identifier allocated to this qualification for this organization.

Cardinality0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification by the assigning organization.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource.qualification.code
ShortCoded representation of the qualification
Definition

Coded representation of the qualification.

Cardinality1..1
TypeCodeableConcept
Binding

Specific qualification the organization has to provide a service.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource.qualification.period
ShortPeriod during which the qualification is valid
Definition

Period during which the qualification is valid.

Cardinality0..1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.resource.qualification.issuer
ShortOrganization that regulates and issues the qualification
Definition

Organization that regulates and issues the qualification.

Cardinality0..1
TypeReference(Organization)
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Bundle.entry.search
ShortSearch related information
Definition

Information about the search process that lead to the creation of this entry.

Cardinality0..1
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.search.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.entry.search.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.entry.search.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.search.mode
Shortmatch | include - 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, or to convey information or warning information about the search process.

Cardinality0..1
Typecode
Binding

Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

SearchEntryMode (required)

SummaryTrue
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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.search.score
ShortSearch ranking (between 0 and 1)
Definition

When searching, the server's search ranking score for the entry.

Cardinality0..1
Typedecimal
SummaryTrue
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.

See Patient Match for the EMPI search which relates to this element.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request
ShortAdditional execution information (transaction/batch/history)
Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Cardinality1..1
TypeBackboneElement
Must SupportTrue
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.entry.request.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.entry.request.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.request.method
ShortPUT | POST | PATCH
Definition

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

Cardinality1..1
Typecode
Binding

HTTP verbs (in the HTTP command line). See HTTP rfc for details.

HTTPVerb (required)

Must SupportTrue
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request.url
ShortURL for HTTP equivalent of this entry
Definition

The URL for this entry, relative to the root (the address to which the request is posted).

Cardinality1..1
Typeuri
Must SupportTrue
SummaryTrue
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]".

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value
Organization
Bundle.entry.request.ifNoneMatch
ShortFor managing cache validation
Definition

If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".

Cardinality0..1
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request.ifModifiedSince
ShortFor managing cache currency
Definition

Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".

Cardinality0..1
Typeinstant
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request.ifMatch
ShortFor managing update contention
Definition

Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention".

Cardinality0..1
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.request.ifNoneExist
ShortFor 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". This is just the query portion of the URL - what follows the "?" (not including the "?").

Cardinality0..1
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response
ShortResults of execution (transaction/batch/history)
Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Cardinality0..1
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
Bundle.entry.response.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, 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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Bundle.entry.response.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Bundle.entry.response.status
ShortStatus 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.

Cardinality1..1
Typestring
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response.location
ShortThe location (if the operation returns a location)
Definition

The location header created by processing this operation, populated if the operation returns a location.

Cardinality0..1
Typeuri
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response.etag
ShortThe Etag for the resource (if relevant)
Definition

The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention).

Cardinality0..1
Typestring
SummaryTrue
Comments

Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response.lastModified
ShortServer's date time modified
Definition

The date/time that the resource was modified on the server.

Cardinality0..1
Typeinstant
SummaryTrue
Comments

This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.entry.response.outcome
ShortOperationOutcome 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.

Cardinality0..1
TypeResource
SummaryTrue
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.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.

Bundle.signature
ShortDigital Signature
Definition

Digital Signature - base64 encoded. XML-DSig or a JWS.

Cardinality0..1
TypeSignature
SummaryTrue
Requirements

A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

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.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Bundle.issues
ShortIssues with the Bundle
Definition

Captures issues and warnings that relate to the construction of the Bundle and the content within it.

Cardinality0..1
TypeOperationOutcome
SummaryTrue
Comments

Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.

ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-16, bdl-17
{
"resourceType": "Bundle",
"id": "HVOOrganizationHealthcareTransactionTemplate",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationTransactionBundle"
]
},
"entry": [
{
"request": {
"url": "Organization",
"method": "PATCH"
},
"resourceType": "Organization",
"id": "entry1",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
]
},
{
"system": "<system1>",
"value": "<value1>"
},
{
"system": "<system2>",
"value": "<value2>"
}
],
"type": [
{
"coding": [
{
"system": "<system1>",
"code": "<code1>"
}
]
},
{
"coding": [
{
"system": "<system2>",
"code": "<code2>"
}
]
}
],
{
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension",
"valueBoolean": true
},
{
"start": "2000-01-01",
"end": "2001-01-01"
},
"url": "http://hl7.org/fhir/StructureDefinition/organization-period"
},
{
{
"code": "<code>",
"system": "<system>"
},
"url": "type"
},
{
"reference": "Organization/<logical ID>"
},
"url": "additionalRelationship"
}
],
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnitAdditionalRelationshipExtension"
}
],
"alias": [
"<alias1>",
"<alias2>"
],
"contact": [
{
"name": [
{
"text": "<name1>"
}
],
"purpose": {
"coding": [
{
"code": "<code1>",
"system": "<system1>"
}
]
},
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
},
"address": {
"line": [
"<line1>",
"<line2>"
],
"city": "<city>",
"postalCode": "<postalCode>",
"country": "<country>"
}
},
{
"name": [
{
"text": "<name2>"
}
],
"purpose": {
"coding": [
{
"code": "<code2>",
"system": "<system2>"
}
]
},
"telecom": [
{
"value": "<value>",
"system": "<code>"
}
],
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
}
}
],
"partOf": {
"system": "urn:oid:2.5.4.97",
"value": "<value>"
}
},
{
"resourceType": "HealthcareService",
"id": "business-template-1",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness"
]
},
{
"coding": [
{
"system": "<system>",
"code": "<code2>"
}
]
}
],
{
{
"mon",
"tue"
],
"availableEndTime": "17:00:00",
"availableStartTime": "08:00:00",
"allDay": false
},
{
"wed",
"thu"
],
"allDay": true
}
],
{
"during": {
"end": "2002-02-02",
"start": "2002-01-01"
},
"description": "<description>"
},
{
"during": {
"end": "2003-02-02",
"start": "2003-01-01"
},
"description": "<description>"
}
]
}
],
{
"reference": "Location/<logical ID1>"
},
{
"reference": "Location/<logical ID2>"
}
],
"reference": "#"
}
}
],
"name": "<name>"
}
},
{
"request": {
"url": "Organization",
"method": "PUT"
},
"resourceType": "Organization",
"id": "entry2",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
]
},
{
"system": "<system1>",
"value": "<value1>"
},
{
"system": "<system2>",
"value": "<value2>"
}
],
"type": [
{
"coding": [
{
"system": "<system1>",
"code": "<code1>"
}
]
},
{
"coding": [
{
"system": "<system2>",
"code": "<code2>"
}
]
}
],
{
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension",
"valueBoolean": true
},
{
"start": "2000-01-01",
"end": "2001-01-01"
},
"url": "http://hl7.org/fhir/StructureDefinition/organization-period"
},
{
{
"code": "<code>",
"system": "<system>"
},
"url": "type"
},
{
"reference": "Organization/<logical ID>"
},
"url": "additionalRelationship"
}
],
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnitAdditionalRelationshipExtension"
}
],
"alias": [
"<alias1>",
"<alias2>"
],
"contact": [
{
"name": [
{
"text": "<name1>"
}
],
"purpose": {
"coding": [
{
"code": "<code1>",
"system": "<system1>"
}
]
},
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
},
"address": {
"line": [
"<line1>",
"<line2>"
],
"city": "<city>",
"postalCode": "<postalCode>",
"country": "<country>"
}
},
{
"name": [
{
"text": "<name2>"
}
],
"purpose": {
"coding": [
{
"code": "<code2>",
"system": "<system2>"
}
]
},
"telecom": [
{
"value": "<value>",
"system": "<code>"
}
],
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
}
}
],
"partOf": {
"reference": "Organization/<logical ID>"
},
{
"resourceType": "HealthcareService",
"id": "business-template-1",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness"
]
},
{
"coding": [
{
"system": "<system>",
"code": "<code2>"
}
]
}
],
{
{
"mon",
"tue"
],
"availableEndTime": "17:00:00",
"availableStartTime": "08:00:00",
"allDay": false
},
{
"wed",
"thu"
],
"allDay": true
}
],
{
"during": {
"end": "2002-02-02",
"start": "2002-01-01"
},
"description": "<description>"
},
{
"during": {
"end": "2003-02-02",
"start": "2003-01-01"
},
"description": "<description>"
}
]
}
],
{
"reference": "Location/<logical ID1>"
},
{
"reference": "Location/<logical ID2>"
}
],
"reference": "#"
}
}
],
"name": "<name>"
}
},
{
"request": {
"url": "Organization",
"method": "POST"
},
"resourceType": "Organization",
"id": "entry3",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
]
},
{
"system": "<system1>",
"value": "<value1>"
},
{
"system": "<system2>",
"value": "<value2>"
}
],
"type": [
{
"coding": [
{
"system": "<system1>",
"code": "<code1>"
}
]
},
{
"coding": [
{
"system": "<system2>",
"code": "<code2>"
}
]
}
],
{
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationActiveStatusExtension",
"valueBoolean": true
},
{
"start": "2000-01-01",
"end": "2001-01-01"
},
"url": "http://hl7.org/fhir/StructureDefinition/organization-period"
},
{
{
"code": "<code>",
"system": "<system>"
},
"url": "type"
},
{
"reference": "Organization/<logical ID>"
},
"url": "additionalRelationship"
}
],
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnitAdditionalRelationshipExtension"
}
],
"alias": [
"<alias1>",
"<alias2>"
],
"contact": [
{
"name": [
{
"text": "<name1>"
}
],
"purpose": {
"coding": [
{
"code": "<code1>",
"system": "<system1>"
}
]
},
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
},
"address": {
"line": [
"<line1>",
"<line2>"
],
"city": "<city>",
"postalCode": "<postalCode>",
"country": "<country>"
}
},
{
"name": [
{
"text": "<name2>"
}
],
"purpose": {
"coding": [
{
"code": "<code2>",
"system": "<system2>"
}
]
},
"telecom": [
{
"value": "<value>",
"system": "<code>"
}
],
"period": {
"start": "2000-01-01",
"end": "2001-01-01"
}
}
],
"partOf": {
"reference": "Organization/<logical ID>"
},
{
"resourceType": "HealthcareService",
"id": "business-template-1",
"meta": {
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOBusiness"
]
},
{
"coding": [
{
"system": "<system>",
"code": "<code2>"
}
]
}
],
{
{
"mon",
"tue"
],
"availableEndTime": "17:00:00",
"availableStartTime": "08:00:00",
"allDay": false
},
{
"wed",
"thu"
],
"allDay": true
}
],
{
"during": {
"end": "2002-02-02",
"start": "2002-01-01"
},
"description": "<description>"
},
{
"during": {
"end": "2003-02-02",
"start": "2003-01-01"
},
"description": "<description>"
}
]
}
],
{
"reference": "Location/<logical ID1>"
},
{
"reference": "Location/<logical ID2>"
}
],
"reference": "#"
}
}
],
"name": "<name>"
}
}
],
"type": "transaction"
}
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="HVOOrganizationTransactionBundle" />
<url value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationTransactionBundle" />
<version value="0.1.0" />
<name value="HVOOrganizationTransactionBundle" />
<title value="HVOOrganization with HVOOrganizationalUnits transaction Bundle" />
<status value="draft" />
<description value="HVO profile for Bundle consisting of HVOOrganization and HVOOrganizationalUnits with related resources to use for a transaction" />
<fhirVersion value="5.0.0" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<element id="Bundle.type">
<path value="Bundle.type" />
<fixedCode value="transaction" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<code value="Organization" />
<profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization" />
<profile value="http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit" />
</type>
<mustSupport value="true" />
</element>
<element id="Bundle.entry.resource.id">
<path value="Bundle.entry.resource.id" />
<short value="UUID of Organization" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.request">
<path value="Bundle.entry.request" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.request.method">
<path value="Bundle.entry.request.method" />
<short value="PUT | POST | PATCH" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.request.url">
<path value="Bundle.entry.request.url" />
<fixedUri value="Organization" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "HVOOrganizationTransactionBundle",
"url": "http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationTransactionBundle",
"version": "0.1.0",
"name": "HVOOrganizationTransactionBundle",
"title": "HVOOrganization with HVOOrganizationalUnits transaction Bundle",
"status": "draft",
"description": "HVO profile for Bundle consisting of HVOOrganization and HVOOrganizationalUnits with related resources to use for a transaction",
"fhirVersion": "5.0.0",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"element": [
{
"id": "Bundle.type",
"path": "Bundle.type",
"fixedCode": "transaction",
"mustSupport": true
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Organization",
"profile": [
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganization",
"http://electronichealth.se/fhir/hvo/StructureDefinition/HVOOrganizationalUnit"
]
}
],
"mustSupport": true
},
{
"id": "Bundle.entry.resource.id",
"path": "Bundle.entry.resource.id",
"short": "UUID of Organization",
"mustSupport": true
},
{
"id": "Bundle.entry.request",
"path": "Bundle.entry.request",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry.request.method",
"path": "Bundle.entry.request.method",
"short": "PUT | POST | PATCH",
"mustSupport": true
},
{
"id": "Bundle.entry.request.url",
"path": "Bundle.entry.request.url",
"fixedUri": "Organization",
"mustSupport": true
}
]
}
}

Details

The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.

The type element must be set to transaction. This makes sure that the server interprets the entries as being connected to each other.

The HVOOrganizationTransactionBundle must consist of at least one entry with a HVOOrganization or at least one entry with a HVOOrganizationalUnit. All resources must have the Organization.id element populated with a new unique UUID if the resource is being created or its existing UUID if it is being updated. To build up a hierarchy, use the Organization.partOf element to reference the id of the organization or organizational unit that is above a given member. Any entry that is not referenced to in this way and does not reference another entry in its partOf element will be ignored as it is interpreted as being outside the hierarchy.

For all resources that are being created, the request.method element of these entries must be set to POST. For all resources that are being updated, the request.method element of these entries must be set to PUT or PATCH.

Validation rules

See HVOOrganization and HVOOrganizationalUnit for the validation rules that apply for the entries in the Bundle.

Supported operations

HTTP methods

Operation Supported Invocation Comment
Search (GET, POST) no
Insert (POST) yes POST [base]/ Is used for both creating and updating resources in the Bundle. Set the entry.request.method field to POST for each resource that is going to get created.
Update (PUT/PATCH) no POST is used for updating resources in the Bundle. Set the entry.request.method field to PUT or PATCH for each resource that is going to get updated.
Delete (DEL) no
Operation (GET, POST) no