Complex
Primitive
ActivityDefinition
CapabilityStatement
CodeSystem
Composition
ConceptMap
Encounter
Library
List
Measure
MessageHeader
Observation
Patient
PlanDefinition
Questionnaire
Resource
ServiceDefinition
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for Bundle Resource
Bundle
Path
Bundle
Id
Bundle
Cardinality
0 - *
Definition
A container for a collection of resources.
Comment
Constraint
bdl-7 [error]
FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
bdl-9 [error]
A document must have an identifier with a system and a value
bdl-3 [error]
entry.request only for some types of bundles
bdl-4 [error]
entry.response only for some types of bundles
bdl-1 [error]
total only when a search or history
bdl-2 [error]
entry.search only when a search
Path
Bundle.identifier
Id
Bundle.identifier
Type
Cardinality
0 - 1
Definition
A persistent identifier for the batch that won't change as a batch is copied from server to server.
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.
Path
Bundle.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
Bundle.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
Bundle.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
Bundle.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
Bundle.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
Bundle.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
Bundle.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Condition
per-1
Path
Bundle.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Condition
per-1
Path
Bundle.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
Bundle.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Condition
ref-1
Path
Bundle.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Comment
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Path
Bundle.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Path
Bundle.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
type
document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Path
Bundle.type
Id
Bundle.type
Type
Cardinality
1 - 1
Definition
Indicates the purpose of this bundle - how it was intended to be used.
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.
Path
Bundle.total
Id
Bundle.total
Type
Cardinality
0 - 1
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).
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.
Condition
bdl-1
Path
Bundle.link
Id
Bundle.link
Type
Cardinality
0 - *
Definition
A series of links that provide context to this bundle.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
relation
See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Path
Bundle.link.relation
Id
Bundle.link.relation
Type
Cardinality
1 - 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).
Comment
Path
Bundle.link.url
Id
Bundle.link.url
Type
Cardinality
1 - 1
Definition
The reference details for the link.
Comment
Path
Bundle.entry
Id
Bundle.entry
Type
Cardinality
0 - *
Definition
An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
bdl-8 [error]
fullUrl cannot be a version specific reference
bdl-5 [error]
must be a resource unless there's a request or response
Path
Bundle.entry.link
Id
Bundle.entry.link
Type
Cardinality
0 - *
Definition
A series of links that provide context to this entry.
Comment
Path
Bundle.entry.fullUrl
Id
Bundle.entry.fullUrl
Type
Cardinality
0 - 1
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.
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.
Path
Bundle.entry.resource
Id
Bundle.entry.resource
Type
Cardinality
0 - 1
Definition
The Resources for the entry.
Comment
Path
Bundle.entry.search
Id
Bundle.entry.search
Type
Cardinality
0 - 1
Definition
Information about the search process that lead to the creation of this entry.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
bdl-2
Path
Bundle.entry.search.mode
Id
Bundle.entry.search.mode
Type
Cardinality
0 - 1
Definition
Why this entry is in the result set - whether it's included as a match or because of an _include requirement.
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.
Path
Bundle.entry.search.score
Id
Bundle.entry.search.score
Type
Cardinality
0 - 1
Definition
When searching, the server's search ranking score for the entry.
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.
Path
Bundle.entry.request
Id
Bundle.entry.request
Type
Cardinality
0 - 1
Definition
Additional information about how this entry should be processed as part of a transaction.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
bdl-3
Path
Bundle.entry.request.method
Id
Bundle.entry.request.method
Type
Cardinality
1 - 1
Definition
The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
Comment
Path
Bundle.entry.request.url
Id
Bundle.entry.request.url
Type
Cardinality
1 - 1
Definition
The URL for this entry, relative to the root (the address to which the request is posted).
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]".
Path
Bundle.entry.request.ifNoneMatch
Id
Bundle.entry.request.ifNoneMatch
Type
Cardinality
0 - 1
Definition
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Comment
Path
Bundle.entry.request.ifModifiedSince
Id
Bundle.entry.request.ifModifiedSince
Type
Cardinality
0 - 1
Definition
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Comment
Path
Bundle.entry.request.ifMatch
Id
Bundle.entry.request.ifMatch
Type
Cardinality
0 - 1
Definition
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Comment
Path
Bundle.entry.request.ifNoneExist
Id
Bundle.entry.request.ifNoneExist
Type
Cardinality
0 - 1
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 "?").
Comment
Path
Bundle.entry.response
Id
Bundle.entry.response
Type
Cardinality
0 - 1
Definition
Additional information about how this entry should be processed as part of a transaction.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
bdl-4
Path
Bundle.entry.response.status
Id
Bundle.entry.response.status
Type
Cardinality
1 - 1
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.
Comment
Path
Bundle.entry.response.location
Id
Bundle.entry.response.location
Type
Cardinality
0 - 1
Definition
The location header created by processing this operation.
Comment
Path
Bundle.entry.response.etag
Id
Bundle.entry.response.etag
Type
Cardinality
0 - 1
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)).
Comment
Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Path
Bundle.entry.response.lastModified
Id
Bundle.entry.response.lastModified
Type
Cardinality
0 - 1
Definition
The date/time that the resource was modified on the server.
Comment
This has to match the same time in the meta header if a resource is included.
Path
Bundle.entry.response.outcome
Id
Bundle.entry.response.outcome
Type
Cardinality
0 - 1
Definition
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
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.
Path
Bundle.signature
Id
Bundle.signature
Type
Cardinality
0 - 1
Definition
Digital Signature - base64 encoded. XML-DSIg or a JWT.
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.
Requirements
This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.
Path
Bundle.signature.Signature.type
Id
Signature.type
Type
Cardinality
1 - *
Definition
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
Comment
Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".
Path
Bundle.signature.Signature.type.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Path
Bundle.signature.Signature.type.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Path
Bundle.signature.Signature.type.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Path
Bundle.signature.Signature.type.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Path
Bundle.signature.Signature.type.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Path
Bundle.signature.Signature.when
Id
Signature.when
Type
Cardinality
1 - 1
Definition
When the digital signature was signed.
Comment
This should agree with the information in the signature.
Path
Bundle.signature.Signature.who[x]
Id
Signature.who[x]
Type
Cardinality
1 - 1
Definition
A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
Comment
This should agree with the information in the signature.
Path
Bundle.signature.Signature.onBehalfOf[x]
Id
Signature.onBehalfOf[x]
Type
Cardinality
0 - 1
Definition
A reference to an application-usable description of the identity that is represented by the signature.
Comment
The party that can't sign. For example a child.
Requirements
used when the signature is on behalf of a non-signer.
Path
Bundle.signature.Signature.contentType
Id
Signature.contentType
Type
Cardinality
0 - 1
Definition
A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature, etc.
Comment
Path
Bundle.signature.Signature.blob
Id
Signature.blob
Type
Cardinality
0 - 1
Definition
The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
Comment
Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form.