{
"description": "Communications between the SADIE system and the Client system.",
"_filename": "ClientCommunication.json",
"package_name": "ca.on.health.sadie",
"date": null,
"derivation": "constraint",
"meta": {
"tag": [ {
"code": "validation_passed",
"system": "https://smilecdr.com/fhir/NamingSystem/tags",
"display": "Validation Passed"
} ],
"versionId": "2",
"lastUpdated": "2021-08-25T17:41:22.083+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "ClientCommunication",
"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": "ClientCommunication",
"package_version": "0.1.29-beta",
"status": "active",
"id": "0ff24699-b0c4-4b4c-b0c8-247ba03ef3e8",
"kind": "resource",
"url": "https://health.gov.on.ca/sadie/fhir/StructureDefinition/ClientCommunication",
"version": "1.0",
"differential": {
"element": [ {
"id": "Communication",
"path": "Communication",
"definition": "#### **_`FOR SADIE USE: This is used to record data exchanges between SADIE and Client Systems. This includes sending submission data and the client sending status updates and files`_**\n\n\nAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition."
}, {
"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": "1",
"min": 1,
"path": "Communication.basedOn",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://health.gov.on.ca/sadie/fhir/StructureDefinition/Request" ]
} ],
"definition": "#### **_`FOR SADIE USE: This is a reference to the Request.`_**\n\nAn order, proposal or plan fulfilled in whole or in part by this Communication."
}, {
"id": "Communication.partOf",
"max": "1",
"min": 1,
"path": "Communication.partOf",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://health.gov.on.ca/sadie/fhir/StructureDefinition/FlexFormsRole" ]
} ],
"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.`_**"
}, {
"id": "Communication.inResponseTo",
"max": "0",
"path": "Communication.inResponseTo"
}, {
"id": "Communication.status",
"path": "Communication.status",
"definition": "#### **_`FOR SADIE USE: Use 'completed' if it was sucessful and 'entered-in-error' for errors.`_**\n\nThe status of the transmission."
}, {
"id": "Communication.statusReason",
"path": "Communication.statusReason",
"binding": {
"strength": "required",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-ClientCommunication-Errors"
},
"definition": "#### **_`FOR SADIE USE: This is the code for the SADIE error message.`_**\n\nThe status of the transmission."
}, {
"id": "Communication.category",
"max": "1",
"min": 1,
"path": "Communication.category",
"binding": {
"strength": "required",
"valueSet": "http://health.gov.on.ca/sadie/fhir/ValueSet/FlexForms-CommunicationTypes"
},
"definition": "#### **_`FOR SADIE USE: This has a fixed value of CLIENT to signify this is a communication with a client system.`_**\n\nThe type of message conveyed such as alert, notification, reminder, instruction, etc.",
"fixedCodeableConcept": {
"text": "CLIENT"
}
}, {
"id": "Communication.priority",
"max": "0",
"path": "Communication.priority"
}, {
"id": "Communication.medium",
"max": "0",
"path": "Communication.medium"
}, {
"id": "Communication.subject",
"max": "0",
"path": "Communication.subject"
}, {
"id": "Communication.subject.reference",
"max": "0",
"path": "Communication.subject.reference"
}, {
"id": "Communication.subject.type",
"max": "0",
"path": "Communication.subject.type"
}, {
"id": "Communication.subject.identifier",
"max": "0",
"path": "Communication.subject.identifier"
}, {
"id": "Communication.subject.display",
"max": "0",
"path": "Communication.subject.display"
}, {
"id": "Communication.topic",
"max": "0",
"path": "Communication.topic"
}, {
"id": "Communication.about",
"max": "0",
"path": "Communication.about"
}, {
"id": "Communication.about.reference",
"max": "0",
"path": "Communication.about.reference"
}, {
"id": "Communication.about.type",
"max": "0",
"path": "Communication.about.type"
}, {
"id": "Communication.about.identifier",
"max": "0",
"path": "Communication.about.identifier"
}, {
"id": "Communication.about.display",
"max": "0",
"path": "Communication.about.display"
}, {
"id": "Communication.encounter",
"max": "0",
"path": "Communication.encounter"
}, {
"id": "Communication.sent",
"path": "Communication.sent",
"definition": "#### **_`FOR SADIE USE: If SADIE is doing the sending then this is populated otherwise it is null`_**\n\nThe time when this communication was sent."
}, {
"id": "Communication.received",
"path": "Communication.received",
"definition": "#### **_`FOR SADIE USE: If SADIE is doing the receiving then this is populated otherwise it is null`_**\n\nThe time when this communication arrived at the destination."
}, {
"id": "Communication.recipient",
"max": "1",
"min": 1,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://health.gov.on.ca/sadie/fhir/StructureDefinition/ProgramArea" ]
} ],
"definition": "#### **_`FOR SADIE USE: If SADIE doing the sending then the reference will be populated with a reference to the Program Area and display will be populated with the Program Area identifier code. If SADIE is receiving then the reference is null and the display = SADIE`_**\n\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)."
}, {
"id": "Communication.recipient.type",
"max": "0",
"path": "Communication.recipient.type"
}, {
"id": "Communication.recipient.identifier",
"max": "0",
"path": "Communication.recipient.identifier"
}, {
"id": "Communication.sender",
"min": 1,
"path": "Communication.sender",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://health.gov.on.ca/sadie/fhir/StructureDefinition/ProgramArea" ]
} ],
"definition": "#### **_`FOR SADIE USE: If SADIE doing the receiving then the reference will be populated with a reference to the Program Area and display will be populated with the Program Area identifier code. If SADIE is sending then the reference is null and the display = SADIE`_**\n\nThe entity (e.g. person, organization, clinical information system, or device) which was the source of the communication."
}, {
"id": "Communication.sender.type",
"max": "0",
"path": "Communication.sender.type"
}, {
"id": "Communication.sender.identifier",
"max": "0",
"path": "Communication.sender.identifier"
}, {
"id": "Communication.reasonCode",
"max": "0",
"path": "Communication.reasonCode"
}, {
"id": "Communication.reasonReference",
"max": "0",
"path": "Communication.reasonReference"
}, {
"id": "Communication.payload",
"path": "Communication.payload",
"definition": "#### **_`FOR SADIE USE: Any documents will be stored as a contentAttachment. If a contentAttachment is present the UI will display a download button so the user can download and view the document`_**\n\nText, attachment(s), or resource(s) that was communicated to the recipient."
}, {
"id": "Communication.payload.content[x]",
"path": "Communication.payload.content[x]",
"definition": "contentAttachment\n\nA communicated content (or for multi-part communications, one portion of the communication)."
}, {
"id": "Communication.note",
"path": "Communication.note",
"definition": "#### **_`FOR SADIE USE: This is a description of what the client asked to be changed. Example: (Custom Status = 'Processed', Request Status = 'Completed') This will appear on the UI under Communication History`_**\n\nAdditional notes or commentary about the communication by the sender, receiver or other interested parties."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Communication"
}