Alberta eOrder Laboratory Implementation Guide 1.0.0

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
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
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&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)
abeorderlab-bdl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following details SHALL NOT be present in all resources within the bundle instance except the bundle itself: contained
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab') implies Bundle.entry.resource.where(contained.exists()).exists().not()
abeorderlab-bdl-dcr-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following DocumentReference details SHALL NOT be present: authenticator, custodian, relatesTo. context.encounter
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is DocumentReference).resource.where(authenticator.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(custodian.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(relatesTo.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(context.encounter.exists()).exists().not()
abeorderlab-bdl-hcs-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following HealthcareService details SHALL NOT be present: photo
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is HealthcareService).resource.where(photo.exists()).exists().not()
abeorderlab-bdl-loc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Location details SHALL NOT be present: telecom.use, and address.use, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Location).resource.where(telecom.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(address.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-msh-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following MessageHeader details SHALL be present: destination
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is MessageHeader).resource.where(destination.exists()).exists()
abeorderlab-bdl-pat-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL NOT be present: text, active, address.text, maritalStatus, multipleBirth, photo, contact.gender, contact.organization, contact.period, generalPractitioner, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Patient).resource.where(text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(active.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(address.text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(maritalStatus.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(multipleBirth.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.gender.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.organization.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.period.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(generalPractitioner.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-pat-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL be present: telecom:Phone
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(Patient).all(telecom.where(system = 'phone').exists())
abeorderlab-bdl-prc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Practitioner details SHALL NOT be present: photo, qualification, birthDate
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Practitioner).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(qualification.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(birthDate.exists()).exists().not()
abeorderlab-bdl-prl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL NOT be present: healtcareService
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(healthcareService.exists()).exists().not()
abeorderlab-bdl-prl-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL be present: specialty.coding.code
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(specialty.coding.code.exists()).exists()
abeorderlab-bdl-srq-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following ServiceRequest details SHALL NOT be present: replaces, reasonReference, relevantHistory
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is ServiceRequest).resource.where(replaces.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(encounter.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(reasonReference.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(insurance.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(relevantHistory.exists()).exists().not()
abeorderlab-bdl-srq-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the ServiceRequest.identifier.value (aka placer order number) must be unique within the Bundle
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(ServiceRequest).identifier.where(system = 'https://fhir.alberta.ca/NamingSystem/ca-ab-order-lab-placer-order-id').value.isDistinct()

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.id

Short description

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

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

Bundle.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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 manageable, 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.

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.

Data type

https://www.alberta.ca/fhir/psab/StructureDefinition/ext-EntityIdentifierAndName

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

submissionMetadata

S C

1..*

Extension(Complex)

Element id

Bundle.meta.extension:submissionMetadata

Short description

Entity Identifier and Name

Alternate names

extensions, user content

Definition

An extension that contains an entity identifier and name for use in the context of a Bundle

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

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
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastUpdated

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

source

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

profile

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

security

S Σ

0..*

CodingBinding

Element id

Bundle.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

SecurityLabel (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

tag

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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 it's narrative along with other profiles, value sets, etc.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

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

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.

Data type

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

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Identifier Type Codes (extensible)

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

type

S Σ

1..1

codeBindingPattern

There are no (further) constraints on this element

Element id

Bundle.type

Short description

Definition

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

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.

Data type

Binding

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

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

message

Mappings

w5: FiveWs.class

timestamp

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

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

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.

Data type

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

total

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

If a set of search matches, this is the 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.

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.

Data type

Conditions

The 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())

link

0..*

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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 manageable, 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).

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

Data type

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

relation

1..1

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

S Σ C

2..*

There are no (further) constraints on this element

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

Slicing

Unordered, Open, by resource(Profile)

The specific bundle entries that are needed for an eReC Message Bundle.

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. 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. 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.

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

request

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Message

S Σ C

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Message.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Message.resource

Short description

A resource that describes a message that is exchanged between systems

Definition

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Comments

MessageHeader resources included in Alberta eOrder Laboratory Bundles have rules that certain attributes are not to be contained in MessageHeader resources. These are mechanically enforced through invariants at the AB:eOrder-Lab Bundle level.

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneExist

Short description

For conditional creates

Definition

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

Focus

S Σ C

1..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Focus.resource

Short description

A request for a service to be performed

Alternate names

diagnostic request, referral, referral request, transfer of care request

Definition

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Comments

ServiceRequest resources included in Alberta eOrder Laboratory Bundles have rules that certain attributes are not to be contained in QuestionnaireResponse resources. These are mechanically enforced through invariants at the AB:eOrder-Lab Bundle level.

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
prr-1: orderDetail SHALL only be present if code is present
orderDetail.empty() or code.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
v2: ORC
rim: Act[moodCode<=INT]

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

signature

0..1

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

BundleABeOrderLab (Bundle)

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

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
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
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&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)
abeorderlab-bdl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following details SHALL NOT be present in all resources within the bundle instance except the bundle itself: contained
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab') implies Bundle.entry.resource.where(contained.exists()).exists().not()
abeorderlab-bdl-dcr-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following DocumentReference details SHALL NOT be present: authenticator, custodian, relatesTo. context.encounter
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is DocumentReference).resource.where(authenticator.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(custodian.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(relatesTo.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(context.encounter.exists()).exists().not()
abeorderlab-bdl-hcs-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following HealthcareService details SHALL NOT be present: photo
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is HealthcareService).resource.where(photo.exists()).exists().not()
abeorderlab-bdl-loc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Location details SHALL NOT be present: telecom.use, and address.use, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Location).resource.where(telecom.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(address.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-msh-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following MessageHeader details SHALL be present: destination
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is MessageHeader).resource.where(destination.exists()).exists()
abeorderlab-bdl-pat-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL NOT be present: text, active, address.text, maritalStatus, multipleBirth, photo, contact.gender, contact.organization, contact.period, generalPractitioner, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Patient).resource.where(text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(active.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(address.text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(maritalStatus.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(multipleBirth.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.gender.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.organization.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.period.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(generalPractitioner.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-pat-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL be present: telecom:Phone
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(Patient).all(telecom.where(system = 'phone').exists())
abeorderlab-bdl-prc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Practitioner details SHALL NOT be present: photo, qualification, birthDate
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Practitioner).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(qualification.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(birthDate.exists()).exists().not()
abeorderlab-bdl-prl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL NOT be present: healtcareService
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(healthcareService.exists()).exists().not()
abeorderlab-bdl-prl-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL be present: specialty.coding.code
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(specialty.coding.code.exists()).exists()
abeorderlab-bdl-srq-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following ServiceRequest details SHALL NOT be present: replaces, reasonReference, relevantHistory
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is ServiceRequest).resource.where(replaces.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(encounter.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(reasonReference.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(insurance.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(relevantHistory.exists()).exists().not()
abeorderlab-bdl-srq-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the ServiceRequest.identifier.value (aka placer order number) must be unique within the Bundle
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(ServiceRequest).identifier.where(system = 'https://fhir.alberta.ca/NamingSystem/ca-ab-order-lab-placer-order-id').value.isDistinct()

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.id

Short description

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

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

Bundle.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://www.alberta.ca/fhir/psab/StructureDefinition/ext-EntityIdentifierAndName

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

submissionMetadata

S C

1..*

Extension(Complex)

Element id

Bundle.meta.extension:submissionMetadata

Short description

Entity Identifier and Name

Alternate names

extensions, user content

Definition

An extension that contains an entity identifier and name for use in the context of a Bundle

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

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
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastUpdated

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

source

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

profile

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

security

S Σ

0..*

CodingBinding

Element id

Bundle.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

SecurityLabel (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

tag

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.tag

Short description

Tags applied to this resource

Definition

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

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

Comments

Data type

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

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Identifier Type Codes (extensible)

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

type

S Σ

1..1

codeBindingPattern

There are no (further) constraints on this element

Element id

Bundle.type

Short description

Definition

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

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.

Data type

Binding

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

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

message

Mappings

w5: FiveWs.class

timestamp

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

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

Comments

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.

Data type

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

total

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

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.

Data type

Conditions

The 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())

link

0..*

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

relation

1..1

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

S Σ C

2..*

There are no (further) constraints on this element

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

Slicing

Unordered, Open, by resource(Profile)

The specific bundle entries that are needed for an eReC Message Bundle.

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

request

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Message

S Σ C

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Message.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Message.resource

Short description

A resource that describes a message that is exchanged between systems

Definition

Comments

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

Focus

S Σ C

1..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Focus.resource

Short description

A request for a service to be performed

Alternate names

diagnostic request, referral, referral request, transfer of care request

Definition

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Comments

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
prr-1: orderDetail SHALL only be present if code is present
orderDetail.empty() or code.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
v2: ORC
rim: Act[moodCode<=INT]

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

signature

0..1

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

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

Requirements

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

BundleABeOrderLab (Bundle)

Element id

Bundle

Short description

Contains a collection of resources

Definition

A container for a collection of resources.

Data type

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
entry.search.empty() or (type = 'searchset')
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
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&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)
abeorderlab-bdl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following details SHALL NOT be present in all resources within the bundle instance except the bundle itself: contained
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab') implies Bundle.entry.resource.where(contained.exists()).exists().not()
abeorderlab-bdl-dcr-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following DocumentReference details SHALL NOT be present: authenticator, custodian, relatesTo. context.encounter
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is DocumentReference).resource.where(authenticator.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(custodian.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(relatesTo.exists()).exists().not() and Bundle.entry.where(resource is DocumentReference).resource.where(context.encounter.exists()).exists().not()
abeorderlab-bdl-hcs-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following HealthcareService details SHALL NOT be present: photo
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is HealthcareService).resource.where(photo.exists()).exists().not()
abeorderlab-bdl-loc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Location details SHALL NOT be present: telecom.use, and address.use, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Location).resource.where(telecom.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(address.use.exists()).exists().not() and Bundle.entry.where(resource is Location).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-msh-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following MessageHeader details SHALL be present: destination
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is MessageHeader).resource.where(destination.exists()).exists()
abeorderlab-bdl-pat-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL NOT be present: text, active, address.text, maritalStatus, multipleBirth, photo, contact.gender, contact.organization, contact.period, generalPractitioner, managingOrganization
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Patient).resource.where(text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(active.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(address.text.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(maritalStatus.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(multipleBirth.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.gender.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.organization.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(contact.period.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(generalPractitioner.exists()).exists().not() and Bundle.entry.where(resource is Patient).resource.where(managingOrganization.exists()).exists().not()
abeorderlab-bdl-pat-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Patient details SHALL be present: telecom:Phone
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(Patient).all(telecom.where(system = 'phone').exists())
abeorderlab-bdl-prc-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following Practitioner details SHALL NOT be present: photo, qualification, birthDate
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is Practitioner).resource.where(photo.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(qualification.exists()).exists().not() and Bundle.entry.where(resource is Practitioner).resource.where(birthDate.exists()).exists().not()
abeorderlab-bdl-prl-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL NOT be present: healtcareService
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(healthcareService.exists()).exists().not()
abeorderlab-bdl-prl-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following PractitionerRole details SHALL be present: specialty.coding.code
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is PractitionerRole).resource.where(specialty.coding.code.exists()).exists()
abeorderlab-bdl-srq-1: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the following ServiceRequest details SHALL NOT be present: replaces, reasonReference, relevantHistory
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.where(resource is ServiceRequest).resource.where(replaces.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(encounter.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(reasonReference.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(insurance.exists()).exists().not() and Bundle.entry.where(resource is ServiceRequest).resource.where(relevantHistory.exists()).exists().not()
abeorderlab-bdl-srq-2: If Bundle.meta.extension.extension.valueString = 'AB:eOrder-Lab', then the ServiceRequest.identifier.value (aka placer order number) must be unique within the Bundle
Bundle.meta.extension.extension.where(valueString = 'AB:eOrder-Lab').exists() implies Bundle.entry.resource.ofType(ServiceRequest).identifier.where(system = 'https://fhir.alberta.ca/NamingSystem/ca-ab-order-lab-placer-order-id').value.isDistinct()

Mappings

rim: Entity. Role, or Act
v2: N/A
rim: N/A
cda: ClinicalDocument, if bundle.type = document

0..1

There are no (further) constraints on this element

Element id

Bundle.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

There are no (further) constraints on this element

Element id

Bundle.meta

Short description

Metadata about the resource

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.id

Short description

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

Data type

Mappings

rim: n/a

extension

1..*

There are no (further) constraints on this element

Element id

Bundle.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://www.alberta.ca/fhir/psab/StructureDefinition/ext-EntityIdentifierAndName

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

submissionMetadata

S C

1..*

Extension(Complex)

Element id

Bundle.meta.extension:submissionMetadata

Short description

Entity Identifier and Name

Alternate names

extensions, user content

Definition

An extension that contains an entity identifier and name for use in the context of a Bundle

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

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
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastUpdated

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

source

0..1

There are no (further) constraints on this element

Element id

Bundle.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

profile

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

security

S Σ

0..*

CodingBinding

Element id

Bundle.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

SecurityLabel (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

tag

0..*

There are no (further) constraints on this element

Element id

Bundle.meta.tag

Short description

Tags applied to this resource

Definition

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Bundle.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

identifier

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier

Short description

Persistent identifier for the bundle

Definition

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

Comments

Data type

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

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Identifier Type Codes (extensible)

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Bundle.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Bundle.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

type

S Σ

1..1

codeBindingPattern

There are no (further) constraints on this element

Element id

Bundle.type

Short description

Definition

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

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.

Data type

Binding

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

BundleType (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

message

Mappings

w5: FiveWs.class

timestamp

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.timestamp

Short description

When the bundle was assembled

Definition

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

Comments

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.

Data type

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

total

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.total

Short description

If search, the total number of matches

Definition

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.

Data type

Conditions

The 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())

link

0..*

There are no (further) constraints on this element

Element id

Bundle.link

Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.link.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.link.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.link.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

relation

1..1

There are no (further) constraints on this element

Element id

Bundle.link.relation

Short description

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

Definition

A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.link.url

Short description

Reference details for the link

Definition

The reference details for the link.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

entry

S Σ C

2..*

There are no (further) constraints on this element

Element id

Bundle.entry

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

Slicing

Unordered, Open, by resource(Profile)

The specific bundle entries that are needed for an eReC Message Bundle.

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

Bundle.entry.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

S Σ

1..1

There are no (further) constraints on this element

Element id

Bundle.entry.resource

Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

request

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..0

There are no (further) constraints on this element

Element id

Bundle.entry.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Message

S Σ C

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Message.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Message.resource

Short description

A resource that describes a message that is exchanged between systems

Definition

Comments

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()

Mappings

rim: Entity. Role, or Act
v2: MSH / MSA / ERR
rim: Message

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Message.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

Focus

S Σ C

1..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus

Short description

Entry in the bundle - will have a resource or information

Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Data type

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.contains('/_history/').not()
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

link

0..*

see (link)

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.link

Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

fullUrl

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.fullUrl

Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

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.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

resource

0..1

Element id

Bundle.entry:Focus.resource

Short description

A request for a service to be performed

Alternate names

diagnostic request, referral, referral request, transfer of care request

Definition

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Comments

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
prr-1: orderDetail SHALL only be present if code is present
orderDetail.empty() or code.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
v2: ORC
rim: Act[moodCode<=INT]

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search

Short description

Search related information

Definition

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

Data type

Conditions

The 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())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

mode

0..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.mode

Short description

match | include | outcome - why this is in the result set

Definition

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

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.

Data type

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.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

score

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.search.score

Short description

Search ranking (between 0 and 1)

Definition

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

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

request

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

method

1..1

codeBinding

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.method

Short description

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.

Data type

Binding

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

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

url

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.url

Short description

URL for HTTP equivalent of this entry

Definition

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

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]".

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneMatch

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifModifiedSince

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifModifiedSince

Short description

For managing cache currency

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifMatch

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifMatch

Short description

For managing update contention

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

ifNoneExist

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.request.ifNoneExist

Short description

For conditional creates

Definition

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

response

Σ C

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response

Short description

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: bdl-4

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.id

Short description

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

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

status

1..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.status

Short description

Status response code (text optional)

Definition

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

location

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.location

Short description

The location (if the operation returns a location)

Definition

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

etag

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.etag

Short description

The 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).

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastModified

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.lastModified

Short description

Server's date time modified

Definition

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

Comments

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

outcome

0..1

There are no (further) constraints on this element

Element id

Bundle.entry:Focus.response.outcome

Short description

OperationOutcome with hints and warnings (for batch/transaction)

Definition

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

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.

Data type

signature

0..1

There are no (further) constraints on this element

Element id

Bundle.signature

Short description

Digital Signature

Definition

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

Requirements

Comments

Data type