{ "description": "An 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.", "_filename": "Communication.json", "package_name": "hl7.fhir.r4.id.core", "date": "2019-11-01T09:29:23+11:00", "derivation": "specialization", "meta": { "lastUpdated": "2022-01-10T05:34:10.979+00:00" }, "publisher": "Health Level Seven International (Patient Care)", "fhirVersion": "4.0.1", "name": "Communication", "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": null, "package_version": "0.1.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Clinical.Request & Response" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pc" } ], "status": "draft", "id": "42fb545b-a80e-4db8-8092-066c005e1ce8", "kind": "resource", "url": "https://fhir.kemkes.go.id/r4/StructureDefinition/Communication", "version": "4.0.1", "differential": { "element": [ { "id": "Communication", "path": "Communication", "short": "A record of information transmitted from a sender to a receiver", "mapping": [ { "map": "Event", "identity": "workflow" } ], "definition": "An 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." }, { "path": "Communication.identifier", "requirements": "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.", "definition": "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "short": "Unique identifier", "mapping": [ { "map": "Event.identifier", "identity": "workflow" }, { "map": "FiveWs.identifier", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "id": "Communication.identifier", "comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.", "isSummary": true }, { "id": "Communication.instantiatesCanonical", "path": "Communication.instantiatesCanonical", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire" ] } ], "short": "Instantiates FHIR protocol or definition", "mapping": [ { "map": "Event.instantiatesCanonical", "identity": "workflow" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "isSummary": true, "definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." }, { "id": "Communication.instantiatesUri", "path": "Communication.instantiatesUri", "type": [ { "code": "uri" } ], "short": "Instantiates external protocol or definition", "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "mapping": [ { "map": "Event.instantiatesUri", "identity": "workflow" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "isSummary": true, "definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." }, { "path": "Communication.basedOn", "definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.", "short": "Request fulfilled by this communication", "mapping": [ { "map": "Event.basedOn", "identity": "workflow" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "alias": [ "fulfills" ], "id": "Communication.basedOn", "comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.", "isSummary": true }, { "id": "Communication.partOf", "path": "Communication.partOf", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "alias": [ "container" ], "short": "Part of this action", "mapping": [ { "map": "Event.partOf", "identity": "workflow" } ], "isSummary": true, "definition": "Part of this action." }, { "id": "Communication.inResponseTo", "path": "Communication.inResponseTo", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Communication" ] } ], "short": "Reply to", "definition": "Prior communication that this communication is in response to." }, { "path": "Communication.status", "min": 1, "definition": "The status of the transmission.", "isModifier": true, "short": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "mapping": [ { "map": "Event.status", "identity": "workflow" }, { "map": "FiveWs.status", "identity": "w5" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/event-status|4.0.1", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationStatus" } ], "description": "The status of the communication." }, "max": "1", "id": "Communication.status", "comment": "This element is labeled as a modifier because the status contains the codes aborted and entered-in-error that mark the communication as not currently valid.", "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true }, { "path": "Communication.statusReason", "definition": "Captures the reason for the current state of the Communication.", "short": "Reason for current status", "mapping": [ { "map": "Event.statusReason", "identity": "workflow" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/communication-not-done-reason", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationNotDoneReason" } ], "description": "Codes for the reason why a communication did not happen." }, "alias": [ "Suspended Reason", "Cancelled Reason" ], "max": "1", "id": "Communication.statusReason", "comment": "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.", "isSummary": true }, { "id": "Communication.category", "path": "Communication.category", "type": [ { "code": "CodeableConcept" } ], "short": "Message category", "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/communication-category", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationCategory" } ], "description": "Codes for general categories of communications such as alerts, instructions, etc." }, "comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.", "mapping": [ { "map": "FiveWs.class", "identity": "w5" } ], "definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc." }, { "path": "Communication.priority", "definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.", "short": "routine | urgent | asap | stat", "mapping": [ { "map": "FiveWs.grade", "identity": "w5" } ], "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this communication should be treated with normal priority", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationPriority" } ], "description": "Codes indicating the relative importance of a communication." }, "max": "1", "id": "Communication.priority", "comment": "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.", "isSummary": true }, { "id": "Communication.medium", "path": "Communication.medium", "type": [ { "code": "CodeableConcept" } ], "short": "A channel of communication", "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationMode", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationMedium" } ], "description": "Codes for communication mediums such as phone, fax, email, in person, etc." }, "definition": "A channel that was used for this communication (e.g. email, fax)." }, { "path": "Communication.subject", "definition": "The patient or group that was the focus of this communication.", "short": "Focus of message", "mapping": [ { "map": "Event.subject", "identity": "workflow" }, { "map": "FiveWs.subject[x]", "identity": "w5" }, { "map": "FiveWs.subject", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "alias": [ "patient" ], "max": "1", "id": "Communication.subject", "isSummary": true }, { "path": "Communication.topic", "definition": "Description of the purpose/content, similar to a subject line in an email.", "short": "Description of the purpose/content", "mapping": [ { "map": "FiveWs.context", "identity": "w5" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/communication-topic", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationTopic" } ], "description": "Codes describing the purpose or content of the communication." }, "max": "1", "id": "Communication.topic", "comment": "Communication.topic.text can be used without any codings." }, { "id": "Communication.about", "path": "Communication.about", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "short": "Resources that pertain to this communication", "comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.", "mapping": [ { "map": "FiveWs.context", "identity": "w5" } ], "definition": "Other resources that pertain to this communication and to which this communication should be associated." }, { "path": "Communication.encounter", "definition": "The Encounter during which this Communication was created or to which the creation of this record is tightly associated.", "short": "Encounter created as part of", "mapping": [ { "map": "Event.context", "identity": "workflow" }, { "map": "FiveWs.context", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "max": "1", "id": "Communication.encounter", "comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.", "isSummary": true }, { "id": "Communication.sent", "max": "1", "path": "Communication.sent", "type": [ { "code": "dateTime" } ], "short": "When sent", "mapping": [ { "map": "Event.occurrence[x] {Invariant: maps to period.start}", "identity": "workflow" }, { "map": "FiveWs.done[x]", "identity": "w5" } ], "definition": "The time when this communication was sent." }, { "id": "Communication.received", "max": "1", "path": "Communication.received", "type": [ { "code": "dateTime" } ], "short": "When received", "mapping": [ { "map": "Event.occurrence[x] {Invariant: maps to period.end}", "identity": "workflow" }, { "map": "FiveWs.done[x]", "identity": "w5" } ], "definition": "The time when this communication arrived at the destination." }, { "id": "Communication.recipient", "path": "Communication.recipient", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "short": "Message recipient", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" } ], "definition": "The 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": "1", "path": "Communication.sender", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "short": "Message sender", "mapping": [ { "map": "Event.performer.actor", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" } ], "definition": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication." }, { "path": "Communication.reasonCode", "definition": "The reason or justification for the communication.", "short": "Indication for message", "mapping": [ { "map": "Event.reasonCode", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": ".reasonCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationReason" } ], "description": "Codes for describing reasons for the occurrence of a communication." }, "id": "Communication.reasonCode", "comment": "Textual reasons can be captured using reasonCode.text.", "isSummary": true }, { "id": "Communication.reasonReference", "path": "Communication.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ] } ], "short": "Why was communication done?", "mapping": [ { "map": "Event.reasonReference", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": ".outboundRelationship[typeCode=RSON].target", "identity": "rim" } ], "isSummary": true, "definition": "Indicates another resource whose existence justifies this communication." }, { "id": "Communication.payload", "path": "Communication.payload", "type": [ { "code": "BackboneElement" } ], "short": "Message payload", "definition": "Text, attachment(s), or resource(s) that was communicated to the recipient." }, { "id": "Communication.payload.content[x]", "max": "1", "min": 1, "path": "Communication.payload.content[x]", "type": [ { "code": "string" }, { "code": "Attachment" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "short": "Message part content", "definition": "A communicated content (or for multi-part communications, one portion of the communication)." }, { "id": "Communication.note", "path": "Communication.note", "type": [ { "code": "Annotation" } ], "short": "Comments made about the communication", "mapping": [ { "map": "Event.note", "identity": "workflow" } ], "definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties." } ] }, "contact": [ { "telecom": [ { "value": "http://hl7.org/fhir", "system": "url" } ] }, { "telecom": [ { "value": "http://www.hl7.org/Special/committees/patientcare/index.cfm", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource" }