This page provides a list of the FHIR artifacts defined as part of this implementation guide.
• You can download a list of CSVs for the profiles here.
• A zip of formatted Excel files for profiles is here.
Shared Extensions
The set of 'extra' elements that have been defined to supplement the capabilities of the base FHIR resources to meet the implementation guide requirements. These extensions are expected to have applicability across a wide variety of implementation guides.
- Coding Original Text Allows the specification of a free-text description for a coded element that has a type of Coding rather than CodeableConcept. (This is temporary - the real solution is to have the data type changed from Coding to CodeableConcept and then to use CodeableConcept.text.)
- Contact Point is Confidential If true, indicates that the contact point is considered to be confidential and should be disclosed only in limited circumstances
- Entity Service Identifies a electronic communication service offered by a service location or practitioner
- Message Header Application Id Unique identifier for the application responsible for sending a message.
- Message Header Source Conformance Version String identifying the version of the sending software application that was most recently subjected to conformance testing
- Issue reference number Provides the server-assigned reference number associated with an OperationOutcome issue
- User-friendly issue text Provides the user-friendly description associated with an OperationOutcome issue
- Patient PHN version Indicates the version number associated with a provincial health number
- Practitioner Authentication Provides information about a single pracitioner authentication mechanism
- Practitioner Locum Indicator If set to true, indicates that the Practitioner is a locum
- Practitioner SAML Token Allows SAML token within a Practitioner
- Referenced Business Identifier Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL
- On-Behalf-Of Organization Describes an Organization that a referenced practitioner is acting on-behalf-of. Needed because practitioners may be associated with multiple organizations and there's a need to identify the specific one of those being acted on behalf of for this action
- Reference Practitioner Organization Allows capturing the organization who performed an action instead of or in addition to identifying the responsible practitioner
Cross-project extensions
Extensions that are relevant in a specific subset of implementation guides, but which are unlikely to have general relevance. The purpose of these extensions may not be clear without first understanding the referencing implementation guide.
- Communication Enterer The individual responsible for recording the communication in an electronic system.
- Communication Priority Indicates the relative urgent of this communication in comparison with others
- Communication Reply To Indicates the practitioner or organization to which responses should be directed as the primary recipient
- Communication Recipient Locum Indicator If set to true, indicates that the sender with this extension is a locum
- Communication Subject A string describing the 'subject' of the communication. Equivalent to 'subject' in an email.
- Communication Thread Id An identifier kept in common by all communications forming a single discussion thread
- Communication Topic A string describing the 'subject' of the communication
- Communication Topic Group Allows a communication to reference the group (combination of 1 or more orders) being discussed
Data Type Profiles
Constraints and extensions on the FHIR data types used throughout the implementation guide
- Shared Health Address Constraints on the Address data type
- Shared Health Attachment Constraints on the Attachment data type
- Shared Health CodeableConcept Constraints on the CodeableConcept data type that requires coding, text, or both
- Shared Health CodeableConcept Code Constraints on the CodeableConcept data type that requires both code and system
- Shared Health CodeableConcept Code Required and Text Required Constraints on the CodeableConcept data type that requires both coding and text
- Shared Health CodeableConcept Code Required with Text Optional Constraints on the CodeableConcept data type that requires code and allows text
- Shared Health CodeableConcept Text Constraints on the CodeableConcept data type that requires both text and display
- Shared Health CodeableConcept Text Required Constraints on the CodeableConcept data type that requires text
- Shared Health CodeableConcept Text Required with Code Optional Constraints on the CodeableConcept data type that requires text and allows codes
- Shared Health ContactPoint Constraints on the ContactPoint data type
- Shared Health Duration Constraints on the Duration data type
- Shared Health HumanName Common constraints for human names
- Shared Health Identifier Constraints on the Identifier data type
- Shared Health Person Identifier Identifiers used for patients, practitioners, etc.
- Shared Health Quantity Profile for representing quantities
- Shared Health Money Profile for representing Canadian dollar amounts
- Shared Health Reference Constraints on the Reference data type
Abstract Profiles
High-level, shared constraints and extensions on FHIR resources used by the implementation guide. These profiles are not used directly in the specification but serve as a foundation for other profiles that are used within the tasks and interactions.
- Shared Health Bundle Constraints for the Bundle resource
- Shared Health Bundle - Query Response Constraints for a query response bundle
- Shared Health Bundle for Messages Constraints for the message Bundles
- Shared Health Message Header Constraints on the MessageHeader resource
- Shared Health Message Header - Asynchronous message rejection Message Header for the asynchronous rejection of a message (due to parsing or processing error).
Payload Resource Profiles
General constraints and extensions on FHIR resources used by the implementation guide. These profiles are referenced by Tasks and Interactions or by resources that are referenced by Tasks or Interactions
- Shared Health Media Fax Profile on the media resource for transmitting faxes
- Shared Health Operation Outcome Constraints on the OperationOutcome resource
- Shared Health Organization - Base General information about a pharmacy, clinic or other service location common for Provider Registry and eRx systems
- Shared Health Organization - eRx Service Location Information about a pharmacy, clinic or other service location
- Shared Health Organization - Provider Registry Constraints on Organization for provider registry
- Shared Health Patient Base StructureDefinition for Patient Resource
- Shared Health Practitioner Base StructureDefinition for Practitioner Resource
- Shared Health Locum Practitioner Constraints on Practitioner for locum practitioners
- Shared Health Non-Clinician Practitioner Constraints on Practitioner for non-clinician practitioners (e.g. receptionists)
- Shared Health SAML Practitioner Base StructureDefinition for Practitioner Resource with support for SAML token
- Shared Health Practitioner - Provider Registry Constraints on Practitioner for provider registry
Interaction Profiles - Provider Registry Queries
Profiles used to define Provider Registry Query communication interactions for this implementation guide. Two types of profiles are defined. The 'Bundle' profiles define the root set of content allowed to be shared. For messaging interactions, the 'MessageHeader' profiles define the messaging events and the focal ''data'' resources for each message.
- Interaction Bundle - Provider Registry Organization Query The response to a query to retrieve organizations.
- Interaction Bundle - Provider Registry Practitioner Query The response to a query to retrieve practitioners.
Interaction Profiles - Polling Messages
Profiles used to define Polling communication interactions for this implementation guide. Two types of profiles are defined. The 'Bundle' profiles define the root set of content allowed to be shared. For messaging interactions, the 'MessageHeader' profiles define the messaging events and the focal ''data'' resources for each message.
- Interaction Bundle - Clear Message Queue Request The Batch request containing requests to delete one or more message bundles from the message queue.
- Interaction Bundle - Clear Message Queue Response The Batch response containing the results of a request to delete one or more message bundles from the message queue.
- Interaction Bundle - Poll Message Queue Response The response to a query to retrieve the current contents of the message queue.
Interaction Profiles - Notification (Rejection Messages)
Profiles used to define Notification (Rejection Messages) communication interactions for this implementation guide. Two types of profiles are defined. The 'Bundle' profiles define the root set of content allowed to be shared. For messaging interactions, the 'MessageHeader' profiles define the messaging events and the focal ''data'' resources for each message.
- Interaction Message Header 901 - Message Disposition Notification Message Header for the asynchronous rejection of a message (due to parsing or processing error) from the end recipient.
- Interaction Message Header 997 - Asynchronous message undelivered Message Header for the asynchronous indication that a message was not delivered to a specific recipient
- Interaction Message Header 998 - Asynchronous hub message rejection Message Header for the asynchronous rejection of message by hub (due to parsing or processing error) at the receiving system level.
- Interaction Message Header 999 - Asynchronous Message Rejection Message Bundle to reject a message submission asynchronously once the message is delivered to a particular recipient endpoint.
- Interaction Bundle 901 - Message Disposition Notification Message Bundle to asynchronously indicate that a message has not been delivered electronically as expected (but has been delivered by other means).
- Interaction Bundle 997 - Generic Recipient Asynchronous Reject Message Bundle to reject a message submission asynchronously by a target destination system.
- Interaction Bundle 998 - Generic hub Asynchronous Reject Message Bundle for the asynchronous rejection of a message by hub (due to parsing or processing error) at the receiving system level.
- Interaction Bundle 999 - Asynchronous message rejection Message Header for the asynchronous rejection of a message (due to parsing or processing error) from the end recipient.
Conformance Statements
Descriptions of the types of systems that can participate in any of the Shared Health FHIR interfaces and what the expectations of each of those systems are.
- Shared Health Point of Service This role defines the base capabilities of Electronic Medical Record Systems (EMRs), Pharmacy Management Systems (PMSs) and other Point of Service systems that participate in any of the Shared Health FHIR-based services
- PrescribeIT® Switch This role defines the base capabilities of the PrescribeIT® Switch delivery hub that are leveraged by most or all of the Shared Health FHIR services
- Provider Registry This role defines the capabilities of the Provider Registry. The Provider Registry serves as the source of truth for Practitioner information about prescribers as well as Organization information about clinics and pharmacies.
Examples - Provider Registy Queries
Examples of the different Provider Registry Query interactions supported by this specification.
- Organization search response An Organization returned in response to a search request
- Practitioner read response A practitioner returned in response to a read request
- Organization search response An Organization and _included Practitioner returned in response to a search by address
- Practitioner search response A Practitioner and _revincluded Organization returned in response to a search by identifier
Examples - Polling
Examples of the different Polling interactions supported by this specification.
- POLL1 - Empty poll response Poll response for physician tasks
- POLL2 - Multi-message poll response Pharmacy retrieves message (C1)
- POLL3 - Multi-page poll response EMR retrieves outstanding message (E1)
- Request to clear message queue A RESTful batch request that deletes all messages that have been successfully retrieved from the queue
- Response to clear message queue request A RESTful batch response indicating the success of the message deletion requests
Examples - Notification (Rejection)
Examples of the different Notification (Rejection) interactions supported by this specification.
- D2 - 901 Fax delivery May 15 - Notification to physician that electronic delivery was not possible and content has been submitted by fax
- 997 System indicates inability to process message Receiving system indicates that 301 cannot be processed due to parsing error
- 998 Rejection from hub Hub indicates there were attachment issues
- 999 System indicates inability to process message Receiving system indicates that 201 cannot be processed due to parsing error