PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/profile-communication-cc

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.

  1. 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
  2. You can associate the message with a group of medication orders linked together by the task.extension(groupIdentifier) that they (the various medication orders) share by placing this value within extension(topicGroup).

Generally, you should use either (1) or (2) above.

The following is a table of the most common scenarios with all of the On-Behalf-Of (OBO) elements (MessageHeader.source.endpoint; Communication.extension:replyTo, Communication.sender:PR, and Communication.recipient).

Scenario MessageHeader.source.endpoint Communication.extension:enterer Communication.extension:replyTo Communication.sender:PR/Locum Communication.recipient

Notes about the individual fields

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

Definition: This provides information to the recipient on who they should be replying to.

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.

---------------------

OBO 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 MessageHeader.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.

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 PrescribeIT® service in the Provider Registry.

---------------------

OBO Comments:
Conformance Rule: This extension must be present when the Communication.sender(PR).reference points to a Practitioner.

Usage Rule: This is NOT used for communications that are initiated by the Pharmacy

Conformance Rule: The recipient should be either an organization (in the case of the pharmacy being the recipient) or a person (in the case of a prescriber being the recipient). If the recipient is an organization, the CPRID of the organization should be provided in the form of a URL. If the recipient is a prescriber, the prescriber's CPRID should be provided in the form of a URL. If the recipient is a prescriber, then the On-Behalf-Of should be provided in order to identify the location where the prescriber should receive the communication in question. The On-Behalf-Of should not be included if the recipient is an organization as this would be redundant.

--------------------

OBO 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 Practitioner

1. Registered Prescriber to Pharmacy Organization/CPRClinic N/A

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

OBO - N/A

Reference - Organization/CPRPharmacy

2. Pharmacy User to Registered Prescriber Organization/CPRPharmacy

Practitioner/PMSUser

This is the hands-on-keyboard user details. Refer to Non-Clinician Practitioner profile for details.

OBO - N/A

Reference - Organization/CPRPharmacy

OBO - N/A

Reference - Organization/CPRPharmacy

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

3. MOA sending for a Registered Prescriber) to Pharmacy Organization/CPRClinic

Practitioner/MOA User

This is the hands-on-keyboard user details. Refer to Non-Clinician Practitioner profile for details.

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

OBO - N/A

Reference - Organization/CPRPharmacy

4. Locum sending for a Registered Prescriber) to Pharmacy Organization/CPRClinic N/A

OBO - Organization/CPRClinic

Reference Practitioner/CPRPrescriber

OBO - N/A

set ext-communication-sender-locum="true"

Reference - Practitioner/urn:uuid:LocumGUID

OBO - N/A

Reference - Organization/CPRPharmacy

5. Pharmacy responding to Registered Prescriber for message initiated by MOA or Locum Organization/CPRPharmacy

Practitioner/PMSUser

This is the hands-on-keyboard user details. Refer to Non-Clinician Practitioner profile for details.

OBO - N/A

Reference - Organization/CPRPharmacy

OBO - N/A

Reference - Organization/CPRPharmacy

OBO - Organization/CPRClinic

Reference - Practitioner/CPRPrescriber

NOTE: When another registered practitioner is responding to a message sent to a different prescriber (i.e. vacation coverage) see scenario 1 or scenario 4 depending on how the EMR has implemented how they allow the prescriber to indicate the parties involved.

Download Excel representation

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

>

This structure is derived from Communication

NameCard.TypeConstraints and Usage
.  Communication 0..*Communication305-1: topic and topicGroup MUST not be populated together.
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..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 will usually be a GUID and is assigned by the sending application.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (subject)
0..1Communication SubjectDefinition:
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..1Communication TopicDefinition:
Allows a communication to reference the individual Medication Order


Comments:
Usage Note: This is used to identify the medication order that the communication is related too. Only the Prescription business identifier is included, the entire medication order resource will not be included. This is used to associate and link communications to the proper medication order to facilitate having a complete view of communication in context of the medication order that it is referring too.



Conformance Rule:



(1) When creating a communication that is linked to a medication order, the medication order identifier must be in the same format and have the same value as it was sent or received in the original task's MedicationOrder.identifier(EMR-id).



(2) When receiving a communication and this element is populated, the system must use this value to find the corresponding medication order record in the receiving system to associate and link that incoming communication with in order to facilitate having that complete view of the context involved.



(3) When replying to a communication and this element is populated, the system must resend the data as it was received.



(4) Communication.extension(topic) and Communication.extension(topicGroup) must never be populated together, only one or the other extension can be populated depending on what needs to be referenced.

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Communication.topic"
...  value[x] 1..1Reference()Slice: Unordered, Closed by type:$this
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).

...  value[x]
       (valueReference)
1..1Reference() {r}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..1Reference.identifier DSTU2 extensionDefinition:
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 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
.....  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierSlice: Unordered, Closed by type:$this
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  extension
     (topicGroup)
0..1Communication Topic GroupDefinition:
Allows a communication to reference the group of Medication Orders found in the bundle


Comments:
Usage Note: This is used to identify the bundle that the communication is related too (e.g. Communications pertains to an entire Prescription i.e. multiple medication orders). Only the Group business identifier is included, the entire message bundle is not included. This is used to associate and link communications to the proper bundle in order to facilitate having a complete view of communication in context of the entire bundle that it is referring to.



Conformance Rule:



(1) When creating a communication that is linked to an entire message bundle (e.g. prescription), the group identifier must be in the same format and have the same value as it was sent or received in the original bundle's Task.extension(groupIdentifier).



(2) When receiving a communication and this element is populated, the system must use this value to find the corresponding bundle or all the tasks related to that bundle (e.g. multiple medication orders) in the receiving system to associate and link that incoming communication with in order to facilitate having that complete view of the context involved.



(3) When replying to a communication and this element is populated, the system must resend the data as it was received.



(4) Communication.extension(topic) and Communication.extension(topicGroup) must never be populated together, only one or the other extension can be populated depending on what needs to be referenced.

..  extension
     (enterer)
0..1Communication EntererDefinition:
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..1Communication PriorityDefinition:
Indicates the relative urgent of this communication in comparison with others


Comments:
Conformance Rule: set value = 'high' 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..1Communication Thread IdDefinition:
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..1Communication Reply ToDefinition:
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..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to"
...  value[x] 1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Definition:
A reference from one resource to another.

....  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

....  extension
         (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
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 MessageHeader.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.

....  reference 1..1stringDefinition:
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:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  identifier 1..*Shared Health IdentifierDefinition:
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..1Shared Health CodeableConcept CodeBinding: CommunicationCategory (20211125) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


..  sender 1..1Reference(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 PrescribeIT® service in the Provider Registry.



Conformance Rule: The locum only applies to communications initiated by Prescribers.

..  sender
     (PR)
0..1Reference(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:
Conformance Rule: This set of constraints applies when the sender is either a Practitioner or Organization

...  extension
       (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
Describes an Organization that a referenced practitioner is acting on-behalf-of


Comments:
Conformance Rule: This extension must be present when the Communication.sender(PR).reference points to a Practitioner.



Usage Rule: This is NOT used for communications that are initiated by the Pharmacy

...  reference 1..1stringDefinition:
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 either the Practitioner or Organization Provider Registry ID.

..  sender
     (locum)
0..1Reference(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
       (locum)
1..1Communication Recipient Locum IndicatorDefinition:
If set to true, indicates that the sender with this extension is a locum

...  reference 1..1stringDefinition:
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.

..  recipient 1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Definition:
The entity (e.g. practitioner, organization) which is the target of the communication. There can only be one recipient of a communication either a practitioner/clinic combination (NOTE: clinic is sent as the onBehalfOf organization) if a pharmacy is sending or a pharmacy if a practitioner is sending.

...  extension
       (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
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 Practitioner

...  reference 1..1stringDefinition:
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: The recipient should be either an organization (in the case of the pharmacy being the recipient) or a person (in the case of a prescriber being the recipient). If the recipient is an organization, the CPRID of the organization should be provided in the form of a URL. If the recipient is a prescriber, the prescriber’s CPRID should be provided in the form of a URL. If the recipient is a prescriber, then the “On-Behalf-Of” should be provided in order to identify the location where the prescriber should receive the communication in question. The “On-Behalf-Of” should not be included if the recipient is an organization as this would be redundant.

..  payload 1..21BackboneElementSlice: 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..1BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.

...  content[x] 1..1stringDefinition:
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..20BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.

...  content[x] 1..1Shared Health Attachmentatt-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..1codeBinding: AttachmentType (20170626) (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.



Conformance Rule: The charset will be UTF-8 only.

....  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Definition:
Location where the attachment is uploaded too or downloaded from, using the unique identifier of the attachment.


Comments:
Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid or uuid or unique identifier]. The attachment content SHALL be PUT to the same URL immediately after posting the 305 message containing this attachment. It cannot be PUT prior to the 305 message otherwise an error will be returned.

....  size 1..1unsignedIntDefinition:
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..1stringExample' General': Official Corporate Logo
Definition:
A label or set of text to display in place of the data.

..  status 1..1codeBinding: CommunicationStatus (20190415) (required)
Definition:
The status of the transmission.


Comments:
Usage Note: The sending system should set this to 'in-progress'. There are no expectations on the receiving system to consider this value.

..  sent 0..1dateTimeDefinition:
The time when this communication was sent.

..  reason 0..*Shared Health CodeableConcept CodeBinding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


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..1Reference(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..1stringDefinition:



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: 11 elements (9 nested mandatory elements)
Must-Support: 39 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SI0..*CommunicationA record of information transmitted from a sender to a receiver
305-1: topic and topicGroup MUST not be populated together.
... id S1..1idLogical id of this artifact
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-communication-subject S0..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
... ext-communication-topic SI0..1Reference()Extension
URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
.... value[x]:valueReference S1..1Reference() {r}Value of extension
..... extension-Reference.identifier S1..1IdentifierAn 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
...... url S1..1uriidentifies the meaning of the extension
...... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPrescriber PrescriptionNumber
... ext-communication-topic-requisition SI0..1Shared Health IdentifierCommunication Topic Group
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
... ext-communication-enterer S0..1Reference(Shared Health Non-Clinician Practitioner) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
... ext-communication-priority S0..1codeExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
Binding: CommunicationPriority (20190415) (required)
... ext-communication-thread-id S1..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
... ext-communication-reply-to S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
.... value[x] S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}A reference from one resource to another
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
... identifier S1..*Shared Health IdentifierAn identifier intended for computation
... category S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CommunicationCategory (20211125) (required)
... sender S1..1(Slice Definition)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:PR S0..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message sender
..... ext-communication-sender-locum 0..0boolean
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference S1..1stringRelative, internal or absolute URL reference
.... sender:locum S0..1Reference(Shared Health Locum Practitioner) {b}Message sender
..... ext-communication-sender-locum S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
..... reference S1..1stringRelative, internal or absolute URL reference
... recipient S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message recipient
.... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
.... reference S1..1stringRelative, internal or absolute URL reference
... payload S1..21(Slice Definition)Message payload
Slice: Unordered, Closed by type:content
.... payload:string S0..1BackboneElementMessage payload
..... content[x] S1..1stringMessage part content
.... payload:attachment S0..20BackboneElementMessage payload
..... content[x] S1..1Shared Health AttachmentContent in a format defined elsewhere
...... contentType S1..1codeMime type of the content, with charset etc.
Binding: AttachmentType (20170626) (required)
... status S1..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (20190415) (required)
... sent S0..1dateTimeWhen sent
... reason S0..*Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
... subject S0..1Reference(Shared Health Patient) {b}Focus of message
.... reference S1..1stringRelative, internal or absolute URL reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SΣI0..*CommunicationA record of information transmitted from a sender to a receiver
305-1: topic and topicGroup MUST not be populated together.
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-communication-subject S0..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
... ext-communication-topic SI0..1Reference()Extension
URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Communication.topic"
.... value[x] S1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S1..1Reference() {r}Value of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension-Reference.identifier S1..1IdentifierAn 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..1idxml:id (or equivalent in JSON)
....... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
....... value[x] S1..1(Slice Definition)Prescriber PrescriptionNumber
Slice: Unordered, Closed by type:$this
........ value[x]:valueIdentifier 1..1IdentifierValue of extension
...... reference ΣI0..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
... ext-communication-topic-requisition SI0..1Shared Health IdentifierCommunication Topic Group
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
... ext-communication-enterer S0..1Reference(Shared Health Non-Clinician Practitioner) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
... ext-communication-priority S0..1codeExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
Binding: CommunicationPriority (20190415) (required)
... ext-communication-thread-id S1..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
... ext-communication-reply-to S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to"
.... value[x] S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}A reference from one resource to another
..... id 0..1idxml:id (or equivalent in JSON)
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Shared Health IdentifierAn identifier intended for computation
... category S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CommunicationCategory (20211125) (required)
... sender SΣ1..1(Slice Definition)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:PR SΣ0..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message sender
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
.... sender:locum SΣ0..1Reference(Shared Health Locum Practitioner) {b}Message sender
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-communication-sender-locum S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
... recipient SΣ1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... payload SΣ1..21(Slice Definition)Message payload
Slice: Unordered, Closed by type:content
.... payload: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
..... content[x] Σ1..1Message part content
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:string SΣ0..1BackboneElementMessage payload
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... content[x] SΣ1..1stringMessage part content
.... payload:attachment SΣ0..20BackboneElementMessage payload
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... content[x] SI1..1Shared Health AttachmentContent in a format defined elsewhere
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: AttachmentType (20170626) (required)
Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
...... data 0..1base64BinaryData inline, base64ed
...... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size SΣ1..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... medium Σ0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... status ?!SΣ1..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (20190415) (required)
... encounter Σ0..1Reference(Encounter)Encounter leading to message
... sent SΣ0..1dateTimeWhen sent
... received Σ0..1dateTimeWhen received
... reason S0..*Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


... subject SΣ0..1Reference(Shared Health Patient) {b}Focus of message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... requestDetail Σ0..1Reference(CommunicationRequest)CommunicationRequest producing this message

doco Documentation for this format

Grid View

This structure is derived from Communication

NameCard.TypeConstraints and Usage
.  Communication 0..*Communication305-1: topic and topicGroup MUST not be populated together.
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..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 will usually be a GUID and is assigned by the sending application.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (subject)
0..1Communication SubjectDefinition:
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..1Communication TopicDefinition:
Allows a communication to reference the individual Medication Order


Comments:
Usage Note: This is used to identify the medication order that the communication is related too. Only the Prescription business identifier is included, the entire medication order resource will not be included. This is used to associate and link communications to the proper medication order to facilitate having a complete view of communication in context of the medication order that it is referring too.



Conformance Rule:



(1) When creating a communication that is linked to a medication order, the medication order identifier must be in the same format and have the same value as it was sent or received in the original task's MedicationOrder.identifier(EMR-id).



(2) When receiving a communication and this element is populated, the system must use this value to find the corresponding medication order record in the receiving system to associate and link that incoming communication with in order to facilitate having that complete view of the context involved.



(3) When replying to a communication and this element is populated, the system must resend the data as it was received.



(4) Communication.extension(topic) and Communication.extension(topicGroup) must never be populated together, only one or the other extension can be populated depending on what needs to be referenced.

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Communication.topic"
...  value[x] 1..1Reference()Slice: Unordered, Closed by type:$this
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).

...  value[x]
       (valueReference)
1..1Reference() {r}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..1Reference.identifier DSTU2 extensionDefinition:
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 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
.....  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierSlice: Unordered, Closed by type:$this
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  extension
     (topicGroup)
0..1Communication Topic GroupDefinition:
Allows a communication to reference the group of Medication Orders found in the bundle


Comments:
Usage Note: This is used to identify the bundle that the communication is related too (e.g. Communications pertains to an entire Prescription i.e. multiple medication orders). Only the Group business identifier is included, the entire message bundle is not included. This is used to associate and link communications to the proper bundle in order to facilitate having a complete view of communication in context of the entire bundle that it is referring to.



Conformance Rule:



(1) When creating a communication that is linked to an entire message bundle (e.g. prescription), the group identifier must be in the same format and have the same value as it was sent or received in the original bundle's Task.extension(groupIdentifier).



(2) When receiving a communication and this element is populated, the system must use this value to find the corresponding bundle or all the tasks related to that bundle (e.g. multiple medication orders) in the receiving system to associate and link that incoming communication with in order to facilitate having that complete view of the context involved.



(3) When replying to a communication and this element is populated, the system must resend the data as it was received.



(4) Communication.extension(topic) and Communication.extension(topicGroup) must never be populated together, only one or the other extension can be populated depending on what needs to be referenced.

..  extension
     (enterer)
0..1Communication EntererDefinition:
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..1Communication PriorityDefinition:
Indicates the relative urgent of this communication in comparison with others


Comments:
Conformance Rule: set value = 'high' 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..1Communication Thread IdDefinition:
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..1Communication Reply ToDefinition:
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..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to"
...  value[x] 1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Definition:
A reference from one resource to another.

....  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

....  extension
         (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
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 MessageHeader.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.

....  reference 1..1stringDefinition:
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:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  identifier 1..*Shared Health IdentifierDefinition:
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..1Shared Health CodeableConcept CodeBinding: CommunicationCategory (20211125) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


..  sender 1..1Reference(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 PrescribeIT® service in the Provider Registry.



Conformance Rule: The locum only applies to communications initiated by Prescribers.

..  sender
     (PR)
0..1Reference(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:
Conformance Rule: This set of constraints applies when the sender is either a Practitioner or Organization

...  extension
       (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
Describes an Organization that a referenced practitioner is acting on-behalf-of


Comments:
Conformance Rule: This extension must be present when the Communication.sender(PR).reference points to a Practitioner.



Usage Rule: This is NOT used for communications that are initiated by the Pharmacy

...  reference 1..1stringDefinition:
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 either the Practitioner or Organization Provider Registry ID.

..  sender
     (locum)
0..1Reference(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
       (locum)
1..1Communication Recipient Locum IndicatorDefinition:
If set to true, indicates that the sender with this extension is a locum

...  reference 1..1stringDefinition:
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.

..  recipient 1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Definition:
The entity (e.g. practitioner, organization) which is the target of the communication. There can only be one recipient of a communication either a practitioner/clinic combination (NOTE: clinic is sent as the onBehalfOf organization) if a pharmacy is sending or a pharmacy if a practitioner is sending.

...  extension
       (onBehalfOf)
0..1On-Behalf-Of OrganizationDefinition:
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 Practitioner

...  reference 1..1stringDefinition:
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: The recipient should be either an organization (in the case of the pharmacy being the recipient) or a person (in the case of a prescriber being the recipient). If the recipient is an organization, the CPRID of the organization should be provided in the form of a URL. If the recipient is a prescriber, the prescriber’s CPRID should be provided in the form of a URL. If the recipient is a prescriber, then the “On-Behalf-Of” should be provided in order to identify the location where the prescriber should receive the communication in question. The “On-Behalf-Of” should not be included if the recipient is an organization as this would be redundant.

..  payload 1..21BackboneElementSlice: 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..1BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.

...  content[x] 1..1stringDefinition:
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..20BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.

...  content[x] 1..1Shared Health Attachmentatt-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..1codeBinding: AttachmentType (20170626) (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.



Conformance Rule: The charset will be UTF-8 only.

....  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Definition:
Location where the attachment is uploaded too or downloaded from, using the unique identifier of the attachment.


Comments:
Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid or uuid or unique identifier]. The attachment content SHALL be PUT to the same URL immediately after posting the 305 message containing this attachment. It cannot be PUT prior to the 305 message otherwise an error will be returned.

....  size 1..1unsignedIntDefinition:
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..1stringExample' General': Official Corporate Logo
Definition:
A label or set of text to display in place of the data.

..  status 1..1codeBinding: CommunicationStatus (20190415) (required)
Definition:
The status of the transmission.


Comments:
Usage Note: The sending system should set this to 'in-progress'. There are no expectations on the receiving system to consider this value.

..  sent 0..1dateTimeDefinition:
The time when this communication was sent.

..  reason 0..*Shared Health CodeableConcept CodeBinding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


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..1Reference(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..1stringDefinition:



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: 11 elements (9 nested mandatory elements)
Must-Support: 39 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SI0..*CommunicationA record of information transmitted from a sender to a receiver
305-1: topic and topicGroup MUST not be populated together.
... id S1..1idLogical id of this artifact
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-communication-subject S0..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
... ext-communication-topic SI0..1Reference()Extension
URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
.... value[x]:valueReference S1..1Reference() {r}Value of extension
..... extension-Reference.identifier S1..1IdentifierAn 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
...... url S1..1uriidentifies the meaning of the extension
...... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPrescriber PrescriptionNumber
... ext-communication-topic-requisition SI0..1Shared Health IdentifierCommunication Topic Group
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
... ext-communication-enterer S0..1Reference(Shared Health Non-Clinician Practitioner) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
... ext-communication-priority S0..1codeExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
Binding: CommunicationPriority (20190415) (required)
... ext-communication-thread-id S1..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
... ext-communication-reply-to S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
.... value[x] S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}A reference from one resource to another
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
... identifier S1..*Shared Health IdentifierAn identifier intended for computation
... category S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CommunicationCategory (20211125) (required)
... sender S1..1(Slice Definition)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:PR S0..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message sender
..... ext-communication-sender-locum 0..0boolean
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference S1..1stringRelative, internal or absolute URL reference
.... sender:locum S0..1Reference(Shared Health Locum Practitioner) {b}Message sender
..... ext-communication-sender-locum S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
..... reference S1..1stringRelative, internal or absolute URL reference
... recipient S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message recipient
.... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
.... reference S1..1stringRelative, internal or absolute URL reference
... payload S1..21(Slice Definition)Message payload
Slice: Unordered, Closed by type:content
.... payload:string S0..1BackboneElementMessage payload
..... content[x] S1..1stringMessage part content
.... payload:attachment S0..20BackboneElementMessage payload
..... content[x] S1..1Shared Health AttachmentContent in a format defined elsewhere
...... contentType S1..1codeMime type of the content, with charset etc.
Binding: AttachmentType (20170626) (required)
... status S1..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (20190415) (required)
... sent S0..1dateTimeWhen sent
... reason S0..*Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
... subject S0..1Reference(Shared Health Patient) {b}Focus of message
.... reference S1..1stringRelative, internal or absolute URL reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication SΣI0..*CommunicationA record of information transmitted from a sender to a receiver
305-1: topic and topicGroup MUST not be populated together.
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... 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.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-communication-subject S0..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-subject
... ext-communication-topic SI0..1Reference()Extension
URL: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Communication.topic"
.... value[x] S1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S1..1Reference() {r}Value of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension-Reference.identifier S1..1IdentifierAn 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..1idxml:id (or equivalent in JSON)
....... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
....... value[x] S1..1(Slice Definition)Prescriber PrescriptionNumber
Slice: Unordered, Closed by type:$this
........ value[x]:valueIdentifier 1..1IdentifierValue of extension
...... reference ΣI0..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
... ext-communication-topic-requisition SI0..1Shared Health IdentifierCommunication Topic Group
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition
... ext-communication-enterer S0..1Reference(Shared Health Non-Clinician Practitioner) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-enterer
... ext-communication-priority S0..1codeExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-priority
Binding: CommunicationPriority (20190415) (required)
... ext-communication-thread-id S1..1stringExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-thread-id
... ext-communication-reply-to S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Extension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to"
.... value[x] S1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}A reference from one resource to another
..... id 0..1idxml:id (or equivalent in JSON)
..... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*Shared Health IdentifierAn identifier intended for computation
... category S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: CommunicationCategory (20211125) (required)
... sender SΣ1..1(Slice Definition)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:PR SΣ0..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message sender
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
.... sender:locum SΣ0..1Reference(Shared Health Locum Practitioner) {b}Message sender
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ext-communication-sender-locum S1..1booleanExtension
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-sender-locum
..... reference SΣI1..1stringRelative, internal or absolute URL reference
..... display Σ0..1stringText alternative for the resource
... recipient SΣ1..1Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b}Message recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-on-behalf-of S0..1Reference(Shared Health - eRx Service Location) {b}Referenced organization
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-on-behalf-of
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... payload SΣ1..21(Slice Definition)Message payload
Slice: Unordered, Closed by type:content
.... payload: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
..... content[x] Σ1..1Message part content
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:string SΣ0..1BackboneElementMessage payload
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... content[x] SΣ1..1stringMessage part content
.... payload:attachment SΣ0..20BackboneElementMessage payload
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... content[x] SI1..1Shared Health AttachmentContent in a format defined elsewhere
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: AttachmentType (20170626) (required)
Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
...... data 0..1base64BinaryData inline, base64ed
...... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size SΣ1..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
... medium Σ0..*CodeableConceptA channel of communication
Binding: ParticipationMode (example): Codes for communication mediums such as phone, fax, email, in person, etc.


... status ?!SΣ1..1codein-progress | completed | suspended | rejected | failed
Binding: CommunicationStatus (20190415) (required)
... encounter Σ0..1Reference(Encounter)Encounter leading to message
... sent SΣ0..1dateTimeWhen sent
... received Σ0..1dateTimeWhen received
... reason S0..*Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


... subject SΣ0..1Reference(Shared Health Patient) {b}Focus of message
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... requestDetail Σ0..1Reference(CommunicationRequest)CommunicationRequest producing this message

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Communication.languagerequiredhttp://tools.ietf.org/html/bcp47
Communication.categoryrequiredCommunicationCategory
Communication.payload:attachment.content[x].contentTyperequiredAttachmentType
Communication.payload:attachment.content[x].languagerequiredhttp://tools.ietf.org/html/bcp47
Communication.mediumexamplev3 Code System ParticipationMode
Communication.statusrequiredCommunicationStatus
Communication.reasonexample

Constraints

IdPathDetailsRequirements
305-1Communicationtopic and topicGroup MUST not be populated together.
: (extension('http://hl7.org/fhir/StructureDefinition/extension-Communication.topic').exists() and extension('http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-topic-requisition').exists()).not()
att-1Communication.payload:attachment.content[x]It the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()