Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release
Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release
This page is part of the KLFFBMessaging (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Active as of 2023-08-27 |
XML representation of the kl-messaging-ffb-orderMessage resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="kl-messaging-ffb-orderMessage"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">Placeholder</div>
</text>
<url
value="http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-orderMessage"/>
<version value="1.0.0"/>
<name value="KLMessagingFFBOrderMessage"/>
<title value="OrderMessage"/>
<status value="active"/>
<date value="2023-08-27T08:19:39+02:00"/>
<publisher value="KL"/>
<contact>
<name value="KL"/>
<telecom>
<system value="url"/>
<value value="http://www.kl.dk"/>
</telecom>
</contact>
<description
value="Message for sending an order from an authority organization to a provider organization"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="DK"/>
<display value="Denmark"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="cda"/>
<uri value="http://hl7.org/v3/cda"/>
<name value="CDA (R2)"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/fivews"/>
<name value="FiveWs Pattern Mapping"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="Bundle"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
<derivation value="constraint"/>
<snapshot>
<element id="Bundle">
<path value="Bundle"/>
<short value="Contains a collection of resources"/>
<definition value="A container for a collection of resources."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Bundle"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="bdl-1"/>
<severity value="error"/>
<human value="total only when a search or history"/>
<expression
value="total.empty() or (type = 'searchset') or (type = 'history')"/>
<xpath
value="not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-2"/>
<severity value="error"/>
<human value="entry.search only when a search"/>
<expression value="entry.search.empty() or (type = 'searchset')"/>
<xpath
value="not(f:entry/f:search) or (f:type/@value = 'searchset')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-3"/>
<severity value="error"/>
<human
value="entry.request mandatory for batch/transaction/history, otherwise prohibited"/>
<expression
value="entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))"/>
<xpath
value="not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-4"/>
<severity value="error"/>
<human
value="entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited"/>
<expression
value="entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))"/>
<xpath
value="not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-7"/>
<severity value="error"/>
<human
value="FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)"/>
<expression
value="(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()"/>
<xpath
value="(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-9"/>
<severity value="error"/>
<human
value="A document must have an identifier with a system and a value"/>
<expression
value="type = 'document' implies (identifier.system.exists() and identifier.value.exists())"/>
<xpath
value="not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-10"/>
<severity value="error"/>
<human value="A document must have a date"/>
<expression value="type = 'document' implies (timestamp.hasValue())"/>
<xpath
value="not(f:type/@value = 'document') or exists(f:timestamp/@value)"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-11"/>
<severity value="error"/>
<human
value="A document must have a Composition as the first resource"/>
<expression
value="type = 'document' implies entry.first().resource.is(Composition)"/>
<xpath
value="not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-12"/>
<severity value="error"/>
<human
value="A message must have a MessageHeader as the first resource"/>
<expression
value="type = 'message' implies entry.first().resource.is(MessageHeader)"/>
<xpath
value="not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="N/A"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
<mapping>
<identity value="cda"/>
<map value="ClinicalDocument, if bundle.type = document"/>
</mapping>
</element>
<element id="Bundle.id">
<path value="Bundle.id"/>
<short value="Logical id of this artifact"/>
<definition
value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
<comment
value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.meta">
<path value="Bundle.meta"/>
<short value="Metadata about the resource"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.implicitRules">
<path value="Bundle.implicitRules"/>
<short value="A set of rules under which this content was created"/>
<definition
value="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."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation"/>
<isSummary value="true"/>
</element>
<element id="Bundle.language">
<path value="Bundle.language"/>
<short value="Language of the resource content"/>
<definition
value="The base language in which the resource is written."/>
<comment
value="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)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</binding>
</element>
<element id="Bundle.identifier">
<path value="Bundle.identifier"/>
<short value="Persistent identifier for the bundle"/>
<definition
value="A persistent identifier for the bundle that won't change as a bundle is copied from server to server."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.identifier"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Identifier"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
<mapping>
<identity value="cda"/>
<map value="ClinicalDocument.id"/>
</mapping>
</element>
<element id="Bundle.type">
<path value="Bundle.type"/>
<short value="Always message"/>
<definition
value="Indicates the purpose of this bundle - how it is intended to be used."/>
<comment
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.type"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<patternCode value="message"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="BundleType"/>
</extension>
<strength value="required"/>
<description
value="Indicates the purpose of a bundle - how it is intended to be used."/>
<valueSet value="http://hl7.org/fhir/ValueSet/bundle-type|4.0.1"/>
</binding>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
</element>
<element id="Bundle.timestamp">
<path value="Bundle.timestamp"/>
<short value="When the bundle was assembled"/>
<definition
value="The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle."/>
<comment
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.timestamp"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.init"/>
</mapping>
<mapping>
<identity value="cda"/>
<map value="ClinicalDocument.effectiveTime"/>
</mapping>
</element>
<element id="Bundle.total">
<path value="Bundle.total"/>
<short value="If search, the total number of matches"/>
<definition
value="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."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.total"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="unsignedInt"/>
</type>
<condition value="bdl-1"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.link">
<path value="Bundle.link"/>
<short value="Links related to this Bundle"/>
<definition
value="A series of links that provide context to this bundle."/>
<comment
value="Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R4/http.html#read) directly.
This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R4/search.html#conformance) and [paging](http://hl7.org/fhir/R4/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Bundle.link"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.link.id">
<path value="Bundle.link.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.link.extension">
<path value="Bundle.link.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.link.modifierExtension">
<path value="Bundle.link.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="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)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Bundle.link.relation">
<path value="Bundle.link.relation"/>
<short
value="See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1"/>
<definition
value="A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.link.relation"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.link.url">
<path value="Bundle.link.url"/>
<short value="Reference details for the link"/>
<definition value="The reference details for the link."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.link.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry">
<path value="Bundle.entry"/>
<short
value="Entry in the bundle - will have a resource or information"/>
<definition
value="An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Bundle.entry"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<orderMeaning
value="For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type"/>
<constraint>
<key value="bdl-5"/>
<severity value="error"/>
<human
value="must be a resource unless there's a request or response"/>
<expression
value="resource.exists() or request.exists() or response.exists()"/>
<xpath
value="exists(f:resource) or exists(f:request) or exists(f:response)"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="bdl-8"/>
<severity value="error"/>
<human value="fullUrl cannot be a version specific reference"/>
<expression value="fullUrl.contains('/_history/').not()"/>
<xpath
value="not(exists(f:fullUrl[contains(string(@value), '/_history/')]))"/>
<source value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
</constraint>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.id">
<path value="Bundle.entry.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.extension">
<path value="Bundle.entry.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.modifierExtension">
<path value="Bundle.entry.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="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)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Bundle.entry.link">
<path value="Bundle.entry.link"/>
<short value="Links related to this entry"/>
<definition
value="A series of links that provide context to this entry."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Bundle.entry.link"/>
<min value="0"/>
<max value="*"/>
</base>
<contentReference
value="http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.fullUrl">
<path value="Bundle.entry.fullUrl"/>
<short
value="URI for resource (Absolute URL server address or URI for UUID/OID)"/>
<definition
value="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."/>
<comment
value="fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R4/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), 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](http://hl7.org/fhir/R4/references.html#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)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.fullUrl"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.resource">
<path value="Bundle.entry.resource"/>
<short value="A resource in the bundle"/>
<definition
value="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.entry.resource"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Resource"/>
</type>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.search">
<path value="Bundle.entry.search"/>
<short value="Search related information"/>
<definition
value="Information about the search process that lead to the creation of this entry."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.search"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<condition value="bdl-2"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.search.id">
<path value="Bundle.entry.search.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.search.extension">
<path value="Bundle.entry.search.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.search.modifierExtension">
<path value="Bundle.entry.search.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="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)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Bundle.entry.search.mode">
<path value="Bundle.entry.search.mode"/>
<short
value="match | include | outcome - why this is in the result set"/>
<definition
value="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."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.search.mode"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="SearchEntryMode"/>
</extension>
<strength value="required"/>
<description
value="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."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1"/>
</binding>
</element>
<element id="Bundle.entry.search.score">
<path value="Bundle.entry.search.score"/>
<short value="Search ranking (between 0 and 1)"/>
<definition
value="When searching, the server's search ranking score for the entry."/>
<comment
value="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](http://hl7.org/fhir/R4/patient-operation-match.html) for the EMPI search which relates to this element."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.search.score"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="decimal"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request">
<path value="Bundle.entry.request"/>
<short
value="Additional execution information (transaction/batch/history)"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<condition value="bdl-3"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request.id">
<path value="Bundle.entry.request.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.request.extension">
<path value="Bundle.entry.request.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.request.modifierExtension">
<path value="Bundle.entry.request.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="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)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Bundle.entry.request.method">
<path value="Bundle.entry.request.method"/>
<short value="GET | HEAD | POST | PUT | DELETE | PATCH"/>
<definition
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.method"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="HTTPVerb"/>
</extension>
<strength value="required"/>
<description
value="HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details."/>
<valueSet value="http://hl7.org/fhir/ValueSet/http-verb|4.0.1"/>
</binding>
</element>
<element id="Bundle.entry.request.url">
<path value="Bundle.entry.request.url"/>
<short value="URL for HTTP equivalent of this entry"/>
<definition
value="The URL for this entry, relative to the root (the address to which the request is posted)."/>
<comment
value="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]"."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request.ifNoneMatch">
<path value="Bundle.entry.request.ifNoneMatch"/>
<short value="For managing cache currency"/>
<definition
value="If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R4/http.html#cread)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.ifNoneMatch"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request.ifModifiedSince">
<path value="Bundle.entry.request.ifModifiedSince"/>
<short value="For managing cache currency"/>
<definition
value="Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http://hl7.org/fhir/R4/http.html#cread)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.ifModifiedSince"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request.ifMatch">
<path value="Bundle.entry.request.ifMatch"/>
<short value="For managing update contention"/>
<definition
value="Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http://hl7.org/fhir/R4/http.html#concurrency)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.ifMatch"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.request.ifNoneExist">
<path value="Bundle.entry.request.ifNoneExist"/>
<short value="For conditional creates"/>
<definition
value="Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http://hl7.org/fhir/R4/http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?")."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.request.ifNoneExist"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response">
<path value="Bundle.entry.response"/>
<short value="Results of execution (transaction/batch/history)"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<condition value="bdl-4"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response.id">
<path value="Bundle.entry.response.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.response.extension">
<path value="Bundle.entry.response.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Bundle.entry.response.modifierExtension">
<path value="Bundle.entry.response.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="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)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Bundle.entry.response.status">
<path value="Bundle.entry.response.status"/>
<short value="Status response code (text optional)"/>
<definition
value="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."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response.status"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response.location">
<path value="Bundle.entry.response.location"/>
<short value="The location (if the operation returns a location)"/>
<definition
value="The location header created by processing this operation, populated if the operation returns a location."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response.location"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response.etag">
<path value="Bundle.entry.response.etag"/>
<short value="The Etag for the resource (if relevant)"/>
<definition
value="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R4/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R4/http.html#concurrency))."/>
<comment
value="Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response.etag"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response.lastModified">
<path value="Bundle.entry.response.lastModified"/>
<short value="Server's date time modified"/>
<definition
value="The date/time that the resource was modified on the server."/>
<comment
value="This has to match the same time in the meta header (meta.lastUpdated) if a resource is included."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response.lastModified"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.entry.response.outcome">
<path value="Bundle.entry.response.outcome"/>
<short
value="OperationOutcome with hints and warnings (for batch/transaction)"/>
<definition
value="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.entry.response.outcome"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Resource"/>
</type>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Bundle.signature">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use"/>
</extension>
<path value="Bundle.signature"/>
<short value="Digital Signature"/>
<definition
value="Digital Signature - base64 encoded. XML-DSig or a JWT."/>
<comment
value="The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific."/>
<requirements
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Bundle.signature"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Signature"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
</snapshot>
<differential>
<element id="Bundle">
<path value="Bundle"/>
</element>
<element id="Bundle.type">
<path value="Bundle.type"/>
<short value="Always message"/>
<patternCode value="message"/>
<mustSupport value="true"/>
</element>
<element id="Bundle.timestamp">
<path value="Bundle.timestamp"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Bundle.entry">
<path value="Bundle.entry"/>
<mustSupport value="true"/>
</element>
<element id="Bundle.entry.resource">
<path value="Bundle.entry.resource"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>
IG © 2021+ KL. Package kl.dk.fhir.ffbmessaging#1.0.0 based on FHIR 4.0.1. Generated 2023-08-27
Links: Table of Contents |
QA Report