3.54 StructureDefinition: Interaction Bundle - Organization Query
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization
Provider and Location Registry - Introduction
The Provider Registry provides searchable access to practitioners (prescribers) and organizations (clinics and pharmacies). It provides a standard FHIR RESTful interface supporting both read and search capabilities.
Organization and Practitioner reads and queries are executed based upon the context; either PrescribeIT™ or SharedHealth (MedDialog). As such, the endpoints for a given record will be different for each. For a given practitioner or organization record, there will be two endpoints and the vendor must select and use the appropriate endpoint depending on the type of query or message. In the messages, references will be the full URL
A summary of their function is found in the table below:
| Provider and Location Registry function | HTTP action | HTTP Payload Profile | Example |
|---|---|---|---|
| Organization | |||
| Read Organization request |
GET https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/[Organization id]
|
N/A | N/A |
| Read Organization response | HTTP 200 GET Response w/ FHIR Organization payload | Organization response | Organization read |
| Search Organization request |
GET https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization?[Organization search parameters] (see below) |
N/A | N/A |
| Search Organization response | HTTP 200 GET Response w/ FHIR Bundle searchset payload | Organization response | Organization Search response |
3.54.1 Search Parameters
When performing a search, the requester must specify one or more search criteria to filter the set of organizations that can be returned. The table below summarizes the search parameters that can be used and which resources they can be used for. (Note that parameters sent in the URL must be appropriately escaped.)
There are 3 types of searches supported: 1) Identifier Search (GET), 2) Discrete Fields Search, and 3) Elastic Search
On a Search response, we return a searchset bundle. If the "_revinclude=Practitioner:organization" parameter is specified then the service should return full Practitioner resources for each of the organizations.
The structure of the Organization Query Response
Group No 1 (identifier search)
For the GET response, you only get one and only one resource. The resource is returned directly not wrapped in a bundle. Details on the response can be found here.
| Parameter | Used for | Required/Optional | Description | Example |
|---|---|---|---|---|
| identifier | Organization/practitioner | Required | Matches on either the provider registry identifier (CPR) for practitioner or organization |
identifier=2263396629|http%3A%2F%sharedhealth.exchange%2Ffhir%2FNamingSystem%2Fregistry-id-organization |
|
Matches on license number for the practitioner |
identifier=134IDY41W988|urn%3Aoid%3A2.16.840.1.113883.2.4.6.3 |
|||
| _revinclude | Organization | Optional | This causes the query to return all practitioners associated with Organization that meet the search criteria |
_revinclude=Practitioner:organization |
| _include | Practitioner | Optional | This causes the query to return all organizations pointed to by Practitioner that meet the search criteria. |
_include=Practitioner:organization |
|
Examples: $URL/Organization?identifier=200020258|http%3A%2F%sharedhealth.exchange%2Ffhir%2FNamingSystem%2Fregistry-id-organization&_revinclude=Practitioner:organization $URL/Practitioner?identifier=200020258|http%3A%2F%sharedhealth.exchange%2Ffhir%2FNamingSystem%2Fregistry-id-organization $URL/Practitioner?identifier=134IDY41W988|urn%3Aoid%3A2.16.840.1.113883.2.4.6.3&_include=Practitioner:organization $URL/Practitioner?identifier=134IDY41W988|urn%3Aoid%3A2.16.840.1.113883.2.4.6.3 |
||||
Group No 2 Organization Search - Discrete fields
Startwith Rules*: A "startwith" search will search across each word within the name (eg Organization or Practitioner name) rather than the start of the name as a whole. For example: If searching for a query string = "pharm", the result set would include both "Pharmacy ABC" and "Sue's Pharmacy" because the search tokenizes the names and therefore searches across the words "Pharmacy" and "ABC" in the first instance and "Sue's" and "Pharmacy" in the second instance.
For a Discrete field search, the query may return multiple resources in a searchset bundle. Details on the response can be found here.
| Parameter | Used for | Required/ Optional | Description | Example |
|---|---|---|---|---|
| role | Org | Required | Matches on the roles performed by the Organization (clinic or pharmacy). Min Search characters: 3 |
role=PROFF |
| address-state:exact | Org | Required | This searches for an exact match on the province or territory of the service location's address |
address-state:exact=ON |
|
address-city:exact |
Org |
Optional |
This searches for an exact match, on the municipality of the service location's address. Minimum 3 characters. |
address-city:exact=Hamilton |
|
address-city |
This searches for starts with, on the municipality of the service location's address. Minimum 3 characters. |
|||
|
address-line:exact |
Org |
Optional |
This searches for an exact match on the street address line of the service location's address. |
address-line:exact=123%20North%20102nd%20Street |
|
address-line:contains |
Searches for contains address line |
|||
|
address-postalcode |
Org |
Optional |
This searches for a starts-with match on the postal code of the service location's address. Minimum 3 characters. |
address-postalcode=H3H |
|
name:contains |
Org |
Optional |
Partial match search on the name of the pharmacy, clinic. Minimum 3 characters. |
name=Simplicity (you can't use both parameters together, you only allowed to use one of them) |
|
name |
Starts with search for organization name. Minimum 3 characters. |
|||
|
telecom-phone:exact |
Org |
Optional |
This searches for an exact match on one of the 10-digit phone numbers of the organization |
telecom-phone:exact=5555551212 |
|
_revinclude |
Org |
Optional |
This causes the query to return all practitioners associated with Organization that meet the search criteria |
_revinclude=Practitioner:organization |
|
Examples: $URL/Organization?role=OUTPHARM&address-state:exact=ON&address-city:exact=Hamilton&name=Test&address-line:contains=Cotu $URL/Organization?role=PROFF&address-state:exact=ON&address-city:exact=Hamilton&name:contains=st&address-line:exact=jean Cotu&telecom-phone:exact=5343434434 |
||||
Group No 3 Organization Search Elastic
Startwith Rules*: A "startwith" search will search across each word within the name (eg Organization or Practitioner name) rather than the start of the name as a whole. For example: If searching for a query string = "pharm", the result set would include both "Pharmacy ABC" and "Sue's Pharmacy" because the search tokenizes the names and therefore searches across the words "Pharmacy" and "ABC" in the first instance and "Sue's" and "Pharmacy" in the second instance.
For an elastic search, the result may include multiple resources, returned in a searchset bundle. Details on the response can be found here.
| Parameter | Used for | Required/ Optional | Description | Example | |
|---|---|---|---|---|---|
| role | Org | Required | Matches on the roles performed by the Organization (clinic or pharmacy). |
role=PROFF |
|
| address-state:exact | Org | Required | This searches for an exact match on the province or territory of the service location's address (exact match) | address-state:exact=ON | |
| elastic-search-string | Org | Required | Multiple search terms separated by spaces (URL escaped). Minimum 1 character. | elastic-search-string=smith+john+hamilt | |
| elastic-search-attribute-set | Org | Required |
The defined ‘elastic-search-string’ values will be evaluated against each of the data elements identified by the code set. (startswith). Code set. Currently supported values: set-001 and set-002. Set-001 defined as:
Set-002 (includes set-001 and adds)
|
elastic-search-attribute-set=set-001 or elastic-search-attribute-set=set-002 |
|
| Entity-service-code | Organization | Optional | This may be used to scope the query results to a specifc service. If this is not specified, the query results will include all services for a given domain (e.g. a PrescribeIT™ query will return both the Clinical Communications service and the core PrescribeIT service). Use Value from SharedServiceType. Exact Match. | ||
| _revinclude | Organization | Optional | This causes the query to return all practitioners associated with Organization that meet the search criteria. Exact match. |
_revinclude=Practitioner:organization |
|
|
Examples: $URL/Organization?role=OUTPHARM&address-state:exact=ON&elastic-search-string=georgian+bay&elastic-search-attribute-set=set-001 |
|||||
Example of search combinations.
Note: you cannot combine exact and contains parameters, you are only allowed one of them.
| 1. |
Search by Identifier |
| 2. |
Search for Organization by City |
| 3. |
Search for Organization by Postal Code |
3.54.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shared Health Bundle - Query Response
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Bundle | 0..* | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. | |
 id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT™ system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT™ system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
 profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| profile (Profile) | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
 tag(version) | 1..1 | Coding | Binding: SharedSpecificationVersion (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. |
  system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
 code | 1..1 | code | Fixed Value: Shared2.0 Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: Fixed value: Shared2.0 |
| type | 1..1 | code | Binding: BundleType (required) Fixed Value: searchset Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: searchset |
| total | 0..1 | unsignedInt | Definition: If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle). Comments: Only used if the bundle is a search result set. |
| link | 1..* | BackboneElement | Slice: Unordered, Open by value:relation Definition: A series of links that provide context to this bundle. |
| link (self) | 1..1 | BackboneElement | Definition: A series of links that provide context to this bundle. Comments: Echoes the submitted query, including only those parameters which were processed by the server. This allows for the possibility that the server might not support all of the parameters submitted by the client. Conformance Rule: Implementations are expected to check that the query that was executed corresponds with what they had intended. |
| relation | 1..1 | string | Fixed Value: self Definition: A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]. Comments: Fixed value: self |
| url | 1..1 | uri | Definition: The reference details for the link. |
| link (next) | 0..1 | BackboneElement | Definition: A series of links that provide context to this bundle. |
| relation | 1..1 | string | Fixed Value: next Definition: A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]. Comments: Fixed value: next |
| url | 1..1 | uri | Definition: The reference details for the link. Comments: If present, indicates additional results are available and can be retrieved by performing a GET on this URL |
| entry | 1..* | BackboneElement | bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| fullUrl | 1..1 | uri | Definition: The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified. Comments: fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id. |
| resource | 1..1 | Resource | Definition: The Resources for the entry. |
| search | 1..1 | BackboneElement | Definition: Information about the search process that lead to the creation of this entry. |
| mode | 1..1 | code | Binding: SearchEntryMode (required) Definition: Why this entry is in the result set - whether it's included as a match or because of an _include requirement. Comments: There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. |
This structure is derived from Shared Health Bundle - Query Response
Summary
Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
- The element Bundle.meta.profile is sliced based on the value of value:value
This structure is derived from Shared Health Bundle - Query Response
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Bundle | S | 0..* | ||
| meta | S | 1..1 | Meta | |
 profile | S | uri | Slice: Unordered, Open by value:value | |
| profile | S | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| tag | S | 1..1 | Coding | |
| code | S | 1..1 | code | Fixed Value: Shared2.0 |
| entry | SI | 1..* | BackboneElement | entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes |
| search | S | 1..1 | BackboneElement | |
| mode | S | 1..1 | code | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Contains a collection of resources | |
 id | SΣ | 0..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | uri | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared2.0 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| type | SΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: searchset |
| total | SΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | SΣ | BackboneElement | Links related to this Bundle Slice: Unordered, Open by value:relation | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
 url | Σ | 1..1 | uri | Reference details for the link |
| link | SΣ | 1..1 | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | SΣ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml Fixed Value: self |
| url | SΣ | 1..1 | uri | Reference details for the link |
| link | SΣ | 0..1 | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | SΣ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml Fixed Value: next |
| url | SΣ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | Σ | 0..* | Unknown reference to #Bundle.link:next Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
 resource | SΣ | 1..1 | Resource | A resource in the bundle |
| search | SΣI | 1..1 | BackboneElement | Search related information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | SΣ | 1..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Bundle - Query Response
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Bundle | 0..* | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. | |
| id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT™ system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT™ system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
| profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| profile (Profile) | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | 1..1 | code | Fixed Value: Shared2.0 Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: Fixed value: Shared2.0 |
| type | 1..1 | code | Binding: BundleType (required) Fixed Value: searchset Definition: Indicates the purpose of this bundle- how it was intended to be used. Comments: Fixed value: searchset |
| total | 0..1 | unsignedInt | Definition: If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle). Comments: Only used if the bundle is a search result set. |
| link | 1..* | BackboneElement | Slice: Unordered, Open by value:relation Definition: A series of links that provide context to this bundle. |
| link (self) | 1..1 | BackboneElement | Definition: A series of links that provide context to this bundle. Comments: Echoes the submitted query, including only those parameters which were processed by the server. This allows for the possibility that the server might not support all of the parameters submitted by the client. Conformance Rule: Implementations are expected to check that the query that was executed corresponds with what they had intended. |
| relation | 1..1 | string | Fixed Value: self Definition: A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]. Comments: Fixed value: self |
| url | 1..1 | uri | Definition: The reference details for the link. |
| link (next) | 0..1 | BackboneElement | Definition: A series of links that provide context to this bundle. |
| relation | 1..1 | string | Fixed Value: next Definition: A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]. Comments: Fixed value: next |
| url | 1..1 | uri | Definition: The reference details for the link. Comments: If present, indicates additional results are available and can be retrieved by performing a GET on this URL |
| entry | 1..* | BackboneElement | bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes Definition: An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). |
| fullUrl | 1..1 | uri | Definition: The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified. Comments: fullUrl may not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the absolute URL may not end with the logical id of the resource (Resource.id), but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then it SHALL end with the Resource.id. |
| resource | 1..1 | Resource | Definition: The Resources for the entry. |
| search | 1..1 | BackboneElement | Definition: Information about the search process that lead to the creation of this entry. |
| mode | 1..1 | code | Binding: SearchEntryMode (required) Definition: Why this entry is in the result set - whether it's included as a match or because of an _include requirement. Comments: There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. |
This structure is derived from Shared Health Bundle - Query Response
Summary
Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
- The element Bundle.meta.profile is sliced based on the value of value:value
Differential View
This structure is derived from Shared Health Bundle - Query Response
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | S | 0..* | ||
| meta | S | 1..1 | Meta | |
| profile | S | uri | Slice: Unordered, Open by value:value | |
| profile | S | 1..1 | uri | Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| tag | S | 1..1 | Coding | |
| code | S | 1..1 | code | Fixed Value: Shared2.0 |
| entry | SI | 1..* | BackboneElement | entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes |
| search | S | 1..1 | BackboneElement | |
| mode | S | 1..1 | code | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Contains a collection of resources | |
| id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | uri | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-organization |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Shared2.0 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| type | SΣ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) Fixed Value: searchset |
| total | SΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | SΣ | BackboneElement | Links related to this Bundle Slice: Unordered, Open by value:relation | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| link | SΣ | 1..1 | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | SΣ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml Fixed Value: self |
| url | SΣ | 1..1 | uri | Reference details for the link |
| link | SΣ | 0..1 | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| relation | SΣ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml Fixed Value: next |
| url | SΣ | 1..1 | uri | Reference details for the link |
| entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource, or information entryIsOrganization: Match entries must be Bundles declaring profile-organization-tpr includeIsPractitioner: Include entries must be Bundles declaring profile-practitioner-tpr outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | Σ | 0..* | Unknown reference to #Bundle.link:next Links related to this entry | |
| fullUrl | SΣ | 1..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
| resource | SΣ | 1..1 | Resource | A resource in the bundle |
| search | SΣI | 1..1 | BackboneElement | Search related information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | SΣ | 1..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required) |
| 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
3.54.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Bundle.meta.security | All Security Labels | extensible | All Security Labels |
| Bundle.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Bundle.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Bundle.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Bundle.type | BundleType | required | BundleType |
| Bundle.entry.search.mode | SearchEntryMode | required | SearchEntryMode |
| Bundle.entry.request.method | HTTPVerb | required | HTTPVerb |
3.54.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-7 | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId : entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-3 | Bundle | entry.request only for some types of bundles : entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history' | |
| bdl-4 | Bundle | entry.response only for some types of bundles : entry.response.empty() or type = 'batch-response' or type = 'transaction-response' | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-6 | Bundle.entry | The fullUrl element must be present when a resource is present, and not present otherwise : fullUrl.empty() xor resource.exists() | |
| entryIsOrganization | Bundle.entry | Match entries must be Bundles declaring profile-organization-tpr : search.mode='match' implies resource.meta.where(profile='http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr').exists() | |
| includeIsPractitioner | Bundle.entry | Include entries must be Bundles declaring profile-practitioner-tpr : search.mode='include' implies resource.meta.where(profile='http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr').exists() | |
| outcomeIsOperationOutcome | Bundle.entry | Outcome entries must be OperationOutcomes : search.mode='outcome' implies resource.is(OperationOutcome) |