Specialty Medication Enrollment
0.1.0 - STU1 Ballot

Publication Build: This will be filled in by the publication tooling

## Resource Profile: Specialty Rx Bundle - Search Result

Defining URL: | http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result
Version: | 0.1.0
Name: | SpecialtyRxBundleSearchResult
Title: | Specialty Rx Bundle - Search Result
Status: | Active as of 2020-07-19T00:00:00-05:00
Definition: | This profile constrains a Bundle resource to carry the query results from a Specialty Rx Query
Publisher: | HL7 International - Pharmacy
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-search-result

The Must Support elements in this profile enable the Requesting System to associate results in a Specialty Rx Query Response message to the associated Specialty Rx Query. The profile reflects typical population of a searchset bundle, ensuring the presence of information the Requesting System needs to process the search results.

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from Bundle

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 9 elements
Fixed Value: 2 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

- The element Bundle.link is sliced based on the value of value:relation

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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: searchset
total | S | 0..1 | unsignedInt | If search, the total number of matches
link | S | 1..* | (Slice Definition) | Links related to this Bundle Slice: Unordered, Open by value:relation
link:self | S | 1..* | BackboneElement | Links related to this Bundle
relation | S | 1..1 | string | Executed search Fixed Value: self
entry | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource | S | 1..1 | Resource | A resource in the bundle
search | S | 0..1 | BackboneElement | Search related information
mode | S | 0..1 | code | match | include | outcome - why this is in the result set
request |  | 0..0 |  |
response |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language.
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: searchset
timestamp | Σ | 0..1 | instant | When the bundle was assembled
total | S Σ I | 0..1 | unsignedInt | If search, the total number of matches
link | S Σ | 1..* | (Slice Definition) | Links related to this Bundle Slice: Unordered, Open by value:relation
link: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
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
link:self | S Σ | 1..* | 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 | S Σ | 1..1 | string | Executed search Fixed Value: self
url | Σ | 1..1 | uri | Reference details for the link
entry | S Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 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 | Resource | A resource in the bundle
search | S Σ I | 0..1 | BackboneElement | Search related information
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
mode | S Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1)
signature | Σ | 0..1 | Signature | Digital Signature
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources
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. Fixed Value: searchset
total | Σ I | 0..1 | unsignedInt | If search, the total number of matches
link | Σ | 1..* | (Slice Definition) | Links related to this Bundle Slice: Unordered, Open by value:relation
link:self | Σ | 1..* | BackboneElement | Links related to this Bundle
relation | Σ | 1..1 | string | Executed search Fixed Value: self
entry | Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
resource | Σ | 1..1 | Resource | A resource in the bundle
search | Σ I | 0..1 | BackboneElement | Search related information
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 9 elements
Fixed Value: 2 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

- The element Bundle.link is sliced based on the value of value:relation

Differential View

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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: searchset
total | S | 0..1 | unsignedInt | If search, the total number of matches
link | S | 1..* | (Slice Definition) | Links related to this Bundle Slice: Unordered, Open by value:relation
link:self | S | 1..* | BackboneElement | Links related to this Bundle
relation | S | 1..1 | string | Executed search Fixed Value: self
entry | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource | S | 1..1 | Resource | A resource in the bundle
search | S | 0..1 | BackboneElement | Search related information
mode | S | 0..1 | code | match | include | outcome - why this is in the result set
request |  | 0..0 |  |
response |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language.
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: searchset
timestamp | Σ | 0..1 | instant | When the bundle was assembled
total | S Σ I | 0..1 | unsignedInt | If search, the total number of matches
link | S Σ | 1..* | (Slice Definition) | Links related to this Bundle Slice: Unordered, Open by value:relation
link: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
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
link:self | S Σ | 1..* | 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 | S Σ | 1..1 | string | Executed search Fixed Value: self
url | Σ | 1..1 | uri | Reference details for the link
entry | S Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 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 | Resource | A resource in the bundle
search | S Σ I | 0..1 | BackboneElement | Search related information
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
mode | S Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1)
signature | Σ | 0..1 | Signature | Digital Signature
Documentation for this format

Other representations of profile: Schematron

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages
Bundle.type | required | Fixed Value: searchset
Bundle.entry.search.mode | required | SearchEntryMode
Bundle.entry.request.method | required | HTTPVerb

#### Constraints

Id | Path | Details | Requirements
bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | 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 | 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-7 | 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-9 | 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 | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
ele-1 | Bundle.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.total | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.link.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link:self | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link:self.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.link:self.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.link:self.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.link:self.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.link:self.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.link:self.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.search | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Bundle.entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Bundle.entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Bundle.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |