| Bundle | I | | Bundle | Element idShort description Contains a collection of resources Definition A container for a collection of resources.
Bundle 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&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-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) - bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) - bdl-12: A message must have a MessageHeader as the first resource
type = 'message' implies entry.first().resource.is(MessageHeader) - bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history') - bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset') - bdl-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()) - -eeb-angabePatientPLZ: In der Ressource vom Typ Patient ist keine Postleitzahl vorhanden, diese ist aber eine Pflichtangabe.
entry.where(resource is Patient).resource.address.postalCode.exists()
- rim: Entity. Role, or Act
- v2: N/A
- rim: N/A
- cda: ClinicalDocument, if bundle.type = document
|
| id | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
string |
| meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idShort description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
id Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idShort description When the resource version last changed Definition When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
instant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idShort description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| profile | Σ | 1..1 | canonical(StructureDefinition)Fixed Value | Element idShort description Profiles this resource claims to conform to Definition Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
canonical(StructureDefinition) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
https://gematik.de/fhir/eeb/StructureDefinition/EEBBescheinigungBundle |
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idShort description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Security Labels from the Healthcare Privacy and Security Classification System.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idShort description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idShort description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idShort description Persistent identifier for the bundle Definition A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.identifier.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idShort description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code Binding Identifies the purpose for this identifier, if known .
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: N/A
- rim: Role.code or implied by context
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idShort description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Allows users to make use of identifiers when the identifier system is not known.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: CX.5
- rim: Role.code or implied by context
|
| system | Σ | 1..1 | uriFixed Value | Element idShort description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier.system is always case sensitive.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
| value | Σ | 1..1 | string | Element idShort description Eindeutige UUID als übergreifender Identifier für mehrere Anfragen eines Vorgangs Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
|
| period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element idShort description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
| assigner | Σ I | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idBundle.identifier.assigner Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
| type | Σ | 1..1 | codeBindingFixed Value | Element idShort description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Definition Indicates the purpose of this bundle - how it is intended to be used.
It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
code Binding Indicates the purpose of a bundle - how it is intended to be used.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| timestamp | Σ | 1..1 | instant | There are no (further) constraints on this element Element idShort description When the bundle was assembled Definition The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.
Usage:
- document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
- message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
- history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
- searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
- transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.
instant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- w5: FiveWs.init
- cda: ClinicalDocument.effectiveTime
|
| total | Σ I | 0..0 | unsignedInt | There are no (further) constraints on this element Element idShort description If search, the total number of matches Definition If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.
unsignedInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| link | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idShort description Links related to this Bundle Definition A series of links that provide context to this bundle.
Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.
This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| entry | Σ I | 3..3 | BackboneElement | Element idShort description Entry in the bundle - will have a resource or information Definition An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
BackboneElement Sliced: Unordered, Closed, 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.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
|
| (All Slices) | | | | There are no (further) constraints on this element |
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| link | Σ | 0..* | see (link) | There are no (further) constraints on this element Element idShort description Links related to this entry Definition A series of links that provide context to this entry.
|
| fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idShort description URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
- fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
- Results from operations might involve resources that are not identified.
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| resource | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idShort description A resource in the bundle Definition The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
Resource Mappings- rim: Entity. Role, or Act
|
| search | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idShort description Search related information Definition Information about the search process that lead to the creation of this entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.search.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| mode | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description match | include | outcome - why this is in the result set Definition Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.
code Binding Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| score | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idBundle.entry.search.score Search ranking (between 0 and 1) Definition When searching, the server's search ranking score for the entry.
Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.
See Patient Match for the EMPI search which relates to this element.
decimal Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| request | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idShort description Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.request.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| method | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.entry.request.method GET | HEAD | POST | PUT | DELETE | PATCH Definition In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding HTTP verbs (in the HTTP command line). See HTTP rfc for details.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idShort description URL for HTTP equivalent of this entry Definition The URL for this entry, relative to the root (the address to which the request is posted).
E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]".
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| ifNoneMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneMatch For managing cache currency Definition If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read".
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| ifModifiedSince | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.request.ifModifiedSince For managing cache currency Definition Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read".
Note: 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. Time zone is always required
instant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| ifMatch | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifMatch For managing update contention Definition Comments Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| ifNoneExist | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.request.ifNoneExist For conditional creates Definition Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?").
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| response | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idShort description Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry.response.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| status | Σ | 1..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.status Status response code (text optional) Definition The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| location | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry.response.location The location (if the operation returns a location) Definition The location header created by processing this operation, populated if the operation returns a location.
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| etag | Σ | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry.response.etag The Etag for the resource (if relevant) Definition Comments Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| lastModified | Σ | 0..1 | instant | There are no (further) constraints on this element Element idBundle.entry.response.lastModified Server's date time modified Definition The date/time that the resource was modified on the server.
This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.
instant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| outcome | Σ | 0..1 | Resource | There are no (further) constraints on this element Element idBundle.entry.response.outcome OperationOutcome with hints and warnings (for batch/transaction) Definition An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.
This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.
Resource Mappings- rim: Entity. Role, or Act
|
| KBVFORPatient | Σ I | 1..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient Entry in the bundle - will have a resource or information Definition An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
BackboneElement 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.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.link Links related to this entry Definition A series of links that provide context to this entry.
|
| fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
- fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
- Results from operations might involve resources that are not identified.
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| resource | Σ I | 1..1 | KBV_PR_FOR_Patient | Element idBundle.entry:KBVFORPatient.resource Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Dieses Element beschreibt eine Person, die eine oder mehrere medizinische Leistungen in Anspruch nimmt.
KBV_PR_FOR_Patient 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-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() - pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() - -for-adresszeilenAufbauPatientRessource-1: Falls die erste Adresszeile einen Straßennamen und eine Hausnummer besitzt, sind diese zusammen im Element 'line' mit einem Leerzeichen getrennt anzugeben.
(address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists() and address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists()) implies address.line[0] = (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').value as string) + ' ' + (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').value as string) - -for-adresszeilenAufbauPatientRessource-2: Falls die erste Adresszeile keinen Straßennamen und eine Hausnummer besitzt, ist letztere im Element 'line' anzugeben.
(address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists() and address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists().not()) implies address.line[0] = (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').value as string) - -for-adresszeilenAufbauPatientRessource-3: Falls die erste Adresszeile keine Hausnummer und einen Straßennamen besitzt, ist letzterer im Element 'line' anzugeben.
(address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists().not() and address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists()) implies address.line[0] = (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').value as string) - -for-adresszeilenAufbauPatientRessource-4: Falls eine Adresszeile einen Adresszusatz besitzt, ist dieser im Element 'line' anzugeben.
(address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').exists() implies address.line[0] = (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').value as string)) and (address.line[1].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').exists() implies address.line[1] = (address.line[1].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').value as string)) - -for-adresszeilenAufbauPatientRessource-5: Falls die erste Adresszeile ein Postfach besitzt, ist dieses im Element 'line' anzugeben.
address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').exists() implies address.line[0] = (address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').value as string) - -for-adresszeilenAufbauPatientRessource-6: Falls die erste Adresszeile einen Straßennamen oder eine Hausnummer besitzt, darf sie keinen Adresszusatz enthalten.
(address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists() or address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists()) implies address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').exists().not() - -for-adresszeilenAufbauPatientRessource-7: Falls eine zweite Adresszeile existiert, darf sie weder einen Straßennamen oder eine Hausnummer enthalten und muss einen Adresszusatz enthalten.
address.line[1].exists() implies address.line[1].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists().not() and address.line[1].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists().not() and address.line[1].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').exists() - -for-adresszeilenAufbauPatientRessource-8: Falls eine zweite Adresszeile existiert, muss die erste Adresszeile einen Straßennamen oder eine Hausnummer enthalten und darf keinen Adresszusatz besitzen.
address.line[1].exists() implies ((address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').exists() or address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').exists()) and address.line[0].extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').exists().not())
- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
|
| search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.search Search related information Definition Information about the search process that lead to the creation of this entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.request Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:KBVFORPatient.response Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| EEBCoverageEgk | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk Entry in the bundle - will have a resource or information Definition An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
BackboneElement 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.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.link Links related to this entry Definition A series of links that provide context to this entry.
|
| fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
- fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
- Results from operations might involve resources that are not identified.
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| resource | Σ I | 1..1 | EEBCoverageEgk | Element idBundle.entry:EEBCoverageEgk.resource Versicherungsdaten Definition Angaben zur Versicherung oder zur Kostenübernahme durch den Patienten selbst oder durch Dritte.
The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
EEBCoverageEgk 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-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() - -eeb-angabeGeschuetzteVersichertendaten: Falls der Versicherungstyp GKV ist, müssen die geschützten Versichertendaten angegeben werden.
type.coding.code='GKV' implies extension('https://gematik.de/fhir/eeb/StructureDefinition/GeschuetzteVersichertendaten').exists()
- rim: Entity. Role, or Act
- workflow: Event
- rim: Coverage
|
| search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.search Search related information Definition Information about the search process that lead to the creation of this entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.request Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageEgk.response Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| EEBCoverageNoEgk | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk Entry in the bundle - will have a resource or information Definition An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
BackboneElement 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.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.id Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension 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()
|
| link | Σ | 0..0 | see (link) | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.link Links related to this entry Definition A series of links that provide context to this entry.
|
| fullUrl | Σ | 0..1 | uri | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.fullUrl URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
- fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
- Results from operations might involve resources that are not identified.
fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.
Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| resource | Σ I | 1..1 | EEBCoverageNoEgk | Element idBundle.entry:EEBCoverageNoEgk.resource Versicherungsdaten Definition Angaben zur Versicherung oder zur Kostenübernahme durch den Patienten selbst oder durch Dritte.
The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.
EEBCoverageNoEgk 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-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()
- rim: Entity. Role, or Act
- workflow: Event
- rim: Coverage
|
| search | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.search Search related information Definition Information about the search process that lead to the creation of this entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| request | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.request Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| response | Σ I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idBundle.entry:EEBCoverageNoEgk.response Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| signature | Σ | 0..0 | Signature | There are no (further) constraints on this element Element idShort description Digital Signature Definition Digital Signature - base64 encoded. XML-DSig or a JWT.
A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.
The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
Signature Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|