CARIN Consumer Realtime Pharmacy Benefit Check
- CI Build

This page is part of the Consumer Real-time Pharmacy Benefit Check (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

SD.11 StructureDefinition-carin-rtpbc-request-bundle

This profile constrains a Bundle resource for use as the request in a Real-time Pharmacy Benefit Check (RTPBC) process.

The request Bundle profile identifies the resources to be submitted in an RTPBC request. The following are used in all circumstances and have a minimum cardinality of 1:

  • Claim
  • Patient
  • MedicationRequest
  • Pharmacy
  • Practitioner
  • In addition, the Coverage resource is necessary when submitting a request to an insurer or other agent representing the patient’s pharmacy benefit. It’s minimum cardinality is 0.

Must Support elements in this profile

Client systems

  • All the above Bundle resource entries are designated Must Support. The required elements MUST be populated with correct and complete information in order to elicit reliable information in the RTPBC response.
  • When submitting to an insurer, the Coverage resource MUST also be populated.

Responding insurer systems

  • MUST accept all Must Support resources and make use of provided information when determining cost and coverage

Responding discount pricing sources

  • Must accept Claim, Patient, MedicationRequest, Pharmacy and Practitioner resources and use as applicable when determining pricing information

SD.11.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/carin/StructureDefinition/rtpbc-request-bundle

Published on Sun Dec 08 05:00:00 UTC 2019 as a active by CARIN Alliance.

This profile builds on Bundle


NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... identifier ΣI0..1IdentifierPersistent identifier for the bundle
... type SΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp ΣI0..1instantWhen the bundle was assembled
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI6..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type: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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
.... entry:messageheader SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcRequestMessageHeaderA resource that describes a message that is exchanged between systems
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:claim SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcRequestClaim, Pre-determination or Pre-authorization
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPatientInformation about an individual or animal receiving health care services
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:medicationrequest SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcMedicationRequestOrdering of medication for patient or group
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:pharmacy SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPharmacyA grouping of people or organizations with a common purpose
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitioner SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:coverage SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI0..1CarinRtpbcCoverageInsurance or medical plan or a payment agreement
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... identifier ΣI0..1IdentifierPersistent identifier for the bundle
... type SΣI1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required)
Fixed Value: message
... timestamp ΣI0..1instantWhen the bundle was assembled
... link ΣI0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣI1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url ΣI1..1uriReference details for the link
... entry SΣI6..*(Slice Definition)Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type: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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
.... entry:messageheader SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcRequestMessageHeaderA resource that describes a message that is exchanged between systems
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:claim SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcRequestClaim, Pre-determination or Pre-authorization
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPatientInformation about an individual or animal receiving health care services
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:medicationrequest SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcMedicationRequestOrdering of medication for patient or group
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:pharmacy SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPharmacyA grouping of people or organizations with a common purpose
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitioner SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI1..1CarinRtpbcPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:coverage SΣI1..1BackboneElementEntry 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..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link ΣI0..*Unknown reference to #Bundle.link
Links related to this entry
..... fullUrl ΣI0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SI0..1CarinRtpbcCoverageInsurance or medical plan or a payment agreement
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode ΣI0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required)
...... score ΣI0..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣI1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required)
...... url ΣI1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch ΣI0..1stringFor managing cache currency
...... ifModifiedSince ΣI0..1instantFor managing cache currency
...... ifMatch ΣI0..1stringFor managing update contention
...... ifNoneExist ΣI0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status ΣI1..1stringStatus response code (text optional)
...... location ΣI0..1uriThe location (if the operation returns a location)
...... etag ΣI0..1stringThe Etag for the resource (if relevant)
...... lastModified ΣI0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature ΣI0..1SignatureDigital Signature

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron