3.90 StructureDefinition: PrescribeIT® Clinician Communication
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-communication-cc
3.90.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(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:
|
This is a choice of sender types. The sender may either be a registered PrescribeIT® Practitioner or a locum or a Pharmacy. ---------------------
OBO 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. -------------------- 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. |
|
| 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.
3.90.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..* | Communication | 305-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..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. |
| 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: 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..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
| value[x] | 1..1 | Reference() | 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..1 | Reference() {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..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. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
 value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Slice: Unordered, Closed by type:$this Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
| extension (topicGroup) | 0..1 | Communication Topic Group | Definition: 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..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 = '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..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" |
| value[x] | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: A reference from one resource to another. |
| 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 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..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: 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 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 (20211125) (required) Definition: This is used to described the category type of clinical communication message. Comments: Usage Note: For vendors implementing v5.0 the binding to use is CommunicationCategory (20190415) (required) which contains only the value of 'general'. For vendors implementing v5.2 or higher the binding to use is the one that is declared above which contains additional values. |
| 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 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: Conformance Rule: This set of constraints applies when the sender is either a Practitioner or Organization |
| 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 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..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 either the Practitioner or Organization Provider Registry ID. |
| 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 (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. |
| recipient | 1..1 | Reference(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..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 Practitioner |
| 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: 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..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. |
| content[x] | 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. |
| content[x] | 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 (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..1 | uri | Example' 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..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 (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..1 | dateTime | Definition: The time when this communication was sent. |
| reason | 0..* | Shared Health CodeableConcept Code | Binding: (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..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: 11 elements (9 nested mandatory elements)
Must-Support: 39 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/profile-organization-service-location
- 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ΣI | 0..* | Communication | A record of information transmitted from a sender to a receiver 305-1: topic and topicGroup MUST not be populated together. |
 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): A human language. | |
| text | 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 | SI | 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" |
 value[x] | S | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
 value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension-Reference.identifier | S | 1..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 | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| value[x] | S | 1..1 | (Slice Definition) | Prescriber PrescriptionNumber Slice: Unordered, Closed by type:$this |
| value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| ext-communication-topic-requisition | SI | 0..1 | Shared Health Identifier | Communication Topic Group 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 (20190415) (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" |
 value[x] | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | A reference from one resource to another |
| 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 | SΣI | 1..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 (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..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 | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| sender:locum | SΣ | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Message sender |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 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} | Message recipient |
| 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 | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text 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..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 | Message part content | |
| contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| payload:string | 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 |
| content[x] | SΣ | 1..1 | string | Message part content |
| payload:attachment | 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 |
| content[x] | 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 (20170626) (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): A human language. 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): Codes for communication mediums such as phone, fax, email, in person, etc. |
| status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (20190415) (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): Codes for describing reasons for the occurrence of a communication. |
| 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..* | Communication | 305-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..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. |
| 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: 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..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Communication.topic" |
| value[x] | 1..1 | Reference() | 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..1 | Reference() {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..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. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Slice: Unordered, Closed by type:$this Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
| extension (topicGroup) | 0..1 | Communication Topic Group | Definition: 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..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 = '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..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" |
| value[x] | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | Definition: A reference from one resource to another. |
| 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 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..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: 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 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 (20211125) (required) Definition: This is used to described the category type of clinical communication message. Comments: Usage Note: For vendors implementing v5.0 the binding to use is CommunicationCategory (20190415) (required) which contains only the value of 'general'. For vendors implementing v5.2 or higher the binding to use is the one that is declared above which contains additional values. |
| 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 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: Conformance Rule: This set of constraints applies when the sender is either a Practitioner or Organization |
| 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 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..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 either the Practitioner or Organization Provider Registry ID. |
| 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 (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. |
| recipient | 1..1 | Reference(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..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 Practitioner |
| 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: 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..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. |
| content[x] | 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. |
| content[x] | 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 (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..1 | uri | Example' 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..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 (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..1 | dateTime | Definition: The time when this communication was sent. |
| reason | 0..* | Shared Health CodeableConcept Code | Binding: (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..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: 11 elements (9 nested mandatory elements)
Must-Support: 39 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/profile-organization-service-location
- 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ΣI | 0..* | Communication | A record of information transmitted from a sender to a receiver 305-1: topic and topicGroup MUST not be populated together. |
| 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): A human language. | |
| text | 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 | SI | 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" |
| value[x] | S | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this |
| value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension-Reference.identifier | S | 1..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 | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| value[x] | S | 1..1 | (Slice Definition) | Prescriber PrescriptionNumber Slice: Unordered, Closed by type:$this |
| value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| ext-communication-topic-requisition | SI | 0..1 | Shared Health Identifier | Communication Topic Group 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 (20190415) (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" |
| value[x] | S | 1..1 | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) {b} | A reference from one resource to another |
| 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 | SΣI | 1..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 (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..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 | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| sender:locum | SΣ | 0..1 | Reference(Shared Health Locum Practitioner) {b} | Message sender |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 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} | Message recipient |
| 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 | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text 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..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 | Message part content | |
| contentString | string | |||
| contentAttachment | Attachment | |||
| contentReference | Reference(Resource) | |||
| payload:string | 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 |
| content[x] | SΣ | 1..1 | string | Message part content |
| payload:attachment | 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 |
| content[x] | 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 (20170626) (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): A human language. 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): Codes for communication mediums such as phone, fax, email, in person, etc. |
| status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (20190415) (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): Codes for describing reasons for the occurrence of a communication. |
| 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.90.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Communication.language | required | http://tools.ietf.org/html/bcp47 |
| Communication.category | required | CommunicationCategory |
| Communication.payload:attachment.content[x].contentType | required | AttachmentType |
| Communication.payload:attachment.content[x].language | required | http://tools.ietf.org/html/bcp47 |
| Communication.medium | example | v3 Code System ParticipationMode |
| Communication.status | required | CommunicationStatus |
| Communication.reason | example |
3.90.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| 305-1 | Communication | topic 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-1 | Communication.payload:attachment.content[x] | It the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() |