This page is part of the Guide d'implémentation FHIR - Gestion d'Agendas Partagés (v3.0.0-ballot: Release) based on FHIR 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: GAP_BundleResultatReponseADemandeConsultationRDV

Il s’agit du flux de réponse à la recherche de rendez-vous dans l’agenda d’une ressource. Sur la durée demandée, il devra contenir les informations sur les rendez-vous répondant aux critères de recherche envoyés dans la demande

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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
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:Appointment		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
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:Slot		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrSlot	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: include
request		0..0
response		0..0
entry:Schedule		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrSchedule	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	FrPatient	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	FrPractitioner	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	FrLocation	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	FrHealthcareService	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	FrOrganization	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	FrRelatedPerson	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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
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
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
request	ΣCN	0..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!ΣN	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	ΣCN	0..1	BackboneElement	Results of execution (transaction/batch/history)
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
entry:Appointment	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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:Slot	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrSlot	A slot of time on a schedule that may be available for booking appointments
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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:Schedule	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrSchedule	A container for slots of time that may be available for booking appointments
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrPatient	Information about an individual or animal receiving health care services
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	AsPractitionerRoleProfile	Roles/organizations the practitioner is associated with
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	Σ	1..1	Device	A resource in the bundle
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrLocation	Details and position information for a physical place
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrHealthcareService	The details of a healthcare service available at a location
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	FrOrganization	A grouping of people or organizations with a common purpose
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrRelatedPerson	A person that is related to a patient, but who is not a direct target of care
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Bundle.type	required	Pattern: searchset
Bundle.entry.request.method	required	HTTPVerb
Bundle.entry:Appointment.search.mode	required	Pattern: match
Bundle.entry:Appointment.request.method	required	HTTPVerb
Bundle.entry:Slot.search.mode	required	Pattern: include
Bundle.entry:Slot.request.method	required	HTTPVerb
Bundle.entry:Schedule.search.mode	required	Pattern: include
Bundle.entry:Schedule.request.method	required	HTTPVerb
Bundle.entry:Patient.search.mode	required	Pattern: include
Bundle.entry:Patient.request.method	required	HTTPVerb
Bundle.entry:Practitioner.search.mode	required	Pattern: include
Bundle.entry:Practitioner.request.method	required	HTTPVerb
Bundle.entry:PractitionerRole.search.mode	required	Pattern: include
Bundle.entry:PractitionerRole.request.method	required	HTTPVerb
Bundle.entry:Device.search.mode	required	Pattern: include
Bundle.entry:Device.request.method	required	HTTPVerb
Bundle.entry:Location.search.mode	required	Pattern: include
Bundle.entry:Location.request.method	required	HTTPVerb
Bundle.entry:HealthcareService.search.mode	required	Pattern: include
Bundle.entry:HealthcareService.request.method	required	HTTPVerb
Bundle.entry:Organization.search.mode	required	Pattern: include
Bundle.entry:Organization.request.method	required	HTTPVerb
Bundle.entry:RelatedPerson.search.mode	required	Pattern: include
Bundle.entry:RelatedPerson.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
app-2	error	Bundle.entry:Appointment.resource	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Bundle.entry:Appointment.resource	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Bundle.entry:Appointment.resource	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.modifierExtension, Bundle.entry.search.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension, Bundle.entry:Appointment.modifierExtension, Bundle.entry:Appointment.search.modifierExtension, Bundle.entry:Appointment.request.modifierExtension, Bundle.entry:Appointment.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.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Bundle.entry:Organization.resource	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	ΣN	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	ΣN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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	ΣCN	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	?!ΣN	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	ΣCN	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	?!ΣN	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:Appointment	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	C	1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
search	ΣCN	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	?!ΣN	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:Slot	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	FrSlot	A slot of time on a schedule that may be available for booking appointments
search	ΣCN	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	?!ΣN	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:Schedule	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	FrSchedule	A container for slots of time that may be available for booking appointments
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrPatient	Information about an individual or animal receiving health care services
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrLocation	Details and position information for a physical place
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrHealthcareService	The details of a healthcare service available at a location
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	C	1..1	FrOrganization	A grouping of people or organizations with a common purpose
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrRelatedPerson	A person that is related to a patient, but who is not a direct target of care
search	ΣCN	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	?!ΣN	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	ΣTU	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: searchset
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb
Bundle.entry:Appointment.search.mode	required	Pattern: match
Bundle.entry:Appointment.request.method	required	HTTPVerb
Bundle.entry:Slot.search.mode	required	Pattern: include
Bundle.entry:Slot.request.method	required	HTTPVerb
Bundle.entry:Schedule.search.mode	required	Pattern: include
Bundle.entry:Schedule.request.method	required	HTTPVerb
Bundle.entry:Patient.search.mode	required	Pattern: include
Bundle.entry:Patient.request.method	required	HTTPVerb
Bundle.entry:Practitioner.search.mode	required	Pattern: include
Bundle.entry:Practitioner.request.method	required	HTTPVerb
Bundle.entry:PractitionerRole.search.mode	required	Pattern: include
Bundle.entry:PractitionerRole.request.method	required	HTTPVerb
Bundle.entry:Device.search.mode	required	Pattern: include
Bundle.entry:Device.request.method	required	HTTPVerb
Bundle.entry:Location.search.mode	required	Pattern: include
Bundle.entry:Location.request.method	required	HTTPVerb
Bundle.entry:HealthcareService.search.mode	required	Pattern: include
Bundle.entry:HealthcareService.request.method	required	HTTPVerb
Bundle.entry:Organization.search.mode	required	Pattern: include
Bundle.entry:Organization.request.method	required	HTTPVerb
Bundle.entry:RelatedPerson.search.mode	required	Pattern: include
Bundle.entry:RelatedPerson.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
app-2	error	Bundle.entry:Appointment.resource	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Bundle.entry:Appointment.resource	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Bundle.entry:Appointment.resource	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
bdl-5	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-8	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
dom-2	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.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:Appointment.extension, Bundle.entry:Appointment.modifierExtension, Bundle.entry:Appointment.search.extension, Bundle.entry:Appointment.search.modifierExtension, Bundle.entry:Appointment.request.extension, Bundle.entry:Appointment.request.modifierExtension, Bundle.entry:Appointment.response.extension, Bundle.entry:Appointment.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.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Bundle.entry:Organization.resource	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

This structure is derived from Bundle

Summary

Mandatory: 0 element (11 nested mandatory elements)
Prohibited: 22 elements

Structures

This structure refers to these other structures:

• FrAppointment (http://interopsante.org/fhir/StructureDefinition/FrAppointment)
• FrSlot (http://interopsante.org/fhir/StructureDefinition/FrSlot)
• FrSchedule (http://interopsante.org/fhir/StructureDefinition/FrSchedule)
• FrPatient (http://interopsante.org/fhir/StructureDefinition/FrPatient)
• FrPractitioner (http://interopsante.org/fhir/StructureDefinition/FrPractitioner)
• AS PractitionerRole Profile (https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-practitionerrole)
• FrLocation (http://interopsante.org/fhir/StructureDefinition/FrLocation)
• FrHealthcareService (http://interopsante.org/fhir/StructureDefinition/FrHealthcareService)
• FrOrganization (http://interopsante.org/fhir/StructureDefinition/FrOrganization)
• FrRelatedPerson (http://interopsante.org/fhir/StructureDefinition/FrRelatedPerson)

Slices

This structure defines the following Slices:

• The element Bundle.entry is sliced based on the value of profile:resource

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
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:Appointment		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
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:Slot		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrSlot	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: include
request		0..0
response		0..0
entry:Schedule		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	FrSchedule	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	FrPatient	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	FrPractitioner	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	FrLocation	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	FrHealthcareService	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	FrOrganization	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	FrRelatedPerson	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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
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
Slices for entry	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by profile:resource 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
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
request	ΣCN	0..1	BackboneElement	Additional execution information (transaction/batch/history)
modifierExtension	?!ΣN	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	ΣCN	0..1	BackboneElement	Results of execution (transaction/batch/history)
modifierExtension	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
status	Σ	1..1	string	Status response code (text optional)
entry:Appointment	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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:Slot	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrSlot	A slot of time on a schedule that may be available for booking appointments
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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:Schedule	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrSchedule	A container for slots of time that may be available for booking appointments
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrPatient	Information about an individual or animal receiving health care services
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	AsPractitionerRoleProfile	Roles/organizations the practitioner is associated with
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	Σ	1..1	Device	A resource in the bundle
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrLocation	Details and position information for a physical place
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrHealthcareService	The details of a healthcare service available at a location
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	C	1..1	FrOrganization	A grouping of people or organizations with a common purpose
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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 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	?!ΣN	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource		1..1	FrRelatedPerson	A person that is related to a patient, but who is not a direct target of care
search	ΣCN	0..1	BackboneElement	Search related information
modifierExtension	?!ΣN	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Bundle.type	required	Pattern: searchset
Bundle.entry.request.method	required	HTTPVerb
Bundle.entry:Appointment.search.mode	required	Pattern: match
Bundle.entry:Appointment.request.method	required	HTTPVerb
Bundle.entry:Slot.search.mode	required	Pattern: include
Bundle.entry:Slot.request.method	required	HTTPVerb
Bundle.entry:Schedule.search.mode	required	Pattern: include
Bundle.entry:Schedule.request.method	required	HTTPVerb
Bundle.entry:Patient.search.mode	required	Pattern: include
Bundle.entry:Patient.request.method	required	HTTPVerb
Bundle.entry:Practitioner.search.mode	required	Pattern: include
Bundle.entry:Practitioner.request.method	required	HTTPVerb
Bundle.entry:PractitionerRole.search.mode	required	Pattern: include
Bundle.entry:PractitionerRole.request.method	required	HTTPVerb
Bundle.entry:Device.search.mode	required	Pattern: include
Bundle.entry:Device.request.method	required	HTTPVerb
Bundle.entry:Location.search.mode	required	Pattern: include
Bundle.entry:Location.request.method	required	HTTPVerb
Bundle.entry:HealthcareService.search.mode	required	Pattern: include
Bundle.entry:HealthcareService.request.method	required	HTTPVerb
Bundle.entry:Organization.search.mode	required	Pattern: include
Bundle.entry:Organization.request.method	required	HTTPVerb
Bundle.entry:RelatedPerson.search.mode	required	Pattern: include
Bundle.entry:RelatedPerson.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
app-2	error	Bundle.entry:Appointment.resource	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Bundle.entry:Appointment.resource	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Bundle.entry:Appointment.resource	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.entry.modifierExtension, Bundle.entry.search.modifierExtension, Bundle.entry.request.modifierExtension, Bundle.entry.response.modifierExtension, Bundle.entry:Appointment.modifierExtension, Bundle.entry:Appointment.search.modifierExtension, Bundle.entry:Appointment.request.modifierExtension, Bundle.entry:Appointment.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.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Bundle.entry:Organization.resource	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
id	Σ	0..1	id	Logical id of this artifact
meta	ΣN	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	ΣN	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	ΣN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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	ΣCN	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	?!ΣN	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	ΣCN	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	?!ΣN	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:Appointment	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	C	1..1	FrAppointment	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
search	ΣCN	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	?!ΣN	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:Slot	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	FrSlot	A slot of time on a schedule that may be available for booking appointments
search	ΣCN	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	?!ΣN	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:Schedule	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information 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	?!ΣN	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	FrSchedule	A container for slots of time that may be available for booking appointments
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrPatient	Information about an individual or animal receiving health care services
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services | Prestataire de santé
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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 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	?!ΣN	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	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrLocation	Details and position information for a physical place
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrHealthcareService	The details of a healthcare service available at a location
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	C	1..1	FrOrganization	A grouping of people or organizations with a common purpose
search	ΣCN	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	?!ΣN	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 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	?!ΣN	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	FrRelatedPerson	A person that is related to a patient, but who is not a direct target of care
search	ΣCN	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	?!ΣN	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	ΣTU	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Bundle.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: searchset
Bundle.entry.search.mode	required	SearchEntryMode
Bundle.entry.request.method	required	HTTPVerb
Bundle.entry:Appointment.search.mode	required	Pattern: match
Bundle.entry:Appointment.request.method	required	HTTPVerb
Bundle.entry:Slot.search.mode	required	Pattern: include
Bundle.entry:Slot.request.method	required	HTTPVerb
Bundle.entry:Schedule.search.mode	required	Pattern: include
Bundle.entry:Schedule.request.method	required	HTTPVerb
Bundle.entry:Patient.search.mode	required	Pattern: include
Bundle.entry:Patient.request.method	required	HTTPVerb
Bundle.entry:Practitioner.search.mode	required	Pattern: include
Bundle.entry:Practitioner.request.method	required	HTTPVerb
Bundle.entry:PractitionerRole.search.mode	required	Pattern: include
Bundle.entry:PractitionerRole.request.method	required	HTTPVerb
Bundle.entry:Device.search.mode	required	Pattern: include
Bundle.entry:Device.request.method	required	HTTPVerb
Bundle.entry:Location.search.mode	required	Pattern: include
Bundle.entry:Location.request.method	required	HTTPVerb
Bundle.entry:HealthcareService.search.mode	required	Pattern: include
Bundle.entry:HealthcareService.request.method	required	HTTPVerb
Bundle.entry:Organization.search.mode	required	Pattern: include
Bundle.entry:Organization.request.method	required	HTTPVerb
Bundle.entry:RelatedPerson.search.mode	required	Pattern: include
Bundle.entry:RelatedPerson.request.method	required	HTTPVerb

Constraints

Id	Grade	Path(s)	Details	Requirements
app-2	error	Bundle.entry:Appointment.resource	Either start and end are specified, or neither : start.exists() = end.exists()
app-3	error	Bundle.entry:Appointment.resource	Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4	error	Bundle.entry:Appointment.resource	Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
bdl-5	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-8	error	Bundle.entry, Bundle.entry:Appointment, 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:RelatedPerson	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
dom-2	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Bundle.entry:Appointment.resource, Bundle.entry:Slot.resource, Bundle.entry:Schedule.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Location.resource, Bundle.entry:HealthcareService.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Bundle.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:Appointment.extension, Bundle.entry:Appointment.modifierExtension, Bundle.entry:Appointment.search.extension, Bundle.entry:Appointment.search.modifierExtension, Bundle.entry:Appointment.request.extension, Bundle.entry:Appointment.request.modifierExtension, Bundle.entry:Appointment.response.extension, Bundle.entry:Appointment.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.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Bundle.entry:Organization.resource	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0

This structure is derived from Bundle

Summary

Mandatory: 0 element (11 nested mandatory elements)
Prohibited: 22 elements

Structures

This structure refers to these other structures:

• FrAppointment (http://interopsante.org/fhir/StructureDefinition/FrAppointment)
• FrSlot (http://interopsante.org/fhir/StructureDefinition/FrSlot)
• FrSchedule (http://interopsante.org/fhir/StructureDefinition/FrSchedule)
• FrPatient (http://interopsante.org/fhir/StructureDefinition/FrPatient)
• FrPractitioner (http://interopsante.org/fhir/StructureDefinition/FrPractitioner)
• AS PractitionerRole Profile (https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-practitionerrole)
• FrLocation (http://interopsante.org/fhir/StructureDefinition/FrLocation)
• FrHealthcareService (http://interopsante.org/fhir/StructureDefinition/FrHealthcareService)
• FrOrganization (http://interopsante.org/fhir/StructureDefinition/FrOrganization)
• FrRelatedPerson (http://interopsante.org/fhir/StructureDefinition/FrRelatedPerson)

Slices

This structure defines the following Slices:

• The element Bundle.entry is sliced based on the value of profile:resource