{
"description": "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.",
"_filename": "StructureDefinition-Communication.json",
"package_name": "hl7.fhir.core",
"date": "2017-12-20T15:52:34+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"publisher": "Health Level Seven International (Patient Care)",
"fhirVersion": "3.2.0",
"name": "Communication",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 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": "3.2.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
} ],
"snapshot": {
"element": [ {
"id": "Communication",
"max": "*",
"min": 0,
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "workflow.encounter",
"identity": "w5"
} ],
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())"
} ],
"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."
}, {
"path": "Communication.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Communication.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Communication.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Communication.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Communication.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Communication.implicitRules",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Communication.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Communication.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Communication.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Communication.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Communication.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Communication.contained",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Communication.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Communication.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Communication.identifier",
"min": 0,
"definition": "Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"short": "Unique identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Communication.identifier",
"isSummary": true
}, {
"path": "Communication.instantiates",
"min": 0,
"definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.",
"short": "Instantiates protocol or definition",
"mapping": [ {
"map": "Event.instantiates",
"identity": "workflow"
} ],
"type": [ {
"code": "uri"
} ],
"max": "*",
"id": "Communication.instantiates",
"isSummary": true
}, {
"path": "Communication.basedOn",
"min": 0,
"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" ],
"max": "*",
"id": "Communication.basedOn",
"comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"isSummary": true
}, {
"path": "Communication.partOf",
"min": 0,
"definition": "Part of this action.",
"short": "Part of this action",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"alias": [ "container" ],
"max": "*",
"id": "Communication.partOf",
"isSummary": true
}, {
"id": "Communication.inResponseTo",
"max": "*",
"min": 0,
"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 | suspended | aborted | completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
} ],
"description": "The status of the communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"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.",
"isSummary": true
}, {
"path": "Communication.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the Communication.",
"short": "Reason for current status",
"mapping": [ {
"map": "Event.notDoneReason",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
} ],
"description": "Codes for the reason why a communication was not done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
}
},
"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
}, {
"path": "Communication.category",
"min": 0,
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"short": "Message category",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
} ],
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"max": "*",
"id": "Communication.category",
"comment": "There may be multiple axes of categorization and one communication may serve multiple purposes."
}, {
"path": "Communication.priority",
"min": 0,
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"short": "Message urgency",
"mapping": [ {
"map": "FiveWs.grade",
"identity": "w5"
}, {
"map": "grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this communication should be treated with normal priority",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
} ],
"description": "Codes indicating the relative importance of a communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"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",
"max": "*",
"min": 0,
"path": "Communication.medium",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "A channel of communication",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
} ],
"description": "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
"definition": "A channel that was used for this communication (e.g. email, fax)."
}, {
"path": "Communication.subject",
"min": 0,
"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": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"alias": [ "patient" ],
"max": "1",
"id": "Communication.subject",
"isSummary": true
}, {
"id": "Communication.recipient",
"max": "*",
"min": 0,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
} ],
"short": "Message recipient",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "who.focus",
"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 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)."
}, {
"path": "Communication.topic",
"min": 0,
"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"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"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."
}, {
"path": "Communication.about",
"min": 0,
"definition": "Other resources that pertain to this communication and to which this communication should be associated.",
"short": "Resources that pertain to this communication",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "Communication.about",
"comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference."
}, {
"path": "Communication.context",
"min": 0,
"definition": "The encounter within which the communication was sent.",
"short": "Encounter or episode leading to message",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"alias": [ "encounter" ],
"max": "1",
"id": "Communication.context",
"isSummary": true
}, {
"id": "Communication.sent",
"max": "1",
"min": 0,
"path": "Communication.sent",
"type": [ {
"code": "dateTime"
} ],
"short": "When sent",
"mapping": [ {
"map": "Event.occurrence[x] {Invariant: maps to period.start}",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "when.init",
"identity": "w5"
} ],
"definition": "The time when this communication was sent."
}, {
"id": "Communication.received",
"max": "1",
"min": 0,
"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"
}, {
"map": "when.done",
"identity": "w5"
} ],
"definition": "The time when this communication arrived at the destination."
}, {
"id": "Communication.sender",
"max": "1",
"min": 0,
"path": "Communication.sender",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"short": "Message sender",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "who.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",
"min": 0,
"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"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
} ],
"description": "Codes for describing reasons for the occurrence of a communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"max": "*",
"id": "Communication.reasonCode",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"isSummary": true
}, {
"path": "Communication.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this communication.",
"short": "Why was communication done?",
"mapping": [ {
"map": "Event.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
} ],
"max": "*",
"id": "Communication.reasonReference",
"isSummary": true
}, {
"id": "Communication.payload",
"max": "*",
"min": 0,
"path": "Communication.payload",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Message payload",
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient."
}, {
"path": "Communication.payload.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Communication.payload.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Communication.payload.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Communication.payload.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Communication.payload.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Communication.payload.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"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",
"max": "*",
"min": 0,
"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."
} ]
},
"status": "draft",
"id": "7cefa49f-4ede-4a9e-8776-b429f7236811",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/Communication",
"version": null,
"differential": {
"element": [ {
"id": "Communication",
"max": "*",
"min": 0,
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "workflow.encounter",
"identity": "w5"
} ],
"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."
}, {
"path": "Communication.identifier",
"min": 0,
"definition": "Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"short": "Unique identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Communication.identifier",
"isSummary": true
}, {
"path": "Communication.instantiates",
"min": 0,
"definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.",
"short": "Instantiates protocol or definition",
"mapping": [ {
"map": "Event.instantiates",
"identity": "workflow"
} ],
"type": [ {
"code": "uri"
} ],
"max": "*",
"id": "Communication.instantiates",
"isSummary": true
}, {
"path": "Communication.basedOn",
"min": 0,
"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" ],
"max": "*",
"id": "Communication.basedOn",
"comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"isSummary": true
}, {
"path": "Communication.partOf",
"min": 0,
"definition": "Part of this action.",
"short": "Part of this action",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"alias": [ "container" ],
"max": "*",
"id": "Communication.partOf",
"isSummary": true
}, {
"id": "Communication.inResponseTo",
"max": "*",
"min": 0,
"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 | suspended | aborted | completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
} ],
"description": "The status of the communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"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.",
"isSummary": true
}, {
"path": "Communication.statusReason",
"min": 0,
"definition": "Captures the reason for the current state of the Communication.",
"short": "Reason for current status",
"mapping": [ {
"map": "Event.notDoneReason",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
} ],
"description": "Codes for the reason why a communication was not done.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
}
},
"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
}, {
"path": "Communication.category",
"min": 0,
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"short": "Message category",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
} ],
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"max": "*",
"id": "Communication.category",
"comment": "There may be multiple axes of categorization and one communication may serve multiple purposes."
}, {
"path": "Communication.priority",
"min": 0,
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"short": "Message urgency",
"mapping": [ {
"map": "FiveWs.grade",
"identity": "w5"
}, {
"map": "grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this communication should be treated with normal priority",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
} ],
"description": "Codes indicating the relative importance of a communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"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",
"max": "*",
"min": 0,
"path": "Communication.medium",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "A channel of communication",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
} ],
"description": "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
"definition": "A channel that was used for this communication (e.g. email, fax)."
}, {
"path": "Communication.subject",
"min": 0,
"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": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"alias": [ "patient" ],
"max": "1",
"id": "Communication.subject",
"isSummary": true
}, {
"id": "Communication.recipient",
"max": "*",
"min": 0,
"path": "Communication.recipient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
} ],
"short": "Message recipient",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "who.focus",
"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 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)."
}, {
"path": "Communication.topic",
"min": 0,
"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"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"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."
}, {
"path": "Communication.about",
"min": 0,
"definition": "Other resources that pertain to this communication and to which this communication should be associated.",
"short": "Resources that pertain to this communication",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "Communication.about",
"comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference."
}, {
"path": "Communication.context",
"min": 0,
"definition": "The encounter within which the communication was sent.",
"short": "Encounter or episode leading to message",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"alias": [ "encounter" ],
"max": "1",
"id": "Communication.context",
"isSummary": true
}, {
"id": "Communication.sent",
"max": "1",
"min": 0,
"path": "Communication.sent",
"type": [ {
"code": "dateTime"
} ],
"short": "When sent",
"mapping": [ {
"map": "Event.occurrence[x] {Invariant: maps to period.start}",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "when.init",
"identity": "w5"
} ],
"definition": "The time when this communication was sent."
}, {
"id": "Communication.received",
"max": "1",
"min": 0,
"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"
}, {
"map": "when.done",
"identity": "w5"
} ],
"definition": "The time when this communication arrived at the destination."
}, {
"id": "Communication.sender",
"max": "1",
"min": 0,
"path": "Communication.sender",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"short": "Message sender",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "who.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",
"min": 0,
"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"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
} ],
"description": "Codes for describing reasons for the occurrence of a communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"max": "*",
"id": "Communication.reasonCode",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"isSummary": true
}, {
"path": "Communication.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this communication.",
"short": "Why was communication done?",
"mapping": [ {
"map": "Event.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
} ],
"max": "*",
"id": "Communication.reasonReference",
"isSummary": true
}, {
"id": "Communication.payload",
"max": "*",
"min": 0,
"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",
"max": "*",
"min": 0,
"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"
}