Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
This page is part of the Bidirectional Services eReferrals (BSeR) (v2.0.0-ballot: STU 2) 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 
| Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/bser-bundle-batch-query-referral-supporting-info | Version: 2.0.0-ballot | |||
| Active as of 2023-07-31 | Computable Name: BSeRBundleBatchQueryReferralSupportingInfo | |||
This Bundle profile is of type batch, is used to contain queries to represent use case specific referral request and feedback supporting information, and allows for descriptive query information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | 0..* | Bundle | Contains a collection of resources | |
  meta | ||||
   Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
   profile:asserted | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/bser/StructureDefinition/bser-bundle-batch-query-referral-supporting-info | |
 type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: batch | |
| entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 description | 0..1 | string | Extension URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |
| 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: batch |
 entry | ΣC | 1..* | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Bundle.type | required | Pattern: batch |
| Bundle.entry.request.method | required | HTTPVerb |
| 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 | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | ||||
| profile:asserted | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/bser/StructureDefinition/bser-bundle-batch-query-referral-supporting-info | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: batch | ||||
| timestamp | Σ | 0..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | ||||
| entry | ΣC | 1..* | 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 | 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 | ||||
| request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| description | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Bundle.meta.security | extensible | All Security Labels | ||||
| Bundle.meta.tag | example | CommonTags | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | Pattern: batch | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | HTTPVerb |
This structure is derived from Bundle
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | 0..* | Bundle | Contains a collection of resources | |
| meta | ||||
| Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | |
| profile:asserted | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/bser/StructureDefinition/bser-bundle-batch-query-referral-supporting-info | |
| type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: batch | |
| entry | 1..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 0..1 | string | Extension URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |
| 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: batch |
| entry | ΣC | 1..* | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| description | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Bundle.type | required | Pattern: batch |
| Bundle.entry.request.method | required | HTTPVerb |
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 | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by pattern:$this | ||||
| profile:asserted | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://hl7.org/fhir/us/bser/StructureDefinition/bser-bundle-batch-query-referral-supporting-info | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: batch | ||||
| timestamp | Σ | 0..1 | instant | When the bundle was assembled | ||||
| total | ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link | Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 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 | ||||
| entry | ΣC | 1..* | 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 | 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 | ||||
| request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| description | 0..1 | string | Optional Extensions Element URL: http://hl7.org/fhir/us/bser/StructureDefinition/query-description | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| signature | ΣTU | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Bundle.meta.security | extensible | All Security Labels | ||||
| Bundle.meta.tag | example | CommonTags | ||||
| Bundle.language | preferred | CommonLanguages
| ||||
| Bundle.type | required | Pattern: batch | ||||
| Bundle.entry.search.mode | required | SearchEntryMode | ||||
| Bundle.entry.request.method | required | HTTPVerb |
This structure is derived from Bundle
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Public Health Working Group. Package hl7.fhir.us.bser#2.0.0-ballot based on FHIR 4.0.1. Generated 2023-07-31
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change