3.45 StructureDefinition: PrescribeIT Communication - Task message
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-communication
3.45.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Communication
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Communication | 0..* | Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition. | |
id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of communication information. |
sender | 1..1 | Reference(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 must be same as Task.creator. |
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: This must point to the sender associated with the message |
recipient | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). Comments: Conformance Rule: This must be the same as Task.owner |
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: This must point to the recipient associated with the message |
payload | 1..1 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. Comments: This contains notes to prescriber indicating changes made to requistion. |
contentString | 1..1 | string | Max Length: 5000 Definition: A communicated content (or for multi-part communications, one portion of the communication). Comments: This contains notes to prescriber indicating changes made to requistion. Conformance Rule: Maximum character length set to ‘5000’. |
status | 1..1 | code | Binding: CommunicationStatus (required) Fixed Value: in-progress Definition: The status of the transmission. Comments: Fixed value: in-progress |
subject | 1..1 | Reference(Shared Health Patient) {b} | Definition: The patient who was the focus of this communication. |
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: This must point to the patient associated with the message |
This structure is derived from Communication
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | ||
id | S | 1..1 | id | |
sender | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | This is the Pharmacy organization creating the note |
reference | S | 1..1 | string | |
recipient | S | 1..1 | Reference(Shared Health Practitioner) {b} | This is the Practitioner receiving the note |
reference | S | 1..1 | string | |
payload | S | 1..1 | BackboneElement | |
contentString | S | 1..1 | string | Max Length: 5000 |
status | S | 1..1 | code | Fixed Value: in-progress |
subject | S | 1..1 | Reference(Shared Health Patient) {b} | |
reference | S | 1..1 | string | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | SΣ | 0..* | A record of information transmitted from a sender to a receiver | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Unique identifier |
category | Σ | 0..1 | CodeableConcept | Message category Binding: (unbound) (example) |
sender | SΣ | 1..1 | Reference(Shared Health - eRx Service Location) {b} | This is the Pharmacy organization creating the note |
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 |
recipient | SΣ | 1..1 | Reference(Shared Health Practitioner) {b} | This is the Practitioner receiving the note |
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 |
payload | SΣ | 1..1 | BackboneElement | Message payload |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
contentString | SΣ | 1..1 | string | Message part content Max Length: 5000 |
medium | Σ | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (required) Fixed Value: in-progress |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | Σ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | Σ | 0..* | CodeableConcept | Indication for message Binding: (unbound) (example) |
subject | SΣ | 1..1 | Reference(Shared Health Patient) {b} | Focus of message |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
display | Σ | 0..1 | string | Text alternative for the resource |
requestDetail | Σ | 0..1 | Reference(CommunicationRequest) | CommunicationRequest producing this message |
Documentation for this format |
Grid View
This structure is derived from Communication
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
Communication | 0..* | Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition. | |
id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of communication information. |
sender | 1..1 | Reference(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 must be same as Task.creator. |
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: This must point to the sender associated with the message |
recipient | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time). Comments: Conformance Rule: This must be the same as Task.owner |
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: This must point to the recipient associated with the message |
payload | 1..1 | BackboneElement | Definition: Text, attachment(s), or resource(s) that was communicated to the recipient. Comments: This contains notes to prescriber indicating changes made to requistion. |
contentString | 1..1 | string | Max Length: 5000 Definition: A communicated content (or for multi-part communications, one portion of the communication). Comments: This contains notes to prescriber indicating changes made to requistion. Conformance Rule: Maximum character length set to ‘5000’. |
status | 1..1 | code | Binding: CommunicationStatus (required) Fixed Value: in-progress Definition: The status of the transmission. Comments: Fixed value: in-progress |
subject | 1..1 | Reference(Shared Health Patient) {b} | Definition: The patient who was the focus of this communication. |
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: This must point to the patient associated with the message |
This structure is derived from Communication
Differential View
This structure is derived from Communication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | S | 0..* | ||
id | S | 1..1 | id | |
sender | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | This is the Pharmacy organization creating the note |
reference | S | 1..1 | string | |
recipient | S | 1..1 | Reference(Shared Health Practitioner) {b} | This is the Practitioner receiving the note |
reference | S | 1..1 | string | |
payload | S | 1..1 | BackboneElement | |
contentString | S | 1..1 | string | Max Length: 5000 |
status | S | 1..1 | code | Fixed Value: in-progress |
subject | S | 1..1 | Reference(Shared Health Patient) {b} | |
reference | S | 1..1 | string | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Communication | SΣ | 0..* | A record of information transmitted from a sender to a receiver | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Unique identifier |
category | Σ | 0..1 | CodeableConcept | Message category Binding: (unbound) (example) |
sender | SΣ | 1..1 | Reference(Shared Health - eRx Service Location) {b} | This is the Pharmacy organization creating the note |
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 |
recipient | SΣ | 1..1 | Reference(Shared Health Practitioner) {b} | This is the Practitioner receiving the note |
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 |
payload | SΣ | 1..1 | BackboneElement | Message payload |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
contentString | SΣ | 1..1 | string | Message part content Max Length: 5000 |
medium | Σ | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (example) |
status | ?!SΣ | 1..1 | code | in-progress | completed | suspended | rejected | failed Binding: CommunicationStatus (required) Fixed Value: in-progress |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter leading to message |
sent | Σ | 0..1 | dateTime | When sent |
received | Σ | 0..1 | dateTime | When received |
reason | Σ | 0..* | CodeableConcept | Indication for message Binding: (unbound) (example) |
subject | SΣ | 1..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.45.3 Terminology Bindings
Terminology Bindings
Path | Name | Conformance | ValueSet |
Communication.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Communication.category | ?ext | example | |
Communication.medium | v3 Code System ParticipationMode | example | v3 Code System ParticipationMode |
Communication.status | CommunicationStatus | required | CommunicationStatus |
Communication.reason | ?ext | example |
3.45.4 Constraints
Constraints
Id | Path | Details | Requirements |