{
"description": "This profile is for all use cases involving outgoing emails. \\r\\nThis includes email alerts to the prescriber and delegates regarding a request.",
"_filename": "OutgoingEmail.json",
"package_name": "ca.on.health.sadie",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "OutgoingEmail",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Communication",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "OutgoingEmail",
"package_version": "0.1.2-beta",
"status": "draft",
"id": "8a7d4297-d2f7-44f8-92bc-7e74efdb648c",
"kind": "resource",
"url": "https://health.gov.on.ca/sadie/fhir/StructureDefinition/OutgoingEmail",
"version": null,
"differential": {
"element": [ {
"id": "Communication",
"path": "Communication",
"comment": "#### **_`FOR SADIE USE: This is for outgoing emails, it needs:`_**\r\n\r\n- a status, which is sent to completed once it is mailed\r\n- a priority which is always = routine\r\n- medium which is always set to the code for email\r\n- about which is either a questionnaireResponse or serviceRequest\r\n- recipient(s) which are Practioners or PractitionorRoles\r\n- payload which is the message"
}, {
"id": "Communication.identifier",
"max": "0",
"path": "Communication.identifier"
}, {
"id": "Communication.instantiatesCanonical",
"max": "0",
"path": "Communication.instantiatesCanonical"
}, {
"id": "Communication.instantiatesUri",
"max": "0",
"path": "Communication.instantiatesUri"
}, {
"id": "Communication.basedOn",
"max": "0",
"path": "Communication.basedOn"
}, {
"id": "Communication.partOf",
"max": "0",
"path": "Communication.partOf"
}, {
"id": "Communication.inResponseTo",
"max": "0",
"path": "Communication.inResponseTo"
}, {
"id": "Communication.status",
"path": "Communication.status",
"definition": "The status of the transmission.\r\n\r\n#### **_` FOR SADIE USE: Once the email is sent the status will be set to completed`_**"
}, {
"id": "Communication.statusReason",
"max": "0",
"path": "Communication.statusReason"
}, {
"id": "Communication.category",
"max": "1",
"min": 1,
"path": "Communication.category",
"binding": {
"strength": "example",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes"
},
"definition": "#### **_` FOR SADIE USE: This will have a fixed value of OUTGOING_EMAIL`_**\r\n\r\nThe type of message conveyed such as alert, notification, reminder, instruction, etc."
}, {
"id": "Communication.category.coding",
"max": "0",
"path": "Communication.category.coding"
}, {
"id": "Communication.category.coding.system",
"max": "0",
"path": "Communication.category.coding.system"
}, {
"id": "Communication.category.coding.version",
"max": "0",
"path": "Communication.category.coding.version"
}, {
"id": "Communication.category.coding.code",
"min": 1,
"path": "Communication.category.coding.code",
"binding": {
"strength": "required",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes"
},
"definition": "#### **_` FOR SADIE USE: This will have a fixed value of OUTGOING_EMAIL`_**\r\n\r\nA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)."
}, {
"id": "Communication.category.coding.display",
"max": "0",
"path": "Communication.category.coding.display"
}, {
"id": "Communication.category.coding.userSelected",
"max": "0",
"path": "Communication.category.coding.userSelected"
}, {
"id": "Communication.category.text",
"max": "0",
"path": "Communication.category.text"
}, {
"id": "Communication.priority",
"min": 1,
"path": "Communication.priority",
"fixedCode": "routine",
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.\r\n\r\n\r\n#### **_` FOR SADIE USE: This will have a fixed value of routine`_**"
}, {
"id": "Communication.medium",
"max": "1",
"min": 1,
"path": "Communication.medium",
"binding": {
"strength": "required"
},
"definition": "A channel that was used for this communication (e.g. email, fax).\r\n\r\n#### **_` FOR SADIE USE: This will have a fixed value of EMAILWRIT = email`_**",
"fixedCodeableConcept": {
"coding": [ {
"code": "EMAILWRIT",
"system": "http://terminology.hl7.org/ValueSet/v3-ParticipationMode"
} ]
}
}, {
"id": "Communication.subject",
"max": "0",
"path": "Communication.subject",
"definition": "The patient or group that was the focus of this communication"
}, {
"id": "Communication.topic",
"max": "0",
"path": "Communication.topic"
}, {
"id": "Communication.about",
"min": 1,
"path": "Communication.about",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" ]
} ],
"definition": "Other resources that pertain to this communication and to which this communication should be associated.\r\n\r\n#### **_`FOR SADIE USE: This will be a reference to a QuestionniareResponse or ServiceRequest`_**"
}, {
"id": "Communication.encounter",
"max": "0",
"path": "Communication.encounter"
}, {
"id": "Communication.sent",
"path": "Communication.sent",
"definition": "The time when this communication was sent.\r\n\r\n#### **_` FOR SADIE USE: When it was posted to kafka`_**"
}, {
"id": "Communication.received",
"max": "0",
"path": "Communication.received"
}, {
"id": "Communication.recipient",
"min": 1,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"definition": "#### **_`FOR SADIE USE: These are the Requestor and their team members. One email can have many recipients. All the recipients are Practitioners or Practitionrer roles`_**\r\n\r\nThe entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time)."
}, {
"id": "Communication.sender",
"max": "0",
"path": "Communication.sender"
}, {
"id": "Communication.reasonCode",
"max": "0",
"path": "Communication.reasonCode"
}, {
"id": "Communication.reasonReference",
"max": "0",
"path": "Communication.reasonReference"
}, {
"id": "Communication.payload",
"min": 1,
"path": "Communication.payload",
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.\r\n\r\n#### **_`FOR SADIE USE: The email contents will be in the ContentString and ContentAttachment`_**"
}, {
"id": "Communication.note",
"max": "0",
"path": "Communication.note"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication"
}