Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner

Provider and Location Registry - Introduction

The Provider Registry provides searchable access to practitioners (prescribers) and organizations (clinics and pharmacies). Health Exchange maintains a cache of the Registry data that supports both read and search capabilities.

Organization and Practitioner reads and queries are executed based upon the context. 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 (**will change per environment, see SDF documentation) HTTP Payload Profile Example
Practitioner
Read Practitioner request GET https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Practitioner/[Practitioner id] N/A N/A
Read Practitioner response HTTP 200 GET Response w/ FHIR Practitioner payload Practitioner response Practitioner read
Search Practitioner request GET https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Practitioner?[Practitioner search parameters] (see below) N/A N/A
Search Practitioner response HTTP 200 GET Response w/ FHIR Bundle searchset payload Practitioner response Practitioner Search response

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.

Group No 1 (Identifier Search)

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%7Chttp://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner

identifier=2263396629

(identifier will be CPRID for practitioner or organization concatenated or not with URI identifier of Shared Health)

Matches on license number for the practitioner

identifier=134IDY41W988%7Curn:oid:2.16.840.1.113883.2.4.6.3
(identifier will be the Licence number for practitioner concatenated with college ID number)

_revinclude

Organization

Optional

This causes the query to return all practitioners associated with the Organization that met the search criteria. The practitioners are returned directly following the organization within the response. Organization A, Practitioner X, Practitioner Y. Organization B, Practitioner Y, Practitioner Z. Note: This pattern allows for the same profiles to appear in the response multiple times.

_revinclude=Practitioner:organization

(Value must equal Practitioner:organization otherwise related practitioners won't return)

_include

Practitioner

Optional

This causes the query to return all organizations pointed to the Practitioner that met the search criteria. The Organizations are returned directly following the Practitioner, within the response. Practioner A, Organization X, Organization Y. Practioner B, Organization Y, Organization Z. Note: This pattern allows for the same profiles to appear in the response multiple times.

_include=Practitioner:organization

(Value must equal Practitioner:organization)

Examples:

$URL/Organization?identifier=200020258%7Chttp:// sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner&_revinclude=Practitioner:organization$URL/Practitioner?identifier=200020258%7Chttp://

$URL/Practitioner?identifier=200020258%7Chttp:// sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner

$URL/Practitioner?identifier=134IDY41W988%7Curn:oid:2.16.840.1.113883.2.4.6.3&_include=Practitioner:organization

$URL/Practitioner?identifier=134IDY41W988%7Curn:oid:2.16.840.1.113883.2.4.6.3

Group No 4 Practitioner Search By Discrete Fields

For a Discrete field search, you can receive multiple resources, returned in a searchset bundle. Details on the response can be found here.

Parameter Used for Required / Optional Description Example
organization.address-state:exact Practitioner Required This match on the province or territory of one of the practitioner's service location's addresses. Exact match. organization.address-state:exact=ON
organization.address-city:exact Practitioner Optional This searches for an exact match on the municipality of one of the service location's addresses. Minimum 3 characters. organization.address-city:exact=Hamilton
organization.address-city =Hamilt
(you can't use both parameters together, you only allowed to one of them)
organization.address-city This searches for start with match on the municipality of one of the service location's addresses. Minimum 3 characters.
organization.address-line:exact Practitioner Optional This searches for an exact match on the street address line of the service location's address. organization.address-line:exact=123 North 102nd
organization.address-line:contains=North
(you can't use both parameters together, you only allowed to one of them)
organization.address-line:contains This searches for contains match on the street address line of the service location's address.
organization.address-postalcode Practitioner Optional This searches for start with match on the municipality of one of the service location's postal code. Minimum 3 characters. All white spaces will be ignored. Format: "H3H", "H3H3", "H3H 3", "H3H 3H", "H3H 3H3", etc. address-postalcode=H3H or address-postalcode=H3H3 or address-postalcode=H3H 3H3
name-family:contains Practitioner Optional Partial match search on the family name of the practitioner. Minimum 3 characters. name-family:contains=impl
name-family Practitioner Optional This searches for family name (start with). Minimum 3 characters. name-family=elso
name-given Practitioner Optional This searches for given name (start with). Minimum 3 characters. name-given=bas
telecom-phone:exact Practitioner Optional This searches for an exact match on one of the 10-digit phone numbers of the practitioner telecom-phone:exact=5555551212
_include Practitioner Optional This causes the query to return all organizations pointed to by Practitioner that meet the search criteria. _include=Practitioner:organization
(Value must equal Practitioner:organization)
role Practitioner Optional This searches for an exact role match role=doctor
specialty Practitioner Optional This searches for specialty (contains). Minimum 3 characters. specialty=Fam
license (cps-id) Practitioner Optional This searches for exact match for cps-id cps-id=2.16.840.1.113883.4.756

Examples

$URL/Practitioner?organization.address-state:exact=ON& organization.address-city:exact=Hamilton&name:contains=Test&organization.address-line:contains=Cotu

$URL/Practitioner?organization.address-state:exact=ON&organization.address-city=Hamil&name:contains=Test&organization.address-line:contains=Cotu

/tpr-fhir/fhir/Practitioner?organization.address-state:exact=BC&cps-id=2.16.840.1.113883.4.756

/tpr-fhir/fhir/Practitioner?organization.address-state:exact=BC&specialty=Fam

Group No 5 Practitioner Search by Elastic

Startwith Rules*: A "startwith" search will search across each word within the name (e.g. 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, you can receive multiple resources, returned in a searchset bundle. Details on the response can be found here.

Parameter Used for Required/ Optional Description Example

organization.address-state:exact

Practitioner

Required

This searches for an exact match on the province or territory of one of the practitioner's service location's addresses.

organization.address-state:exact=ON

elastic-search-string

Practitioner

Required

Multiple search terms separated by spaces (URL escaped) (startswith). Minimum 3 characters.

elastic-search-string=smith+john+phys+hamil

elastic-search-attribute-set

Practitioner

Required

Code set. Currently supported values: set-001 and set-002.

With set-001 defined as:

  • last Name
  • first name
  • Specialty *** see note below
  • city

Set-002 includes set-001 and adds:

  • address
  • postal code
  • phone number
  • fax number

elastic-search-attribute-set=set-001

or

elastic-search-attribute-set=set-002

entity-service-code

Practitioner

Optional

value from the service code set. Exact match.

entity-service-code=presriber-erx /

meddialog-person-org

** see note below

_include

Practitioner

Optional

This causes the query to return all organizations pointed to by Practitioner that meet the search criteria. Exact match.

_include=Practitioner:organization

(Value must equal Practitioner:organization)

Examples:

$URL /Practitioner?organization.address-state:exact=BC&elastic-search-string=Sur Row&elastic-search-attribute-set=set-001

$URL /Practitioner?organization.address-state:exact=BC&elastic-search-string=greg 545&elastic-search-attribute-set=set-002

*** Elastic Search by Specialty

The following is a list of the Practitioner Role descriptions that are supported by our Provider Registry.

  • Generic practitioner search - string value = "physician". This will search all practitioners
  • Specialty practitioner search - string value = "use the terminology identified below" (e.g. "Family" for Family Medicine, Cardiac for Cardiac Surgery
  • For elastic search scenario "startswith" applies to each word separately. So for "Physician, Family Medicine", you could search for "Phys" or "Fam" or "Medi" but not for "amily"
  • Specialty Search will include matches on both the English and French description. The text that is used for Specialty searches will be used to search across both French and English versions of specialty within the PR.

Provider and Location Registry Role/Specialty Descriptions

English French

Physician, Anaesthesia

Médecin, anesthésie

Physician, Cardiac Surgery

Médecin, chirurgie cardiaque

Physician, Cardiology

Médecin, cardiologue

Physician, Immunology/Allergy

Médecin, immunologie/allergies

Physician, Colorectal Surgery

Médecin, chirurgie colorectale

Physician, Dermatology

Médecin, dermatologie

Physician, Diagn. Radiology

Méd., radiol. diagnostique

Physician, Emergency Medicine

Médecin, traumatologie

Physician, Endo / Metabolism

Médecin, endocrino./métabolisme

Physician, Family Medicine

Médecin, médecine familiale

Physician, Gastroenterology

Médecin, gastroentérologie

Physician, General Pathology

Médecin, pathologie générale

Physician, Gen. Internal Med.

Médecin, médecine interne gén.

Physician, General Practice

Médecin, pratique générale

Physician, General Surgery

Médecin, chirurgie générale

Physician, Geriatric Medicine

Médecin, gériatrie

Physician, GYN Oncology

Méd., oncologie gynécologique

Physician, Haematology

Médecin, hématologie

Physician, Hand Surgery

Médecin, chirurgie des mains

Physician, Infectious Diseases

Médecin, maladies infectieuses

Physician, Interventional RADL

Méd., radiol. d'intervention

Physician, Medical Oncology

Médecin, oncologie médicale

Physician, Nephrology

Médecin, néphrologie

Physician, Neurology

Médecin, neurologie

Physician, Neuro/Psychiatry

Médecin, neuro/psychiatrie

Physician, Neurosurgery

Médecin, neurochirurgie

Physician, Nuclear Medicine

Médecin, médecine nucléaire

Physician, Obstetrics/GYN

Méd., obstétrique/gynécologie

Physician, Ophthalmology

Médecin, ophtalmologie

Physician, Otolaryngology

Médecin, otolaryngologie

Physician, Orthopaedic Surgery

Médecin, médecine orthopédique

Physician, OMT

Médecin, ostéopraticien

Physician, Paediatrics

Médecin, pédiatrie

Physician, Physical Med./Rehab

Méd., réadapt. phys./médicale

Physician, Plastic Surgery

Médecin, chirurgie plastique

Physician, Preventive Medicine

Médecin, médecine préventive

Physician, Psychiatry

Médecin, psychiatrie

Physician, Pulmonary Diseases

Médecin, maladies pulmonaires

Physician, Radiation Oncology

Méd., oncologie radiologique

Physician, Rheumatology

Médecin, rhumatologie

Physician, Thoracic Surgery

Médecin, chirurgie thoracique

Physician, Urology

Médecin, urologue

Physician, Vascular Surgery

Médecin, chirurgie vasculaire

Physician, Unknown Specialty

Médecin, spécialité inconnue

Download Excel representation

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

>

This structure is derived from Shared Health Bundle - Query Response

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundle - Query Responsebdl-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..1idDefinition:
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..1MetaDefinition:
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..*uriSlice: 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..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
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-practitioner

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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..1CodingBinding: SharedSpecificationVersion (20210501) (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.



Usage Note: Only these 2 situations are not enforced by FHIR Validator:



  1. Non-routed EMR/PMS Inbox messages and Clear Queue Request that is sent only to Central Switch; and

  2. Synchronous messages generated by Central Switch (Errors with only OperationOutcome profile and Clear Queue Response)



....  system 1..1uriFixed 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..1codeFixed Value: Shared5.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: Shared5.0

..  type 1..1codeBinding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: searchset

..  total 0..1unsignedIntDefinition:
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..*BackboneElementSlice: Unordered, Open by value:relation
Definition:
A series of links that provide context to this bundle.

..  link
     (self)
1..1BackboneElementDefinition:
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.

...  relation 1..1stringFixed 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..1uriDefinition:
The reference details for the link.

..  link
     (next)
0..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
For Provider Registry Organization query, this element is not curently supported.

...  relation 1..1stringFixed 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..1uriDefinition:
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..*BackboneElementbdl-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
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-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..1uriDefinition:
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..1ResourceDefinition:
The Resources for the entry.

...  search 1..1BackboneElementDefinition:
Information about the search process that lead to the creation of this entry.

....  mode 1..1codeBinding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement.


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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health Bundle - Query ResponseContains a collection of resources
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... entry SI1..*BackboneElementEntry in the bundle - will have a resource, or information
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-tpr
outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes
.... search S1..1BackboneElementSearch related information
..... mode S1..1codematch | include | outcome - why this is in the result set

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health Bundle - Query ResponseContains a collection of resources
... id SΣ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
... total SΣI0..1unsignedIntIf 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..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
..... url Σ1..1uriReference details for the link
.... link:self SΣ1..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: self
..... url SΣ1..1uriReference details for the link
.... link:next SΣ0..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: next
..... url SΣ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource, or information
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-tpr
outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link 0..*See link (Bundle)Links related to this entry
.... fullUrl SΣ1..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ1..1ResourceA resource in the bundle
.... search SΣI1..1BackboneElementSearch related information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | 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.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Grid View

This structure is derived from Shared Health Bundle - Query Response

NameCard.TypeConstraints and Usage
.  Bundle 0..*Shared Health Bundle - Query Responsebdl-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..1idDefinition:
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..1MetaDefinition:
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..*uriSlice: 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..1uriFixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
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-practitioner

...  tag 1..*CodingSlice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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..1CodingBinding: SharedSpecificationVersion (20210501) (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.



Usage Note: Only these 2 situations are not enforced by FHIR Validator:



  1. Non-routed EMR/PMS Inbox messages and Clear Queue Request that is sent only to Central Switch; and

  2. Synchronous messages generated by Central Switch (Errors with only OperationOutcome profile and Clear Queue Response)



....  system 1..1uriFixed 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..1codeFixed Value: Shared5.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: Shared5.0

..  type 1..1codeBinding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
Definition:
Indicates the purpose of this bundle- how it was intended to be used.


Comments:
Fixed value: searchset

..  total 0..1unsignedIntDefinition:
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..*BackboneElementSlice: Unordered, Open by value:relation
Definition:
A series of links that provide context to this bundle.

..  link
     (self)
1..1BackboneElementDefinition:
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.

...  relation 1..1stringFixed 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..1uriDefinition:
The reference details for the link.

..  link
     (next)
0..1BackboneElementDefinition:
A series of links that provide context to this bundle.


Comments:
For Provider Registry Organization query, this element is not curently supported.

...  relation 1..1stringFixed 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..1uriDefinition:
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..*BackboneElementbdl-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
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-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..1uriDefinition:
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..1ResourceDefinition:
The Resources for the entry.

...  search 1..1BackboneElementDefinition:
Information about the search process that lead to the creation of this entry.

....  mode 1..1codeBinding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement.


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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle S0..*Shared Health Bundle - Query ResponseContains a collection of resources
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
..... tag:version S1..1CodingTags applied to this resource
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
... entry SI1..*BackboneElementEntry in the bundle - will have a resource, or information
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-tpr
outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes
.... search S1..1BackboneElementSearch related information
..... mode S1..1codematch | include | outcome - why this is in the result set

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle SΣI0..*Shared Health Bundle - Query ResponseContains a collection of resources
... id SΣ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-query-practitioner
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag SΣ1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:version SΣ1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: Shared5.0
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... type SΣ1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it was intended to be used.


Fixed Value: searchset
... total SΣI0..1unsignedIntIf 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..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation Σ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
..... url Σ1..1uriReference details for the link
.... link:self SΣ1..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: self
..... url SΣ1..1uriReference details for the link
.... link:next SΣ0..1BackboneElementLinks related to this Bundle
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... relation SΣ1..1stringhttp://www.iana.org/assignments/link-relations/link-relations.xhtml
Fixed Value: next
..... url SΣ1..1uriReference details for the link
... entry SΣI1..*BackboneElementEntry in the bundle - will have a resource, or information
entryIsPractitioner: Match entries must be Bundles declaring profile-practitioner-tpr
includeIsOrganization: Include entries must be Bundles declaring profile-organization-tpr
outcomeIsOperationOutcome: Outcome entries must be OperationOutcomes
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... link 0..*See link (Bundle)Links related to this entry
.... fullUrl SΣ1..1uriAbsolute URL for resource (server address, or UUID/OID)
.... resource SΣ1..1ResourceA resource in the bundle
.... search SΣI1..1BackboneElementSearch related information
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... mode SΣ1..1codematch | 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.

..... score Σ0..1decimalSearch ranking (between 0 and 1)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Constraints

PathConformanceValueSet / Code
Bundle.meta.securityextensibleAll Security Labels
Bundle.meta.tagexample
Bundle.meta.tag:versionrequiredFixed Value: Shared5.0
Bundle.languagerequiredhttp://tools.ietf.org/html/bcp47
Bundle.typerequiredFixed Value: searchset
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
IdPathDetailsRequirements
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-7BundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
: entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-3Bundleentry.request only for some types of bundles
: entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4Bundleentry.response only for some types of bundles
: entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-6Bundle.entryThe fullUrl element must be present when a resource is present, and not present otherwise
: fullUrl.empty() xor resource.exists()
entryIsPractitionerBundle.entryMatch entries must be Bundles declaring profile-practitioner-tpr
: search.mode='match' implies resource.meta.where(profile='http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-tpr').exists()
includeIsOrganizationBundle.entryInclude entries must be Bundles declaring profile-organization-tpr
: search.mode='include' implies resource.meta.where(profile='http://sharedhealth.exchange/fhir/StructureDefinition/profile-organization-tpr').exists()
outcomeIsOperationOutcomeBundle.entryOutcome entries must be OperationOutcomes
: search.mode='outcome' implies resource.is(OperationOutcome)
© 2017+ . Based on FHIR version (1.4.0-8139). IG generated on Fri, Feb 4, 2022 12:22-0500. | IG Change History