Gestion d'Agendas Partagés (GAP)
3.0.0 - trial-use France flag

This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: GAP-BundleResultatReponseADemandeConsultationDisponibilites

Official URL: https://interop.esante.gouv.fr/ig/fhir/gap/StructureDefinition/gap-bundle-reponse-demande-consult-dispo Version: 3.0.0
Active as of 2024-04-29 Computable Name: GAP_BundleResultatReponseADemandeConsultationDisponibilite

Profil du bundle de réponse à la demande de consultation des disponibilités d’une ou de plusieurs ressources. Sur la durée demandée, elle devra contenir les informations sur le temps libre ou occupé de chacune des ressources. La réponse contient donc les disponibilités (Slot) des ressources répondant aux critères de recherche de la demande. Les Slot portant le statut free représentent les disponibilités (status=free). Status=busy pour les indisponibilités correspondant à des rendez-vous pris

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: searchset
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:Slot 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: match
..... request 0..0
..... response 0..0
.... entry:Schedule 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Patient 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:PractitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Device A resource in the bundle
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Location 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:HealthcareService 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Organization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:RelatedPerson 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
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)
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-12: A message must have a MessageHeader as the first resource
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-11: A document must have a Composition as the first resource
bdl-10: A document must have a date
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... total ΣC 0..1 unsignedInt If search, the total number of matches
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Slot ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: match
.... entry:Schedule ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Patient ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 Device A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:HealthcareService ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Slot.search.moderequiredPattern: match
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Slot.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.modifierExtension, Bundle.entry.search.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension, Bundle.entry:Slot.modifierExtension, Bundle.entry:Slot.search.modifierExtension, Bundle.entry:Slot.request.modifierExtension, Bundle.entry:Slot.response.modifierExtension, Bundle.entry:Schedule.modifierExtension, Bundle.entry:Schedule.search.modifierExtension, Bundle.entry:Schedule.request.modifierExtension, Bundle.entry:Schedule.response.modifierExtension, Bundle.entry:Patient.modifierExtension, Bundle.entry:Patient.search.modifierExtension, Bundle.entry:Patient.request.modifierExtension, Bundle.entry:Patient.response.modifierExtension, Bundle.entry:Practitioner.modifierExtension, Bundle.entry:Practitioner.search.modifierExtension, Bundle.entry:Practitioner.request.modifierExtension, Bundle.entry:Practitioner.response.modifierExtension, Bundle.entry:PractitionerRole.modifierExtension, Bundle.entry:PractitionerRole.search.modifierExtension, Bundle.entry:PractitionerRole.request.modifierExtension, Bundle.entry:PractitionerRole.response.modifierExtension, Bundle.entry:Device.modifierExtension, Bundle.entry:Device.search.modifierExtension, Bundle.entry:Device.request.modifierExtension, Bundle.entry:Device.response.modifierExtension, Bundle.entry:Location.modifierExtension, Bundle.entry:Location.search.modifierExtension, Bundle.entry:Location.request.modifierExtension, Bundle.entry:Location.response.modifierExtension, Bundle.entry:HealthcareService.modifierExtension, Bundle.entry:HealthcareService.search.modifierExtension, Bundle.entry:HealthcareService.request.modifierExtension, Bundle.entry:HealthcareService.response.modifierExtension, Bundle.entry:Organization.modifierExtension, Bundle.entry:Organization.search.modifierExtension, Bundle.entry:Organization.request.modifierExtension, Bundle.entry:Organization.response.modifierExtension, Bundle.entry:RelatedPerson.modifierExtension, Bundle.entry:RelatedPerson.search.modifierExtension, Bundle.entry:RelatedPerson.request.modifierExtension, Bundle.entry:RelatedPerson.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
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)
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-12: A message must have a MessageHeader as the first resource
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-11: A document must have a Composition as the first resource
bdl-10: A document must have a date
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Slot ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: match
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Schedule ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Patient ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:HealthcareService ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Slot.search.moderequiredPattern: match
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Slot.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry:Slot.extension, Bundle.entry:Slot.modifierExtension, Bundle.entry:Slot.search.extension, Bundle.entry:Slot.search.modifierExtension, Bundle.entry:Slot.request.extension, Bundle.entry:Slot.request.modifierExtension, Bundle.entry:Slot.response.extension, Bundle.entry:Slot.response.modifierExtension, Bundle.entry:Schedule.extension, Bundle.entry:Schedule.modifierExtension, Bundle.entry:Schedule.search.extension, Bundle.entry:Schedule.search.modifierExtension, Bundle.entry:Schedule.request.extension, Bundle.entry:Schedule.request.modifierExtension, Bundle.entry:Schedule.response.extension, Bundle.entry:Schedule.response.modifierExtension, Bundle.entry:Patient.extension, Bundle.entry:Patient.modifierExtension, Bundle.entry:Patient.search.extension, Bundle.entry:Patient.search.modifierExtension, Bundle.entry:Patient.request.extension, Bundle.entry:Patient.request.modifierExtension, Bundle.entry:Patient.response.extension, Bundle.entry:Patient.response.modifierExtension, Bundle.entry:Practitioner.extension, Bundle.entry:Practitioner.modifierExtension, Bundle.entry:Practitioner.search.extension, Bundle.entry:Practitioner.search.modifierExtension, Bundle.entry:Practitioner.request.extension, Bundle.entry:Practitioner.request.modifierExtension, Bundle.entry:Practitioner.response.extension, Bundle.entry:Practitioner.response.modifierExtension, Bundle.entry:PractitionerRole.extension, Bundle.entry:PractitionerRole.modifierExtension, Bundle.entry:PractitionerRole.search.extension, Bundle.entry:PractitionerRole.search.modifierExtension, Bundle.entry:PractitionerRole.request.extension, Bundle.entry:PractitionerRole.request.modifierExtension, Bundle.entry:PractitionerRole.response.extension, Bundle.entry:PractitionerRole.response.modifierExtension, Bundle.entry:Device.extension, Bundle.entry:Device.modifierExtension, Bundle.entry:Device.search.extension, Bundle.entry:Device.search.modifierExtension, Bundle.entry:Device.request.extension, Bundle.entry:Device.request.modifierExtension, Bundle.entry:Device.response.extension, Bundle.entry:Device.response.modifierExtension, Bundle.entry:Location.extension, Bundle.entry:Location.modifierExtension, Bundle.entry:Location.search.extension, Bundle.entry:Location.search.modifierExtension, Bundle.entry:Location.request.extension, Bundle.entry:Location.request.modifierExtension, Bundle.entry:Location.response.extension, Bundle.entry:Location.response.modifierExtension, Bundle.entry:HealthcareService.extension, Bundle.entry:HealthcareService.modifierExtension, Bundle.entry:HealthcareService.search.extension, Bundle.entry:HealthcareService.search.modifierExtension, Bundle.entry:HealthcareService.request.extension, Bundle.entry:HealthcareService.request.modifierExtension, Bundle.entry:HealthcareService.response.extension, Bundle.entry:HealthcareService.response.modifierExtension, Bundle.entry:Organization.extension, Bundle.entry:Organization.modifierExtension, Bundle.entry:Organization.search.extension, Bundle.entry:Organization.search.modifierExtension, Bundle.entry:Organization.request.extension, Bundle.entry:Organization.request.modifierExtension, Bundle.entry:Organization.response.extension, Bundle.entry:Organization.response.modifierExtension, Bundle.entry:RelatedPerson.extension, Bundle.entry:RelatedPerson.modifierExtension, Bundle.entry:RelatedPerson.search.extension, Bundle.entry:RelatedPerson.search.modifierExtension, Bundle.entry:RelatedPerson.request.extension, Bundle.entry:RelatedPerson.request.modifierExtension, Bundle.entry:RelatedPerson.response.extension, Bundle.entry:RelatedPerson.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: searchset
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:Slot 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: match
..... request 0..0
..... response 0..0
.... entry:Schedule 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Patient 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:PractitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Device A resource in the bundle
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Location 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:HealthcareService 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:Organization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0
.... entry:RelatedPerson 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search
...... mode 0..1 code match | include | outcome - why this is in the result set
Required Pattern: include
..... request 0..0
..... response 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
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)
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-12: A message must have a MessageHeader as the first resource
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-11: A document must have a Composition as the first resource
bdl-10: A document must have a date
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... total ΣC 0..1 unsignedInt If search, the total number of matches
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Slot ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: match
.... entry:Schedule ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Patient ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 Device A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:HealthcareService ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search ΣC 0..1 BackboneElement Search related information
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Slot.search.moderequiredPattern: match
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Slot.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.modifierExtension, Bundle.entry.search.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension, Bundle.entry:Slot.modifierExtension, Bundle.entry:Slot.search.modifierExtension, Bundle.entry:Slot.request.modifierExtension, Bundle.entry:Slot.response.modifierExtension, Bundle.entry:Schedule.modifierExtension, Bundle.entry:Schedule.search.modifierExtension, Bundle.entry:Schedule.request.modifierExtension, Bundle.entry:Schedule.response.modifierExtension, Bundle.entry:Patient.modifierExtension, Bundle.entry:Patient.search.modifierExtension, Bundle.entry:Patient.request.modifierExtension, Bundle.entry:Patient.response.modifierExtension, Bundle.entry:Practitioner.modifierExtension, Bundle.entry:Practitioner.search.modifierExtension, Bundle.entry:Practitioner.request.modifierExtension, Bundle.entry:Practitioner.response.modifierExtension, Bundle.entry:PractitionerRole.modifierExtension, Bundle.entry:PractitionerRole.search.modifierExtension, Bundle.entry:PractitionerRole.request.modifierExtension, Bundle.entry:PractitionerRole.response.modifierExtension, Bundle.entry:Device.modifierExtension, Bundle.entry:Device.search.modifierExtension, Bundle.entry:Device.request.modifierExtension, Bundle.entry:Device.response.modifierExtension, Bundle.entry:Location.modifierExtension, Bundle.entry:Location.search.modifierExtension, Bundle.entry:Location.request.modifierExtension, Bundle.entry:Location.response.modifierExtension, Bundle.entry:HealthcareService.modifierExtension, Bundle.entry:HealthcareService.search.modifierExtension, Bundle.entry:HealthcareService.request.modifierExtension, Bundle.entry:HealthcareService.response.modifierExtension, Bundle.entry:Organization.modifierExtension, Bundle.entry:Organization.search.modifierExtension, Bundle.entry:Organization.request.modifierExtension, Bundle.entry:Organization.response.modifierExtension, Bundle.entry:RelatedPerson.modifierExtension, Bundle.entry:RelatedPerson.search.modifierExtension, Bundle.entry:RelatedPerson.request.modifierExtension, Bundle.entry:RelatedPerson.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
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)
bdl-9: A document must have an identifier with a system and a value
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-12: A message must have a MessageHeader as the first resource
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-11: A document must have a Composition as the first resource
bdl-10: A document must have a date
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Slot ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreSlotProfile A slot of time on a schedule that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: match
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Schedule ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreScheduleProfile A container for slots of time that may be available for booking appointments
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Patient ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCorePatientProfile Information about an individual or animal receiving health care services
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsPractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsPractitionerRoleProfile Roles/organizations the practitioner is associated with
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreLocationProfile Details and position information for a physical place
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:HealthcareService ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreHealthcareServiceProfile The details of a healthcare service available at a location
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AsOrganizationProfile A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-8: fullUrl cannot be a version specific reference
bdl-5: must be a resource unless there's a request or response
This repeating element order: 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
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FRCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): 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.


Required Pattern: include
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Slot.search.moderequiredPattern: match
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Slot.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Schedule.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:HealthcareService.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredPattern: include
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:Slot, Bundle.entry:Schedule, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Device, Bundle.entry:Location, Bundle.entry:HealthcareService, Bundle.entry:Organization, Bundle.entry:RelatedPersonfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry:Slot.extension, Bundle.entry:Slot.modifierExtension, Bundle.entry:Slot.search.extension, Bundle.entry:Slot.search.modifierExtension, Bundle.entry:Slot.request.extension, Bundle.entry:Slot.request.modifierExtension, Bundle.entry:Slot.response.extension, Bundle.entry:Slot.response.modifierExtension, Bundle.entry:Schedule.extension, Bundle.entry:Schedule.modifierExtension, Bundle.entry:Schedule.search.extension, Bundle.entry:Schedule.search.modifierExtension, Bundle.entry:Schedule.request.extension, Bundle.entry:Schedule.request.modifierExtension, Bundle.entry:Schedule.response.extension, Bundle.entry:Schedule.response.modifierExtension, Bundle.entry:Patient.extension, Bundle.entry:Patient.modifierExtension, Bundle.entry:Patient.search.extension, Bundle.entry:Patient.search.modifierExtension, Bundle.entry:Patient.request.extension, Bundle.entry:Patient.request.modifierExtension, Bundle.entry:Patient.response.extension, Bundle.entry:Patient.response.modifierExtension, Bundle.entry:Practitioner.extension, Bundle.entry:Practitioner.modifierExtension, Bundle.entry:Practitioner.search.extension, Bundle.entry:Practitioner.search.modifierExtension, Bundle.entry:Practitioner.request.extension, Bundle.entry:Practitioner.request.modifierExtension, Bundle.entry:Practitioner.response.extension, Bundle.entry:Practitioner.response.modifierExtension, Bundle.entry:PractitionerRole.extension, Bundle.entry:PractitionerRole.modifierExtension, Bundle.entry:PractitionerRole.search.extension, Bundle.entry:PractitionerRole.search.modifierExtension, Bundle.entry:PractitionerRole.request.extension, Bundle.entry:PractitionerRole.request.modifierExtension, Bundle.entry:PractitionerRole.response.extension, Bundle.entry:PractitionerRole.response.modifierExtension, Bundle.entry:Device.extension, Bundle.entry:Device.modifierExtension, Bundle.entry:Device.search.extension, Bundle.entry:Device.search.modifierExtension, Bundle.entry:Device.request.extension, Bundle.entry:Device.request.modifierExtension, Bundle.entry:Device.response.extension, Bundle.entry:Device.response.modifierExtension, Bundle.entry:Location.extension, Bundle.entry:Location.modifierExtension, Bundle.entry:Location.search.extension, Bundle.entry:Location.search.modifierExtension, Bundle.entry:Location.request.extension, Bundle.entry:Location.request.modifierExtension, Bundle.entry:Location.response.extension, Bundle.entry:Location.response.modifierExtension, Bundle.entry:HealthcareService.extension, Bundle.entry:HealthcareService.modifierExtension, Bundle.entry:HealthcareService.search.extension, Bundle.entry:HealthcareService.search.modifierExtension, Bundle.entry:HealthcareService.request.extension, Bundle.entry:HealthcareService.request.modifierExtension, Bundle.entry:HealthcareService.response.extension, Bundle.entry:HealthcareService.response.modifierExtension, Bundle.entry:Organization.extension, Bundle.entry:Organization.modifierExtension, Bundle.entry:Organization.search.extension, Bundle.entry:Organization.search.modifierExtension, Bundle.entry:Organization.request.extension, Bundle.entry:Organization.request.modifierExtension, Bundle.entry:Organization.response.extension, Bundle.entry:Organization.response.modifierExtension, Bundle.entry:RelatedPerson.extension, Bundle.entry:RelatedPerson.modifierExtension, Bundle.entry:RelatedPerson.search.extension, Bundle.entry:RelatedPerson.search.modifierExtension, Bundle.entry:RelatedPerson.request.extension, Bundle.entry:RelatedPerson.request.modifierExtension, Bundle.entry:RelatedPerson.response.extension, Bundle.entry:RelatedPerson.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron