FHIR IG Statistics: StructureDefinition/a372e3bb-43b8-4379-9a6b-538f4bac6117
Resources that use this resource
No resources found
Resources that this resource uses
Narrative
No narrative content found in resource
Source
{
"resourceType": "StructureDefinition",
"id": "a372e3bb-43b8-4379-9a6b-538f4bac6117",
"url": "https://health.gov.on.ca/sadie/fhir/StructureDefinition/OutgoingEmail",
"version": "1.0.0",
"name": "OutgoingToRequestor",
"title": "OutgoingToRequestor",
"status": "active",
"description": "This profile is for all use cases involving outgoing messages to the Requestor. \nThis includes email alerts to the Requestor and Delegates regarding a request.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Communication",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Communication",
"path": "Communication",
"comment": "#### **_`FOR SADIE USE: This is for outgoing messages, it needs:`_**\n\n- a status, which is sent to completed once it is mailed\n- a priority which is always = routine\n- medium which is always set to the code for email\n- about which is either a questionnaireResponse or serviceRequest\n- recipient(s) which are Practioners or PractitionorRoles\n- payload which is the message"
},
{
"id": "Communication.identifier",
"path": "Communication.identifier",
"max": "0"
},
{
"id": "Communication.instantiatesCanonical",
"path": "Communication.instantiatesCanonical",
"max": "0"
},
{
"id": "Communication.instantiatesUri",
"path": "Communication.instantiatesUri",
"max": "0"
},
{
"id": "Communication.basedOn",
"path": "Communication.basedOn",
"max": "0"
},
{
"id": "Communication.partOf",
"path": "Communication.partOf",
"definition": "#### **_` FOR SADIE USE: This is a reference to the Requestor Role that is the owner of the basedOn Request. This is used by the security inteceptor.`_**\n\nThe type of message conveyed such as alert, notification, reminder, instruction, etc.",
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://health.gov.on.ca/sadie/fhir/StructureDefinition/FlexFormsRole"
]
}
]
},
{
"id": "Communication.inResponseTo",
"path": "Communication.inResponseTo",
"max": "0"
},
{
"id": "Communication.status",
"path": "Communication.status",
"definition": "The status of the transmission.\n\n#### **_` FOR SADIE USE: Once the email is sent the status will be set to completed`_**"
},
{
"id": "Communication.statusReason",
"path": "Communication.statusReason",
"max": "0"
},
{
"id": "Communication.category",
"path": "Communication.category",
"definition": "#### **_` FOR SADIE USE: This will have a fixed value of OUTGOING_EMAIL`_**\n\nThe type of message conveyed such as alert, notification, reminder, instruction, etc.",
"min": 1,
"max": "1",
"binding": {
"strength": "example",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes"
}
},
{
"id": "Communication.category.coding",
"path": "Communication.category.coding",
"max": "0"
},
{
"id": "Communication.category.coding.system",
"path": "Communication.category.coding.system",
"max": "0"
},
{
"id": "Communication.category.coding.version",
"path": "Communication.category.coding.version",
"max": "0"
},
{
"id": "Communication.category.coding.code",
"path": "Communication.category.coding.code",
"definition": "#### **_` FOR SADIE USE: This will have a fixed value of OUTGOING_EMAIL`_**\n\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).",
"min": 1,
"binding": {
"strength": "required",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes"
}
},
{
"id": "Communication.category.coding.display",
"path": "Communication.category.coding.display",
"max": "0"
},
{
"id": "Communication.category.coding.userSelected",
"path": "Communication.category.coding.userSelected",
"max": "0"
},
{
"id": "Communication.category.text",
"path": "Communication.category.text",
"max": "0"
},
{
"id": "Communication.priority",
"path": "Communication.priority",
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.\n\n\n#### **_` FOR SADIE USE: This will have a fixed value of routine`_**",
"min": 1,
"fixedCode": "routine"
},
{
"id": "Communication.medium",
"path": "Communication.medium",
"definition": "#### **_` FOR SADIE USE: This will have a fixed value of EMAILWRIT = email`_**\n\nA channel that was used for this communication (e.g. email, fax).",
"min": 1,
"max": "1",
"fixedCodeableConcept": {
"text": "EMAILWRIT"
},
"binding": {
"strength": "required"
}
},
{
"id": "Communication.subject",
"path": "Communication.subject",
"definition": "The patient or group that was the focus of this communication",
"max": "0"
},
{
"id": "Communication.topic",
"path": "Communication.topic",
"max": "0"
},
{
"id": "Communication.about",
"path": "Communication.about",
"definition": "Other resources that pertain to this communication and to which this communication should be associated.\n\n#### **_`FOR SADIE USE: This will be a reference to a QuestionniareResponse or ServiceRequest`_**",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
]
}
]
},
{
"id": "Communication.encounter",
"path": "Communication.encounter",
"max": "0"
},
{
"id": "Communication.sent",
"path": "Communication.sent",
"definition": "The time when this communication was sent.\n\n#### **_` FOR SADIE USE: When it was posted to kafka`_**"
},
{
"id": "Communication.received",
"path": "Communication.received",
"max": "0"
},
{
"id": "Communication.recipient",
"path": "Communication.recipient",
"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`_**\n\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).",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"
]
}
]
},
{
"id": "Communication.sender",
"path": "Communication.sender",
"max": "0"
},
{
"id": "Communication.reasonCode",
"path": "Communication.reasonCode",
"max": "0"
},
{
"id": "Communication.reasonReference",
"path": "Communication.reasonReference",
"max": "0"
},
{
"id": "Communication.payload",
"path": "Communication.payload",
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.\n\n#### **_`FOR SADIE USE: The email contents will be in the ContentString and ContentAttachment`_**",
"min": 1
},
{
"id": "Communication.note",
"path": "Communication.note",
"max": "0"
}
]
}
}
FHIR