| BundleEDNotes (Bundle) | C | | Bundle | There are no (further) constraints on this element Element idBundle Short descriptionContains a collection of resources DefinitionA container for a collection of resources.
Data typeBundle Constraints- bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() - bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists()) - bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
type = 'document' implies issues.empty() - bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning') - bdl-18: Self link is required for searchsets.
type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() - bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) - bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader) - bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') - bdl-14: entry.request.method PATCH not allowed for history
type = 'history' implies entry.request.method != 'PATCH' - bdl-11: A document must have a Composition as the first resource
type = 'document' implies entry.first().resource.is(Composition) - bdl-10: A document must have a date
type = 'document' implies (timestamp.hasValue()) - bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
type in ('transaction-response' | 'batch-response') implies entry.all(response.exists()) - bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history') - bdl-2: entry.search only when a search
(type = 'searchset') or entry.search.empty() - bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty()) - bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) - bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists())) Mappings- rim: n/a
- rim: Entity. Role, or Act
- w5: infrastructure.structure
- v2: N/A
- rim: N/A
- cda: ClinicalDocument, if bundle.type = document
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsWithin the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Data typeid Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.meta Short descriptionMetadata about the resource DefinitionThe 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 typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBundle.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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 typecode BindingIETF language tag for a human language
AllLanguages (required) Additional bindingsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| identifier | Σ C | 0..1 | Identifier | There are no (further) constraints on this element Element idBundle.identifier Short descriptionPersistent identifier for the bundle DefinitionA persistent identifier for the bundle that won't change as a bundle is copied from server to server.
CommentsPersistent 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 typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-9 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
value.exists() Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- w5: FiveWs.identifier
- cda: ClinicalDocument.id
|
| type | Σ C | 1..1 | codeBindingPattern | Element idBundle.type Short descriptiondocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification DefinitionIndicates the purpose of this bundle - how it is intended to be used.
CommentsIt'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 typecode BindingIndicates the purpose of a bundle - how it is intended to be used.
BundleType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-1, bdl-2, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-17, bdl-18 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Patterndocument Mappings |
| timestamp | Σ C | 0..1 | instant | There are no (further) constraints on this element Element idBundle.timestamp Short descriptionWhen the bundle was assembled DefinitionThe date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
CommentsFor 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 typeinstant ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-10 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a
- w5: FiveWs.init
- cda: ClinicalDocument.effectiveTime
|
| total | Σ C | 0..1 | unsignedInt | There are no (further) constraints on this element Element idBundle.total Short descriptionIf search, the total number of matches DefinitionIf a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
CommentsOnly 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 typeunsignedInt ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| link | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.link Short descriptionLinks related to this Bundle DefinitionA series of links that provide context to this bundle.
CommentsBoth Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.
This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.link.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.link.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| relation | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.link.relation Short descriptionSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 DefinitionCommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typecode BindingLinkRelationTypes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| url | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idBundle.link.url Short descriptionReference details for the link DefinitionThe reference details for the link.
Commentssee http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-18 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| entry | Σ C | 1..* | BackboneElement | Element idBundle.entry Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement SlicingUnordered, Open, by resource(Profile) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| (All Slices) | | | | The requirements in this element apply to all slices |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.resource Short descriptionA resource in the bundle DefinitionThe Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.
Data typeResource ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Mappings- rim: n/a
- rim: Entity. Role, or Act
|
| search | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.search.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.search.mode Short descriptionmatch | include - why this is in the result set DefinitionWhy 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.
CommentsThere 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 typecode BindingWhy an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
SearchEntryMode (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.score Short descriptionSearch ranking (between 0 and 1) DefinitionWhen searching, the server's search ranking score for the entry.
CommentsServers 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 typedecimal Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| method | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.method Short descriptionGET | HEAD | POST | PUT | DELETE | PATCH DefinitionIn 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.
CommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typecode BindingHTTP verbs (in the HTTP command line). See HTTP rfc for details.
HTTPVerb (required) ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3b, bdl-3c, bdl-14, bdl-15 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idBundle.entry.request.url Short descriptionURL for HTTP equivalent of this entry DefinitionThe URL for this entry, relative to the root (the address to which the request is posted).
CommentsE.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 typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatch Short descriptionFor managing cache validation DefinitionIf the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
CommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSince Short descriptionFor managing cache currency DefinitionOnly perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
CommentsNote: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. UTC offset is always required
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatch Short descriptionFor managing update contention DefinitionCommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExist Short descriptionFor conditional creates DefinitionInstruct 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 "?").
CommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.status Short descriptionStatus response code (text optional) DefinitionThe 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.
CommentsNote that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.location Short descriptionThe location (if the operation returns a location) DefinitionThe location header created by processing this operation, populated if the operation returns a location.
Commentssee http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etag Short descriptionThe Etag for the resource (if relevant) DefinitionCommentsEtags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModified Short descriptionServer's date time modified DefinitionThe date/time that the resource was modified on the server.
CommentsThis has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcome Short descriptionOperationOutcome with hints and warnings (for batch/transaction) DefinitionAn OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
CommentsFor 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 typeResource Mappings- rim: n/a
- rim: Entity. Role, or Act
|
| ednotes | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:ednotes Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:ednotes.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:ednotes.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:ednotes.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:ednotes.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:ednotes.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | EDNotes | Element idBundle.entry:ednotes.resource Short descriptionA set of resources composed into a single coherent clinical statement with clinical attestation DefinitionA set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
CommentsWhile the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
Data typeEDNotes ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: infrastructure.documents
- rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
- cda: ClinicalDocument
- fhirdocumentreference: when described by DocumentReference
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:ednotes.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:ednotes.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:ednotes.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| edvisit | Σ C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:edvisit Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:edvisit.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:edvisit.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:edvisit.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:edvisit.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:edvisit.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | Encounter | Element idBundle.entry:edvisit.resource Short descriptionAn interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.
Data typeEncounter ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: workflow.encounter
- rim: PatientEncounter[@moodCode='EVN']
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:edvisit.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:edvisit.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:edvisit.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| observation | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:observation Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:observation.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:observation.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:observation.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:observation.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:observation.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | Observation | Element idBundle.entry:observation.resource Short descriptionMeasurements and simple assertions Alternate namesVital Signs, Measurement, Results, Tests DefinitionMeasurements and simple assertions made about a patient, device or other subject.
CommentsUsed for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.
Data typeObservation ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - obs-7: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value).
value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() - obs-8: bodyStructure SHALL only be present if Observation.bodySite is not present
bodySite.exists() implies bodyStructure.empty() - obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: clinical.diagnostics
- sct-concept: < 363787002 |Observable entity|
- v2: OBX
- rim: Observation[classCode=OBS, moodCode=EVN]
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:observation.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:observation.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:observation.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| prescriptionorder | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | PrescriptionOrder | Element idBundle.entry:prescriptionorder.resource Short descriptionOrdering of medication for patient or group Alternate namesPrescription, Order DefinitionAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
Data typePrescriptionOrder ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Request
- script10.6: Message/Body/NewRx
- w5: clinical.medication
- rim: CombinedMedicationRequest
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:prescriptionorder.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| medicationadministration | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationadministration Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | MedicationAdministration | Element idBundle.entry:medicationadministration.resource Short descriptionAdministration of medication to a patient DefinitionDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
Data typeMedicationAdministration ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: clinical.medication
- rim: SubstanceAdministration
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicationadministration.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| procedure | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:procedure Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:procedure.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:procedure.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:procedure.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:procedure.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:procedure.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | Procedure | Element idBundle.entry:procedure.resource Short descriptionAn action that is being or was performed on an individual or entity DefinitionAn action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.
Data typeProcedure ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: clinical.general
- rim: Procedure[moodCode=EVN]
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:procedure.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:procedure.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:procedure.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| medicalcertificate | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | MedicalCertificate | Element idBundle.entry:medicalcertificate.resource Short descriptionA reference to a document DefinitionA reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
CommentsUsually, this is used for documents other than those defined by FHIR.
Data typeMedicalCertificate ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - docRef-1: facilityType SHALL only be present if context is not an encounter
facilityType.empty() or context.where(resolve() is Encounter).empty() - docRef-2: practiceSetting SHALL only be present if context is not present
practiceSetting.empty() or context.where(resolve() is Encounter).empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: infrastructure.documents
- fhircomposition: when describing a Composition
- rim: Document[classCode="DOC" and moodCode="EVN"]
- xds: DocumentEntry
- cda: when describing a CDA
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:medicalcertificate.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| allergyintolerance | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | AllergyIntolerance | Element idBundle.entry:allergyintolerance.resource Short descriptionAllergy or Intolerance (generally: Risk of adverse reaction to a substance) Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionRisk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance.
CommentsSubstances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.
Data typeAllergyIntolerance ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- w5: clinical.general
- rim: Observation[classCode=OBS, moodCode=EVN]
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:allergyintolerance.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| flag | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:flag Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:flag.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:flag.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:flag.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:flag.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:flag.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | Flag | Element idBundle.entry:flag.resource Short descriptionKey information to flag to healthcare providers Alternate namesBarriers to Care, Alert, Warning DefinitionProspective warnings of potential issues when providing care to the patient.
Data typeFlag ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- w5: workflow.encounter
- rim: Observation[classCode=ISSUE, moodCode=EVN]
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:flag.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:flag.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:flag.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| fileattachment | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:fileattachment Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:fileattachment.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:fileattachment.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:fileattachment.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:fileattachment.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:fileattachment.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | FileAttachment | Element idBundle.entry:fileattachment.resource Short descriptionA reference to a document DefinitionA reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
CommentsUsually, this is used for documents other than those defined by FHIR.
Data typeFileAttachment ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - docRef-1: facilityType SHALL only be present if context is not an encounter
facilityType.empty() or context.where(resolve() is Encounter).empty() - docRef-2: practiceSetting SHALL only be present if context is not present
practiceSetting.empty() or context.where(resolve() is Encounter).empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: infrastructure.documents
- fhircomposition: when describing a Composition
- rim: Document[classCode="DOC" and moodCode="EVN"]
- xds: DocumentEntry
- cda: when describing a CDA
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:fileattachment.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:fileattachment.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:fileattachment.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| stepprocedure | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:stepprocedure Short descriptionEntry in the bundle - will have a resource or information DefinitionAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - bdl-8: fullUrl cannot be a version specific reference
fullUrl.exists() implies fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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 typeExtension SlicingUnordered, 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier 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.
CommentsThere 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 typeExtension 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 |
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.link Short descriptionLinks related to this entry DefinitionA series of links that provide context to this entry.
|
| fullUrl | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.fullUrl Short descriptionURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) DefinitionThe Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
- invoking a create
- invoking or responding to an operation where the body is not a single identified resource
- invoking or returning the results of a search or history operation.
CommentsfullUrl 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 typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-7, bdl-15, bdl-8 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| resource | Σ C | 1..1 | ProcedureStep | Element idBundle.entry:stepprocedure.resource Short descriptionAn action that is being or was performed on an individual or entity DefinitionAn action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.
Data typeProcedureStep ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3c, bdl-7, bdl-11, bdl-12, bdl-13, bdl-5 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- workflow: Event
- w5: clinical.general
- rim: Procedure[moodCode=EVN]
|
| search | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.search Short descriptionSearch related information DefinitionInformation about the search process that lead to the creation of this entry.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| request | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.request Short descriptionAdditional execution information (transaction/batch/history) DefinitionAdditional 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| response | Σ C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:stepprocedure.response Short descriptionResults of execution (transaction/batch/history) DefinitionIndicates 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 typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-3a, bdl-3b, bdl-3d, bdl-5 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| signature | Σ | 0..1 | Signature | There are no (further) constraints on this element Element idBundle.signature Short descriptionDigital Signature DefinitionDigital Signature - base64 encoded. XML-DSig or a JWS.
RequirementsA 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.
CommentsThe 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 typeSignature Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
| issues | Σ C | 0..1 | OperationOutcome | There are no (further) constraints on this element Element idBundle.issues Short descriptionIssues with the Bundle DefinitionCaptures issues and warnings that relate to the construction of the Bundle and the content within it.
CommentsUsage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.
Data typeOperationOutcome ConditionsThe cardinality or value of this element may be affected by these constraints: bdl-16, bdl-17 Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() Mappings- rim: n/a
- rim: Entity. Role, or Act
- rim: Entity, Role, or Act
- w5: infrastructure.exchange
- rim: Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)
|