Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

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

Resource Profile: RTPBC Request Bundle - Non-PHI

This profile provides minimal, non-persoanlly-identifiable content for submission in an RTPBC request to data sources that can provide benefit or price information without receiving patient details.

Usages:

• Examples for this Profile: Bundle/rtpbc-bundle-request-non-phi-1 and Bundle/rtpbc-bundle-request-non-phi-2

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	SΣ	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. Fixed Value: message
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 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	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry:messageheader	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:claim.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	Bundle	Contains a collection of resources
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message
total		0..0		If search, the total number of matches
Slices for entry	S	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
entry:All Slices				Content/Rules for all slices
search		0..0		Search related information
request		0..0		Additional execution information (transaction/batch/history)
response		0..0		Results of execution (transaction/batch/history)
entry:messageheader	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	SΣ	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. Fixed Value: message
timestamp	Σ	0..1	instant	When the bundle was assembled
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
entry:messageheader	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:claim.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:claim.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Must-Support: 16 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• RTPBC Request MessageHeader (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-messageheader)
• RTPBC Request Using Claim - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-claim-non-phi)
• RTPBC Patient - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-patient-non-phi)
• RTPBC Medication Request - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-medicationrequest-non-phi)
• RTPBC Pharmacy Organization (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-pharmacy-organization)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
• RTPBC Coverage (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-coverage)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Bundle.entry

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	SΣ	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. Fixed Value: message
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 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	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry:messageheader	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:claim.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	Bundle	Contains a collection of resources
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message
total		0..0		If search, the total number of matches
Slices for entry	S	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource
entry:All Slices				Content/Rules for all slices
search		0..0		Search related information
request		0..0		Additional execution information (transaction/batch/history)
response		0..0		Results of execution (transaction/batch/history)
entry:messageheader	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	S	0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	0..1	Identifier	Persistent identifier for the bundle
type	SΣ	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. Fixed Value: message
timestamp	Σ	0..1	instant	When the bundle was assembled
link	Σ	0..*	BackboneElement	Links related to this Bundle
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relation	Σ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
url	Σ	1..1	uri	Reference details for the link
Slices for entry	SΣC	3..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	0..1	Resource	A resource in the bundle
entry:messageheader	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcRequestMessageHeader	A resource that describes a message that is exchanged between systems
entry:claim	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcRequestClaimNonPHI	Claim, Pre-determination or Pre-authorization
entry:patient	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcPatientNonPHI	Information about an individual or animal receiving health care services
entry:medicationrequest	SΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcMedicationRequestNonPHI	Ordering of medication for patient or group
entry:pharmacy	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcPharmacy	A grouping of people or organizations with a common purpose
entry:practitioner	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
entry:coverage	SΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
link	Σ	0..*	See link (Bundle)	Links related to this entry
fullUrl	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	S	1..1	RtpbcCoverage	Insurance or medical plan or a payment agreement
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:messageheader.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:claim.search.​mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:claim.request.​method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:patient.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:patient.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:medicationrequest.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:pharmacy.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:practitioner.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​search.mode	Base	required	SearchEntryMode	📍4.0.1	FHIR Std.
Bundle.entry:coverage.​request.method	Base	required	HTTPVerb	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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:messageheader, Bundle.entry:claim, Bundle.entry:patient, Bundle.entry:medicationrequest, Bundle.entry:pharmacy, Bundle.entry:practitioner, Bundle.entry:coverage	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)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Must-Support: 16 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• RTPBC Request MessageHeader (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-messageheader)
• RTPBC Request Using Claim - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-claim-non-phi)
• RTPBC Patient - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-patient-non-phi)
• RTPBC Medication Request - Non-PHI (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-medicationrequest-non-phi)
• RTPBC Pharmacy Organization (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-pharmacy-organization)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
• RTPBC Coverage (http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-coverage)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Bundle.entry

Maturity: 4

Other representations of profile: CSV, Excel, Schematron