3.59.6 StructureDefinition: PrescribeIT® Clinician Communication - Detailed Descriptions
Definitions for the profile-communication-cc Profile.
1. Communication | |
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. |
Control | 0..* |
Must Support | true |
Max Length | 0 |
Invariants | Defined on this element 305-1: 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()) |
2. Communication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 1..1 |
Type | id |
Must Support | true |
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. |
Max Length | 0 |
3. Communication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Max Length | 0 |
4. Communication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Max Length | 0 |
5. Communication.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language. |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Max Length | 0 |
6. Communication.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Max Length | 0 |
7. Communication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Max Length | 0 |
8. Communication.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. Communication.extension:subject | |
SliceName | subject |
Definition | A string describing the 'subject' of the communication. Equvalent to 'subject' in an email. |
Control | 0..1 |
Type | Extension(Communication Subject) (Extension Type: string) |
Must Support | true |
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). |
Max Length | 0 |
10. Communication.extension:topic | |
SliceName | topic |
Definition | Allows a communication to reference the individual Medication Order |
Control | 0..1 This element is affected by the following invariants: p305-1 |
Type | Extension(Communication Topic) (Extension Type: Reference) |
Must Support | true |
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. |
Max Length | 0 |
11. Communication.extension:topic.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
12. Communication.extension:topic.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
13. Communication.extension:topic.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | Fixed value: http://hl7.org/fhir/StructureDefinition/extension-Communication.topic |
Fixed Value | http://hl7.org/fhir/StructureDefinition/extension-Communication.topic |
14. Communication.extension:topic.value[x] | |
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). |
Control | 1..1 |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Slicing | This element introduces a set of slices on Communication.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
15. Communication.extension:topic.value[x]:valueReference | |
SliceName | valueReference |
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). |
Control | 1..1 |
Type | Reference |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
16. Communication.extension:topic.value[x]:valueReference.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
17. Communication.extension:topic.value[x]:valueReference.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. |
Control | 1..1 |
Type | Extension(Reference.identifier DSTU2 extension) (Extension Type: Identifier) |
Must Support | true |
Max Length | 0 |
18. Communication.extension:topic.value[x]:valueReference.extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
19. Communication.extension:topic.value[x]:valueReference.extension.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
20. Communication.extension:topic.value[x]:valueReference.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier |
21. Communication.extension:topic.value[x]:valueReference.extension.value[x] | |
Definition | A technical identifier - identifies some entity uniquely and unambiguously. |
Control | 1..1 |
Type | Identifier(PrescribeIT® Prescriber Prescription Identifier) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.extension.value[x].extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
22. Communication.extension:topic.value[x]:valueReference.extension.value[x]:valueIdentifier | |
SliceName | valueIdentifier |
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). |
Control | 1..1 |
Type | Identifier |
[x] Note | See Choice of Data Types for further information about how to use [x] |
23. Communication.extension:topic.value[x]:valueReference.reference | |
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. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
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. |
Max Length | 0 |
24. Communication.extension:topic.value[x]:valueReference.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
25. Communication.extension:topicGroup | |
SliceName | topicGroup |
Definition | Allows a communication to reference the group of Medication Orders found in the bundle |
Control | 0..1 This element is affected by the following invariants: p305-1 |
Type | Extension(Communication Topic Group) (Extension Type: Identifier(Shared Health Identifier)) |
Must Support | true |
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. |
Max Length | 0 |
26. Communication.extension:enterer | |
SliceName | enterer |
Definition | The individual responsible for recording the communication in an electronic system. |
Control | 0..1 |
Type | Extension(Communication Enterer) (Extension Type: Reference(Shared Health Reference)(Shared Health Non-Clinician Practitioner)) |
Must Support | true |
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 |
Max Length | 0 |
27. Communication.extension:priority | |
SliceName | priority |
Definition | Indicates the relative urgent of this communication in comparison with others |
Control | 0..1 |
Type | Extension(Communication Priority) (Extension Type: code) |
Must Support | true |
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. |
Max Length | 0 |
28. Communication.extension:threadId | |
SliceName | threadId |
Definition | An identifier kept in common by all communications forming a single discussion thread |
Control | 1..1 |
Type | Extension(Communication Thread Id) (Extension Type: string) |
Must Support | true |
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. |
Max Length | 0 |
29. Communication.extension:replyTo | |
SliceName | replyTo |
Definition | Indicates the practitioner or organization to which responses should be directed as the primary recipient |
Control | 1..1 |
Type | Extension(Communication Reply To) (Extension Type: Reference(Shared Health Reference, Shared Health Reference)(Shared Health Practitioner | Shared Health - eRx Service Location)) |
Must Support | true |
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 |
Max Length | 0 |
30. Communication.extension:replyTo.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
31. Communication.extension:replyTo.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
32. Communication.extension:replyTo.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | Fixed value: http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to |
Fixed Value | http://sharedhealth.exchange/fhir/StructureDefinition/ext-communication-reply-to |
33. Communication.extension:replyTo.value[x] | |
Definition | A reference from one resource to another. |
Control | 1..1 |
Type | Reference(Shared Health Reference, Shared Health Reference)(Shared Health Practitioner | Shared Health - eRx Service Location) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
34. Communication.extension:replyTo.value[x].id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
35. Communication.extension:replyTo.value[x].extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
36. Communication.extension:replyTo.value[x].extension:onBehalfOf | |
SliceName | onBehalfOf |
Definition | Describes an Organization that a referenced practitioner is acting on-behalf-of |
Control | 0..1 |
Type | Extension(On-Behalf-Of Organization) (Extension Type: Reference(Shared Health Reference)(Shared Health - eRx Service Location)) |
Must Support | true |
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. |
Max Length | 0 |
37. Communication.extension:replyTo.value[x].reference | |
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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |
38. Communication.extension:replyTo.value[x].display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
39. Communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
40. Communication.identifier | |
Definition | A technical identifier - identifies some entity uniquely and unambiguously. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier(Shared Health Identifier) |
Must Support | true |
Comments | Conformance Rule: This business identifier must be created by the sending application and must be unique for each communiciation. |
Max Length | 0 |
41. Communication.category | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 |
Binding | The codes SHALL be taken from CommunicationCategory (20190415) |
Type | CodeableConcept(Shared Health CodeableConcept Code) |
Must Support | true |
Comments | - |
Max Length | 0 |
42. Communication.sender | |
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
Control | 1..1 |
Type | Reference(Shared Health Practitioner | Shared Health Locum Practitioner | Shared Health - eRx Service Location) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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. |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.sender. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
43. Communication.sender:PR | |
SliceName | PR |
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
Control | 0..1 |
Type | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Comments | Conformance Rule: This set of constraints applies when the sender is either a Practitioner or Organization |
Max Length | 0 |
44. Communication.sender:PR.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
45. Communication.sender:PR.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.sender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
46. Communication.sender:PR.extension:locum | |
SliceName | locum |
Definition | If set to true, indicates that the sender with this extension is a locum |
Control | 0..0 |
Type | Extension(Communication Recipient Locum Indicator) (Extension Type: boolean) |
Max Length | 0 |
47. Communication.sender:PR.extension:onBehalfOf | |
SliceName | onBehalfOf |
Definition | Describes an Organization that a referenced practitioner is acting on-behalf-of |
Control | 0..1 |
Type | Extension(On-Behalf-Of Organization) (Extension Type: Reference(Shared Health Reference)(Shared Health - eRx Service Location)) |
Must Support | true |
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 |
Max Length | 0 |
48. Communication.sender:PR.reference | |
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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | Conformance Rule: This must point to either the Practitioner or Organization Provider Registry ID. |
Max Length | 0 |
49. Communication.sender:PR.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
50. Communication.sender:locum | |
SliceName | locum |
Definition | The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. |
Control | 0..1 |
Type | Reference(Shared Health Locum Practitioner) |
Must Support | true |
Comments | Conformance Rule: This set of constraints applies when the sender is a Locum. |
Max Length | 0 |
51. Communication.sender:locum.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
52. Communication.sender:locum.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.sender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
53. Communication.sender:locum.extension:locum | |
SliceName | locum |
Definition | If set to true, indicates that the sender with this extension is a locum |
Control | 1..1 |
Type | Extension(Communication Recipient Locum Indicator) (Extension Type: boolean) |
Must Support | true |
Max Length | 0 |
54. Communication.sender:locum.reference | |
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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | Conformance Rule: This must point to the Locum Practitioner. |
Max Length | 0 |
55. Communication.sender:locum.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
56. Communication.recipient | |
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). |
Control | 1..1 |
Type | Reference(Shared Health Practitioner | Shared Health - eRx Service Location) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Max Length | 0 |
57. Communication.recipient.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
58. Communication.recipient.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.recipient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
59. Communication.recipient.extension:onBehalfOf | |
SliceName | onBehalfOf |
Definition | Describes an Organization that a referenced practitioner is acting on-behalf-of |
Control | 0..1 |
Type | Extension(On-Behalf-Of Organization) (Extension Type: Reference(Shared Health Reference)(Shared Health - eRx Service Location)) |
Must Support | true |
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 |
Max Length | 0 |
60. Communication.recipient.reference | |
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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |
61. Communication.recipient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
62. Communication.payload | |
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. |
Control | 1..21 |
Type | BackboneElement |
Must Support | true |
Comments | This is used to convey the message to the recipient. |
Max Length | 0 |
Slicing | This element introduces a set of slices on Communication.payload. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
63. Communication.payload.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
64. Communication.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
65. Communication.payload.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
66. Communication.payload.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | Choice of: string, Attachment, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Max Length | 0 |
67. Communication.payload:string | |
SliceName | string |
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Max Length | 0 |
68. Communication.payload:string.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
69. Communication.payload:string.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
70. Communication.payload:string.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
71. Communication.payload:string.content[x] | |
Definition | A communicated content (or for multi-part communications, one portion of the communication). |
Control | 1..1 |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Max Length | 0 |
72. Communication.payload:attachment | |
SliceName | attachment |
Definition | Text, attachment(s), or resource(s) that was communicated to the recipient. |
Control | 0..20 |
Type | BackboneElement |
Must Support | true |
Max Length | 0 |
73. Communication.payload:attachment.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
74. Communication.payload:attachment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
75. Communication.payload:attachment.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
76. Communication.payload:attachment.content[x] | |
Definition | For referring to data content defined in other formats. |
Control | 1..1 |
Type | Attachment(Shared Health Attachment) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Max Length | 0 |
Invariants | Defined on this element att-1: It the Attachment has data, it SHALL have a contentType (: data.empty() or contentType.exists()) |
77. Communication.payload:attachment.content[x].id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
78. Communication.payload:attachment.content[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
79. Communication.payload:attachment.content[x].contentType | |
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. |
Control | 1..1 |
Binding | The codes SHALL be taken from AttachmentType (20170626) |
Type | code |
Must Support | true |
Requirements | Processors of the data need to be able to know how to interpret the data. |
Comments | Identifies the mime type the binary content is expressed in |
Max Length | 0 |
Example | General:text/plain; charset=UTF-8, image/png |
80. Communication.payload:attachment.content[x].language | |
Definition | The human language of the content. The value can be any valid value according to BCP 47. |
Control | 0..1 |
Binding | The codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language. |
Type | code |
Requirements | Users need to be able to choose between the languages in a set of attachments. |
Max Length | 0 |
Example | General:en-AU |
81. Communication.payload:attachment.content[x].data | |
Definition | The actual data of the attachment - a sequence of bytes. In XML, represented using base64. |
Control | 0..1 |
Type | base64Binary |
Requirements | The data needs to able to be transmitted inline. |
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
Max Length | 0 |
82. Communication.payload:attachment.content[x].url | |
Definition | An alternative location where the data can be accessed. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | The data needs to be transmitted by reference. |
Comments | Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment |
Max Length | 0 |
Example | General:http://www.acme.com/logo-small.png |
83. Communication.payload:attachment.content[x].size | |
Definition | The number of bytes of data that make up this attachment. |
Control | 1..1 |
Type | unsignedInt |
Must Support | true |
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
Comments | Conformance Rule: The combined size of all attachments cannot exceed 50 MB. |
Max Length | 0 |
84. Communication.payload:attachment.content[x].hash | |
Definition | The calculated hash of the data using SHA-1. Represented using base64. |
Control | 0..1 |
Type | base64Binary |
Requirements | Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature. |
Max Length | 0 |
85. Communication.payload:attachment.content[x].title | |
Definition | A label or set of text to display in place of the data. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
Max Length | 0 |
Example | General:Official Corporate Logo |
86. Communication.payload:attachment.content[x].creation | |
Definition | The date that the attachment was first created. |
Control | 0..1 |
Type | dateTime |
Requirements | This is often tracked as an integrity issue for use of the attachment. |
Max Length | 0 |
87. Communication.medium | |
Definition | A channel that was used for this communication (e.g. email, fax). |
Control | 0..* |
Binding | For example codes, see ParticipationMode Codes for communication mediums such as phone, fax, email, in person, etc. |
Type | CodeableConcept |
Max Length | 0 |
88. Communication.status | |
Definition | The status of the transmission. |
Control | 1..1 |
Binding | The codes SHALL be taken from CommunicationStatus (20190415) |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | Usage Note: The sending system should set this to 'in-progress'. There are no expectations on the receiving system to consider this value. |
Max Length | 0 |
89. Communication.encounter | |
Definition | The encounter within which the communication was sent. |
Control | 0..1 |
Type | Reference(Encounter) |
Max Length | 0 |
90. Communication.sent | |
Definition | The time when this communication was sent. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Max Length | 0 |
91. Communication.received | |
Definition | The time when this communication arrived at the destination. |
Control | 0..1 |
Type | dateTime |
Max Length | 0 |
92. Communication.reason | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..* |
Binding | Codes for describing reasons for the occurrence of a communication. |
Type | CodeableConcept(Shared Health CodeableConcept Code) |
Must Support | true |
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. |
Max Length | 0 |
93. Communication.subject | |
Definition | The patient who was the focus of this communication. |
Control | 0..1 |
Type | Reference(Shared Health Patient) |
Must Support | true |
Comments | Conformance Rule: If the communication relates to a patient, this will be populated. |
Max Length | 0 |
94. Communication.subject.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
95. Communication.subject.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
96. Communication.subject.reference | |
Definition | - |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
Comments | Conformance Rule: This must point to the patient associated with the message. No external references should be used. |
Max Length | 0 |
97. Communication.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Max Length | 0 |
98. Communication.requestDetail | |
Definition | The communication request that was responsible for producing this communication. |
Control | 0..1 |
Type | Reference(CommunicationRequest) |
Max Length | 0 |