3.46 StructureDefinition: PrescribeIT Clinician Communication
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-communication-cc
3.46.1 Scope and Usage
A clinical communication is generally about a patient but does not need to be. If the clinical communication is about a patient, then the subject.reference should reference the patient resource within the bundle. Once you have associated the patient with the clinical communication, you have two options to further associate the message.
- You can associated the message with a particular medication order or "placer" prescription by populating extension(topic).valueReference.extension.valueIdentifier with the medicationOrder.identifier(emr-id) of the medication order being referenced
- You can associate the message with a group of medication orders linked together by the task.extension(requisitionIdentifier) that they (the various medication orders) share by placing this value within extension(topicRequisition).
Generally, you should use either (1) or (2) above.
3.46.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 Communication
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Communication | 0..* | Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition. | |
id | 1..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 will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of communication information. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (subject) | 0..1 | Communication Subject | Definition: A string describing the 'subject' of the communication. Equvalent to 'subject' in an email. Comments: Usage Note: This will be the subject line. Though not mandatory, the vendors may choose to auto-fill a subject using the category + patient name or whatever is deemed to be important for the recipient to see. Out of Office may also be considered as part of the subject line. (Note: it is currently an extension, but will be forthcoming in future FHIR releases). |
extension (topic) | 0..1 | Communication Topic | Definition: A resource being discussed as part of this communication Comments: Conformance Rule: This will be the identity of the medication order(s) discussed in the communication. Only the identifier extension needs to be specified (which will contain the prescription's EMR-assigned Rx (PLAC) business identifier), not the actual resource reference. Usage rule: Vendors will use this reference when the communication relates to a particular Medication Order. For example, if sent by an EMR, then this active Rx Identifier (PLAC) will be referenced. Note: there is a separate reference for Requisition identifier that is used if the communication pertains to an entire Prescription. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
valueReference | 1..1 | Reference() | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension | 1..* | Reference.identifier DSTU2 extension | Definition: An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
valueIdentifier | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
extension (topicRequisition) | 0..1 | Communication Topic Requisition | Definition: Allows a communication to reference the requisition (combination of 1 or more orders) being discussed Comments: Conformance Rule: This must be populated when the communication pertains to an entire Prescription (i.e. multiple medication orders). For example, if sent by EMR, then this active Task Requisition ID that groups the various e1xx messages will be referenced. |
extension (enterer) | 0..1 | Communication Enterer | Definition: The individual responsible for recording the communication in an electronic system. Comments: Usage Note: When communication is initiated within a prescriber’s clinic, this is optionally used to identify the Medical Office Assistant who is sending the message on behalf of a licenced professional. This profile contains only a name and a title. Usage Note: For 'communication enterer' The title of the data enterer must be conveyed as text; codes will not be used. Conformance Rule: This is mandatory when the communication sender is the Pharmacy |
extension (priority) | 0..1 | Communication Priority | Definition: Indicates the relative urgent of this communication in comparison with others Comments: Conformance Rule: set value = true when Urgent. The default is normal and flag is not set. Recipients must queue appropriately (urgent first) or display when this flag is set to urgent. |
extension (threadId) | 1..1 | Communication Thread Id | Definition: An identifier kept in common by all communications forming a single discussion thread Comments: Conformance Rule: For a new communication, this must be created by the sender. This value will be used in all related communications. Usage Note: A conversation is made up of an initial communication plus all linked communications (e.g. replies). This thread identifier is used by systems to pull together a complete conversation should they wish to do so. |
extension (replyTo) | 1..1 | Communication Reply To | Definition: Indicates the practitioner or organization to which responses should be directed as the primary recipient Comments: Conformance Rule: This must be populated with a Practitioner that is responsible for the communication. This should be the same identfier as the Sender when the Sender is the registered PrescribeIT™ Practitioner. If the sender is a LOCUM, the replyTO must contain the Provider Registry ID of the registered PrescribeIT™ Practitioner the Locum is acting on behalf of. Conformance Rule: This value must be identical to the sender for communications are initiated by the Pharmacy |
url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to" |
valueReference | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Usage Note: This contains the Provider Registry Organization Identifier associated with the Responsible Practitioner (ReplyTo) of this communication. This should contain the same value as the SOURCE.endpoint and represents the organization that is sending the communication. Conformance Rule: This is mandatory if the 'replyTo' is a Practitioner. It is not permitted if the 'replyTo' is an organization. |
identifier | 1..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: Conformance Rule: This business identifier must be created by the sending application and must be unique for each communiciation. |
category | 1..1 | Shared Health CodeableConcept Code | Binding: CommunicationCategory (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Usage Note: This is populated with the codified value |
sender | 1..1 | Reference(Shared Health Practitioner | Shared Health Locum Practitioner | Shared Health - eRx Service Location) {b} | Slice: Unordered, Open by exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum') Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: This is a choice of sender types. The sender may either be a registered PrescribeIT™ Practitioner or a locum or a Pharmacy. Usage Note: If a Locum is sending a communication and acting on behalf of a Practitioner, the Locum Profile is used. A Locum does not have to be in the Provider Registry as a registered participant of PrescribeIT. The Sender will otherwise be the Practitioner (organization or practitioner) who is registered for the PrescribeIT™ service in the Provider Registry. Conformance Rule: The locum only applies to communications initiated by Prescribers. |
sender (PR) | 0..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: Usage Note: This set of constraints applies to providers (practitioners or organizations) who are in the Provider Registry. (Locums are described further down in a separate set of constraints). |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Conformance Rule: This extension must be present and may only be present when the sender.reference points to a Practitioner. This will be populated with the Provider Registry ID of the location/organization associated with the sending practitioner. Usage Rule: This is NOT used for communications that are initiated by the Pharmacy |
sender (locum) | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: Conformance Rule: This set of constraints applies when the sender is a Locum. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (locum) | 1..1 | Communication Recipient Locum Indicator | Definition: If set to true, indicates that the sender with this extension is a locum |
reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Conformance Rule: This must point to the Locum Practitioner Profile for sender. |
recipient | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Conformance Rule: This is used to specify the organization that the recipient is associated with. This will be the Provider Registry identifier for the organization. Note: This will be the same identifier as specified in the destination list in the 305 message header. This is only specified and must be specified if the recipient is a prescriber |
payload | 1..21 | BackboneElement | Slice: Unordered, Closed by type:content Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. Comments: This is used to convey the message to the recipient. |
payload (string) | 0..1 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. |
contentString | 1..1 | string | Definition: A communicated content (or for multi-part communications, one portion of the communication). Comments: Usage Note: This is the Message Body; restrictedto 1MB; string will allow LF, CR, Horizontal TAB. Usage Note: Tabs should be avoided where possible due to various interpretation which could result in the original formatting being lost. |
payload (attachment) | 0..20 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. |
contentAttachment | 1..1 | Shared Health Attachment | att-1: It the Attachment has data, it SHALL have a contentType Definition: For referring to data content defined in other formats. Comments: Conformance Rule: A maximum of 20 attachments. The combined maximum size for all attachments may not exceed 50 MB. Anything larger will be rejected. |
contentType | 1..1 | code | Binding: AttachmentType (required) Example' General': text/plain; charset=UTF-8, image/png Definition: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Comments: Identifies the mime type the binary content is expressed in |
url | 1..1 | uri | Example' General': http://www.acme.com/logo-small.png Definition: An alternative location where the data can be accessed. Comments: Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment |
size | 1..1 | unsignedInt | Definition: The number of bytes of data that make up this attachment. Comments: Conformance Rule: The combined size of all attachments cannot exceed 50 MB. |
title | 0..1 | string | Example' General': Official Corporate Logo Definition: A label or set of text to display in place of the data. |
status | 1..1 | code | Binding: CommunicationStatus (required) Definition: The status of the transmission. |
sent | 0..1 | dateTime | Definition: The time when this communication was sent. |
reason | 0..* | Shared Health CodeableConcept Code | Binding: (unbound) (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: FUTURE USE ONLY Usage Note: This will be used for 'textual' description of the reason. Example: Request consultation or Patient Seen at Walkin Clinic. |
subject | 0..1 | Reference(Shared Health Patient) {b} | Definition: The patient who was the focus of this communication. Comments: Conformance Rule: If the communication relates to a patient, this will be populated. |
reference | 1..1 | string | Definition: Comments: Conformance Rule: This must point to the patient associated with the message. No external references should be used. |
This structure is derived from Communication
Summary
Mandatory: 10 elements (7 nested mandatory elements)
Must-Support: 37 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-locum
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-attachment
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
Extensions
This structure refers to these extensions:
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
- http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
Slices
This structure defines the following Slices:
- The element Communication.sender is sliced based on the value of exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum')
- The element Communication.payload is sliced based on the value of type:content (Closed)
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | SΣ | 0..* | A record of information transmitted from a sender to a receiver | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-communication-subject | S | 0..1 | string | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject |
ext-communication-topic | S | 0..1 | Reference() | Extension URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
valueReference | S | 1..1 | Reference() | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension-Reference.identifier | S | 1..* | Identifier | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" | |
valueIdentifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Prescriber PrescriptionNumber |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
ext-communication-topic-requisition | S | 0..1 | Shared Health Identifier | Communication Topic Requisition URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition |
ext-communication-enterer | S | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer |
ext-communication-priority | S | 0..1 | code | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority Binding: CommunicationPriority (required) |
ext-communication-thread-id | S | 1..1 | string | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id |
ext-communication-reply-to | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to" |
valueReference | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Shared Health Identifier | An identifier intended for computation |
category | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CommunicationCategory (required) |
sender | SΣ | Reference(Shared Health Practitioner | Shared Health Locum Practitioner | Shared Health - eRx Service Location) {b} | This is the point-of-service organization or practitioner initiating the communication Slice: Unordered, Open by exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum') | |
sender | SΣ | 0..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Message sender |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
sender | SΣ | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Message sender |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-communication-sender-locum | S | 1..1 | boolean | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
recipient | SΣ | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | These are the Practitioners and/or or Organizations receiving the communication |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
payload | SΣ | BackboneElement | Message payload Slice: Unordered, Closed by type:content | |
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 |
content[x] | Σ | 1..1 | string, Attachment, Reference(Resource) | Message part content |
payload | SΣ | 0..1 | BackboneElement | Message payload |
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 |
contentString | SΣ | 1..1 | string | Message part content |
payload | SΣ | 0..20 | BackboneElement | Message payload |
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 |
contentAttachment | SI | 1..1 | Shared Health Attachment | Content in a format defined elsewhere |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: AttachmentType (required) Example General': text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required) Example General': en-AU |
data | 0..1 | base64Binary | Data inline, base64ed | |
url | SΣ | 1..1 | uri | Uri where the data can be found Example General': http://www.acme.com/logo-small.png |
size | SΣ | 1..1 | unsignedInt | Number of bytes of content (if url provided) |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
title | SΣ | 0..1 | string | Label to display in place of the data Example General': Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created |
medium | Σ | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (required) |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | SΣ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | S | 0..* | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: (unbound) (example) |
subject | SΣ | 0..1 | Reference(Shared Health Patient) {b} | Focus of message |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
requestDetail | Σ | 0..1 | Reference(CommunicationRequest) | CommunicationRequest producing this message |
Documentation for this format |
Grid View
This structure is derived from Communication
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Communication | 0..* | Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition. | |
id | 1..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 will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of communication information. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (subject) | 0..1 | Communication Subject | Definition: A string describing the 'subject' of the communication. Equvalent to 'subject' in an email. Comments: Usage Note: This will be the subject line. Though not mandatory, the vendors may choose to auto-fill a subject using the category + patient name or whatever is deemed to be important for the recipient to see. Out of Office may also be considered as part of the subject line. (Note: it is currently an extension, but will be forthcoming in future FHIR releases). |
extension (topic) | 0..1 | Communication Topic | Definition: A resource being discussed as part of this communication Comments: Conformance Rule: This will be the identity of the medication order(s) discussed in the communication. Only the identifier extension needs to be specified (which will contain the prescription's EMR-assigned Rx (PLAC) business identifier), not the actual resource reference. Usage rule: Vendors will use this reference when the communication relates to a particular Medication Order. For example, if sent by an EMR, then this active Rx Identifier (PLAC) will be referenced. Note: there is a separate reference for Requisition identifier that is used if the communication pertains to an entire Prescription. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
valueReference | 1..1 | Reference() | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension | 1..* | Reference.identifier DSTU2 extension | Definition: An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
valueIdentifier | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
extension (topicRequisition) | 0..1 | Communication Topic Requisition | Definition: Allows a communication to reference the requisition (combination of 1 or more orders) being discussed Comments: Conformance Rule: This must be populated when the communication pertains to an entire Prescription (i.e. multiple medication orders). For example, if sent by EMR, then this active Task Requisition ID that groups the various e1xx messages will be referenced. |
extension (enterer) | 0..1 | Communication Enterer | Definition: The individual responsible for recording the communication in an electronic system. Comments: Usage Note: When communication is initiated within a prescriber’s clinic, this is optionally used to identify the Medical Office Assistant who is sending the message on behalf of a licenced professional. This profile contains only a name and a title. Usage Note: For 'communication enterer' The title of the data enterer must be conveyed as text; codes will not be used. Conformance Rule: This is mandatory when the communication sender is the Pharmacy |
extension (priority) | 0..1 | Communication Priority | Definition: Indicates the relative urgent of this communication in comparison with others Comments: Conformance Rule: set value = true when Urgent. The default is normal and flag is not set. Recipients must queue appropriately (urgent first) or display when this flag is set to urgent. |
extension (threadId) | 1..1 | Communication Thread Id | Definition: An identifier kept in common by all communications forming a single discussion thread Comments: Conformance Rule: For a new communication, this must be created by the sender. This value will be used in all related communications. Usage Note: A conversation is made up of an initial communication plus all linked communications (e.g. replies). This thread identifier is used by systems to pull together a complete conversation should they wish to do so. |
extension (replyTo) | 1..1 | Communication Reply To | Definition: Indicates the practitioner or organization to which responses should be directed as the primary recipient Comments: Conformance Rule: This must be populated with a Practitioner that is responsible for the communication. This should be the same identfier as the Sender when the Sender is the registered PrescribeIT™ Practitioner. If the sender is a LOCUM, the replyTO must contain the Provider Registry ID of the registered PrescribeIT™ Practitioner the Locum is acting on behalf of. Conformance Rule: This value must be identical to the sender for communications are initiated by the Pharmacy |
url | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to" |
valueReference | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Usage Note: This contains the Provider Registry Organization Identifier associated with the Responsible Practitioner (ReplyTo) of this communication. This should contain the same value as the SOURCE.endpoint and represents the organization that is sending the communication. Conformance Rule: This is mandatory if the 'replyTo' is a Practitioner. It is not permitted if the 'replyTo' is an organization. |
identifier | 1..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: Conformance Rule: This business identifier must be created by the sending application and must be unique for each communiciation. |
category | 1..1 | Shared Health CodeableConcept Code | Binding: CommunicationCategory (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Usage Note: This is populated with the codified value |
sender | 1..1 | Reference(Shared Health Practitioner | Shared Health Locum Practitioner | Shared Health - eRx Service Location) {b} | Slice: Unordered, Open by exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum') Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: This is a choice of sender types. The sender may either be a registered PrescribeIT™ Practitioner or a locum or a Pharmacy. Usage Note: If a Locum is sending a communication and acting on behalf of a Practitioner, the Locum Profile is used. A Locum does not have to be in the Provider Registry as a registered participant of PrescribeIT. The Sender will otherwise be the Practitioner (organization or practitioner) who is registered for the PrescribeIT™ service in the Provider Registry. Conformance Rule: The locum only applies to communications initiated by Prescribers. |
sender (PR) | 0..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: Usage Note: This set of constraints applies to providers (practitioners or organizations) who are in the Provider Registry. (Locums are described further down in a separate set of constraints). |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Conformance Rule: This extension must be present and may only be present when the sender.reference points to a Practitioner. This will be populated with the Provider Registry ID of the location/organization associated with the sending practitioner. Usage Rule: This is NOT used for communications that are initiated by the Pharmacy |
sender (locum) | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. Comments: Conformance Rule: This set of constraints applies when the sender is a Locum. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (locum) | 1..1 | Communication Recipient Locum Indicator | Definition: If set to true, indicates that the sender with this extension is a locum |
reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Conformance Rule: This must point to the Locum Practitioner Profile for sender. |
recipient | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). |
extension (onBehalfOf) | 0..1 | On-Behalf-Of Organization | Definition: Describes an Organization that a referenced practitioner is acting on-behalf-of Comments: Conformance Rule: This is used to specify the organization that the recipient is associated with. This will be the Provider Registry identifier for the organization. Note: This will be the same identifier as specified in the destination list in the 305 message header. This is only specified and must be specified if the recipient is a prescriber |
payload | 1..21 | BackboneElement | Slice: Unordered, Closed by type:content Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. Comments: This is used to convey the message to the recipient. |
payload (string) | 0..1 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. |
contentString | 1..1 | string | Definition: A communicated content (or for multi-part communications, one portion of the communication). Comments: Usage Note: This is the Message Body; restrictedto 1MB; string will allow LF, CR, Horizontal TAB. Usage Note: Tabs should be avoided where possible due to various interpretation which could result in the original formatting being lost. |
payload (attachment) | 0..20 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. |
contentAttachment | 1..1 | Shared Health Attachment | att-1: It the Attachment has data, it SHALL have a contentType Definition: For referring to data content defined in other formats. Comments: Conformance Rule: A maximum of 20 attachments. The combined maximum size for all attachments may not exceed 50 MB. Anything larger will be rejected. |
contentType | 1..1 | code | Binding: AttachmentType (required) Example' General': text/plain; charset=UTF-8, image/png Definition: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. Comments: Identifies the mime type the binary content is expressed in |
url | 1..1 | uri | Example' General': http://www.acme.com/logo-small.png Definition: An alternative location where the data can be accessed. Comments: Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment |
size | 1..1 | unsignedInt | Definition: The number of bytes of data that make up this attachment. Comments: Conformance Rule: The combined size of all attachments cannot exceed 50 MB. |
title | 0..1 | string | Example' General': Official Corporate Logo Definition: A label or set of text to display in place of the data. |
status | 1..1 | code | Binding: CommunicationStatus (required) Definition: The status of the transmission. |
sent | 0..1 | dateTime | Definition: The time when this communication was sent. |
reason | 0..* | Shared Health CodeableConcept Code | Binding: (unbound) (example) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: FUTURE USE ONLY Usage Note: This will be used for 'textual' description of the reason. Example: Request consultation or Patient Seen at Walkin Clinic. |
subject | 0..1 | Reference(Shared Health Patient) {b} | Definition: The patient who was the focus of this communication. Comments: Conformance Rule: If the communication relates to a patient, this will be populated. |
reference | 1..1 | string | Definition: Comments: Conformance Rule: This must point to the patient associated with the message. No external references should be used. |
This structure is derived from Communication
Summary
Mandatory: 10 elements (7 nested mandatory elements)
Must-Support: 37 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-locum
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-attachment
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
Extensions
This structure refers to these extensions:
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
- http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
Slices
This structure defines the following Slices:
- The element Communication.sender is sliced based on the value of exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum')
- The element Communication.payload is sliced based on the value of type:content (Closed)
Differential View
This structure is derived from Communication
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | SΣ | 0..* | A record of information transmitted from a sender to a receiver | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-communication-subject | S | 0..1 | string | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject |
ext-communication-topic | S | 0..1 | Reference() | Extension URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
valueReference | S | 1..1 | Reference() | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension-Reference.identifier | S | 1..* | Identifier | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" | |
valueIdentifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Prescriber PrescriptionNumber |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
ext-communication-topic-requisition | S | 0..1 | Shared Health Identifier | Communication Topic Requisition URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition |
ext-communication-enterer | S | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer |
ext-communication-priority | S | 0..1 | code | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority Binding: CommunicationPriority (required) |
ext-communication-thread-id | S | 1..1 | string | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id |
ext-communication-reply-to | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to" |
valueReference | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Value of extension |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..* | Shared Health Identifier | An identifier intended for computation |
category | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: CommunicationCategory (required) |
sender | SΣ | Reference(Shared Health Practitioner | Shared Health Locum Practitioner | Shared Health - eRx Service Location) {b} | This is the point-of-service organization or practitioner initiating the communication Slice: Unordered, Open by exists:extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum') | |
sender | SΣ | 0..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Message sender |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
sender | SΣ | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Message sender |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-communication-sender-locum | S | 1..1 | boolean | Extension URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
recipient | SΣ | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | These are the Practitioners and/or or Organizations receiving the communication |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ext-reference-on-behalf-of | S | 0..1 | Reference(Shared Health - eRx Service Location) {b} | Referenced organization URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
payload | SΣ | BackboneElement | Message payload Slice: Unordered, Closed by type:content | |
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 |
content[x] | Σ | 1..1 | string, Attachment, Reference(Resource) | Message part content |
payload | SΣ | 0..1 | BackboneElement | Message payload |
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 |
contentString | SΣ | 1..1 | string | Message part content |
payload | SΣ | 0..20 | BackboneElement | Message payload |
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 |
contentAttachment | SI | 1..1 | Shared Health Attachment | Content in a format defined elsewhere |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: AttachmentType (required) Example General': text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: http://tools.ietf.org/html/bcp47 (required) Example General': en-AU |
data | 0..1 | base64Binary | Data inline, base64ed | |
url | SΣ | 1..1 | uri | Uri where the data can be found Example General': http://www.acme.com/logo-small.png |
size | SΣ | 1..1 | unsignedInt | Number of bytes of content (if url provided) |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
title | SΣ | 0..1 | string | Label to display in place of the data Example General': Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created |
medium | Σ | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (required) |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | SΣ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | S | 0..* | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: (unbound) (example) |
subject | SΣ | 0..1 | Reference(Shared Health Patient) {b} | Focus of message |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
requestDetail | Σ | 0..1 | Reference(CommunicationRequest) | CommunicationRequest producing this message |
Documentation for this format |
Other representations of profile: Schematron
3.46.3 Terminology Bindings
Terminology Bindings
Path | Name | Conformance | ValueSet |
Communication.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Communication.category | CommunicationCategory | required | CommunicationCategory |
Communication.payload.contentAttachment.contentType | AttachmentType | required | AttachmentType |
Communication.payload.contentAttachment.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Communication.medium | v3 Code System ParticipationMode | example | v3 Code System ParticipationMode |
Communication.status | CommunicationStatus | required | CommunicationStatus |
Communication.reason | ?ext | example |
3.46.4 Constraints
Constraints
Id | Path | Details | Requirements |
att-1 | Communication.payload.contentAttachment | It the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() |