PrescribeIT® Specification and Guide Version 3.0 Revision C

 

3.51 StructureDefinition: PrescribeIT® Communication - Task message

The official URL for this profile is: 

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

3.51.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

NameCard.TypeConstraints and Usage
.  Communication 0..*CommunicationDefinition:
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.

..  sender 1..1Reference(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..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:
This must point to the sender associated with the message

..  recipient 1..1Reference(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..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 be the Practitioner recipient.

..  payload 1..1BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.


Comments:
This contains notes to prescriber indicating changes made to requistion.

...  content[x]
       (contentString) 		1..1stringMax 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.

..  status 1..1codeBinding: CommunicationStatus (required): The status of the communication.


Fixed Value: in-progress
Definition:
The status of the transmission.


Comments:
Fixed value: in-progress

..  subject 1..1Reference(Shared Health Patient) {b}Definition:
The patient who was the focus of this communication.

...  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:
This must point to the patient associated with the message

This structure is derived from Communication

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication S0..*CommunicationA record of information transmitted from a sender to a receiver
... id S1..1idLogical id of this artifact
... sender S1..1Reference(Shared Health - eRx Service Location) {b}This is the Pharmacy organization creating the note
.... reference S1..1stringRelative, internal or absolute URL reference
... recipient S1..1Reference(Shared Health Practitioner) {b}This is the Practitioner receiving the note
.... reference S1..1stringRelative, internal or absolute URL reference
... payload S1..1BackboneElementMessage payload
.... contentString S1..1stringMessage part content
Max Length: 5000
... status S1..1codein-progress | completed | suspended | rejected | failed
Fixed Value: in-progress
... subject S1..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Σ0..*CommunicationA record of information transmitted from a sender to a receiver
... 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 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... category Σ0..1CodeableConceptMessage category
Binding: (unbound) (example): Codes for general categories of communications such as alerts, instruction, etc.

... sender SΣ1..1Reference(Shared Health - eRx Service Location) {b}This is the Pharmacy organization creating the note
.... 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
... recipient SΣ1..1Reference(Shared Health Practitioner) {b}This is the Practitioner receiving the note
.... 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
... payload SΣ1..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] Σ1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString SΣ1..1stringMessage part content
Max Length: 5000
... 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 (required): The status of the communication.


Fixed Value: in-progress
... encounter Σ0..1Reference(Encounter)Encounter leading to message
... sent Σ0..1dateTimeWhen sent
... received Σ0..1dateTimeWhen received
... reason Σ0..*CodeableConceptIndication for message
Binding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


... subject SΣ1..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..*CommunicationDefinition:
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.

..  sender 1..1Reference(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..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:
This must point to the sender associated with the message

..  recipient 1..1Reference(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..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 be the Practitioner recipient.

..  payload 1..1BackboneElementDefinition:
Text, attachment(s), or resource(s) that was communicated to the recipient.


Comments:
This contains notes to prescriber indicating changes made to requistion.

...  content[x]
       (contentString) 		1..1stringMax 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.

..  status 1..1codeBinding: CommunicationStatus (required): The status of the communication.


Fixed Value: in-progress
Definition:
The status of the transmission.


Comments:
Fixed value: in-progress

..  subject 1..1Reference(Shared Health Patient) {b}Definition:
The patient who was the focus of this communication.

...  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:
This must point to the patient associated with the message

This structure is derived from Communication

Differential View

This structure is derived from Communication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Communication S0..*CommunicationA record of information transmitted from a sender to a receiver
... id S1..1idLogical id of this artifact
... sender S1..1Reference(Shared Health - eRx Service Location) {b}This is the Pharmacy organization creating the note
.... reference S1..1stringRelative, internal or absolute URL reference
... recipient S1..1Reference(Shared Health Practitioner) {b}This is the Practitioner receiving the note
.... reference S1..1stringRelative, internal or absolute URL reference
... payload S1..1BackboneElementMessage payload
.... contentString S1..1stringMessage part content
Max Length: 5000
... status S1..1codein-progress | completed | suspended | rejected | failed
Fixed Value: in-progress
... subject S1..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Σ0..*CommunicationA record of information transmitted from a sender to a receiver
... 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 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... category Σ0..1CodeableConceptMessage category
Binding: (unbound) (example): Codes for general categories of communications such as alerts, instruction, etc.

... sender SΣ1..1Reference(Shared Health - eRx Service Location) {b}This is the Pharmacy organization creating the note
.... 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
... recipient SΣ1..1Reference(Shared Health Practitioner) {b}This is the Practitioner receiving the note
.... 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
... payload SΣ1..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] Σ1..1(Slice Definition)Message part content
Slice: Unordered, Closed by type:$this
..... content[x]:contentString SΣ1..1stringMessage part content
Max Length: 5000
... 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 (required): The status of the communication.


Fixed Value: in-progress
... encounter Σ0..1Reference(Encounter)Encounter leading to message
... sent Σ0..1dateTimeWhen sent
... received Σ0..1dateTimeWhen received
... reason Σ0..*CodeableConceptIndication for message
Binding: (unbound) (example): Codes for describing reasons for the occurrence of a communication.


... subject SΣ1..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

3.51.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Communication.languagerequiredhttp://tools.ietf.org/html/bcp47
Communication.categoryexample
Communication.mediumexamplev3 Code System ParticipationMode
Communication.statusrequiredFixed Value: in-progress
Communication.reasonexample

3.51.4 Constraints

Constraints

IdPathDetailsRequirements