R4 Ballot #1 (Mixed Normative/Trial use)
AdministrationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Patient Care Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
StructureDefinition for communication
{
"resourceType": "StructureDefinition",
"id": "Communication",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Communication",
"name": "Communication",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"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.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Communication",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Communication",
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "Communication",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"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",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
}
]
},
{
"id": "Communication.id",
"path": "Communication.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Communication.meta",
"path": "Communication.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Communication.implicitRules",
"path": "Communication.implicitRules",
"short": "A set of rules under which this content was created",
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "Communication.language",
"path": "Communication.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"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
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "Communication.text",
"path": "Communication.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Communication.contained",
"path": "Communication.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Communication.extension",
"path": "Communication.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Communication.modifierExtension",
"path": "Communication.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Communication.identifier",
"path": "Communication.identifier",
"short": "Unique identifier",
"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.",
"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.",
"requirements": "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "Communication.instantiates",
"path": "Communication.instantiates",
"short": "Instantiates protocol or definition",
"definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.instantiates",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.instantiates"
}
]
},
{
"id": "Communication.basedOn",
"path": "Communication.basedOn",
"short": "Request fulfilled by this communication",
"definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"alias": [
"fulfills"
],
"min": 0,
"max": "*",
"base": {
"path": "Communication.basedOn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.basedOn"
}
]
},
{
"id": "Communication.partOf",
"path": "Communication.partOf",
"short": "Part of this action",
"definition": "Part of this action.",
"alias": [
"container"
],
"min": 0,
"max": "*",
"base": {
"path": "Communication.partOf",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.partOf"
}
]
},
{
"id": "Communication.inResponseTo",
"path": "Communication.inResponseTo",
"short": "Reply to",
"definition": "Prior communication that this communication is in response to.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.inResponseTo",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Communication"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Communication.status",
"path": "Communication.status",
"short": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error",
"definition": "The status of the transmission.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Communication.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"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,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
}
],
"strength": "required",
"description": "The status of the communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/event-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "Communication.statusReason",
"path": "Communication.statusReason",
"short": "Reason for current status",
"definition": "Captures the reason for the current state of the Communication.",
"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.",
"alias": [
"Suspended Reason",
"Cancelled Reason"
],
"min": 0,
"max": "1",
"base": {
"path": "Communication.statusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
}
],
"strength": "example",
"description": "Codes for the reason why a communication was not done.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.statusReason"
}
]
},
{
"id": "Communication.category",
"path": "Communication.category",
"short": "Message category",
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
}
],
"strength": "example",
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "Communication.priority",
"path": "Communication.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"comment": "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.",
"min": 0,
"max": "1",
"base": {
"path": "Communication.priority",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"meaningWhenMissing": "If missing, this communication should be treated with normal priority",
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
}
],
"strength": "required",
"description": "Codes indicating the relative importance of a communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/request-priority"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.grade"
}
]
},
{
"id": "Communication.medium",
"path": "Communication.medium",
"short": "A channel of communication",
"definition": "A channel that was used for this communication (e.g. email, fax).",
"min": 0,
"max": "*",
"base": {
"path": "Communication.medium",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
}
],
"strength": "example",
"description": "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
{
"id": "Communication.subject",
"path": "Communication.subject",
"short": "Focus of message",
"definition": "The patient or group that was the focus of this communication.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"base": {
"path": "Communication.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "Communication.recipient",
"path": "Communication.recipient",
"short": "Message recipient",
"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).",
"min": 0,
"max": "*",
"base": {
"path": "Communication.recipient",
"min": 0,
"max": "*"
},
"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"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "Communication.topic",
"path": "Communication.topic",
"short": "Description of the purpose/content",
"definition": "Description of the purpose/content, similar to a subject line in an email.",
"comment": "Communication.topic.text can be used without any codings.",
"min": 0,
"max": "1",
"base": {
"path": "Communication.topic",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationTopic"
}
],
"strength": "example",
"description": "Codes describing the purpose or content of the communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-topic"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.about",
"path": "Communication.about",
"short": "Resources that pertain to this communication",
"definition": "Other resources that pertain to this communication and to which this communication should be associated.",
"comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.about",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.context",
"path": "Communication.context",
"short": "Encounter or episode leading to message",
"definition": "The encounter within which the communication was sent.",
"alias": [
"encounter"
],
"min": 0,
"max": "1",
"base": {
"path": "Communication.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.sent",
"path": "Communication.sent",
"short": "When sent",
"definition": "The time when this communication was sent.",
"min": 0,
"max": "1",
"base": {
"path": "Communication.sent",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x] {Invariant: maps to period.start}"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
}
]
},
{
"id": "Communication.received",
"path": "Communication.received",
"short": "When received",
"definition": "The time when this communication arrived at the destination.",
"min": 0,
"max": "1",
"base": {
"path": "Communication.received",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x] {Invariant: maps to period.end}"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
}
]
},
{
"id": "Communication.sender",
"path": "Communication.sender",
"short": "Message sender",
"definition": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.",
"min": 0,
"max": "1",
"base": {
"path": "Communication.sender",
"min": 0,
"max": "1"
},
"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"
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "w5",
"map": "FiveWs.actor"
}
]
},
{
"id": "Communication.reasonCode",
"path": "Communication.reasonCode",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"comment": "Textual reasons can be captured using reasonCode.text.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
}
],
"strength": "example",
"description": "Codes for describing reasons for the occurrence of a communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "Communication.reasonReference",
"path": "Communication.reasonReference",
"short": "Why was communication done?",
"definition": "Indicates another resource whose existence justifies this communication.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.reasonReference",
"min": 0,
"max": "*"
},
"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"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "Communication.payload",
"path": "Communication.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.payload",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Communication.payload.id",
"path": "Communication.payload.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Communication.payload.extension",
"path": "Communication.payload.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Communication.payload.modifierExtension",
"path": "Communication.payload.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Communication.payload.content[x]",
"path": "Communication.payload.content[x]",
"short": "Message part content",
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"min": 1,
"max": "1",
"base": {
"path": "Communication.payload.content[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Communication.note",
"path": "Communication.note",
"short": "Comments made about the communication",
"definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"min": 0,
"max": "*",
"base": {
"path": "Communication.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Communication",
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"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.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Event"
}
]
},
{
"id": "Communication.identifier",
"path": "Communication.identifier",
"short": "Unique identifier",
"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.",
"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.",
"requirements": "Allows identification of the communication as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "Communication.instantiates",
"path": "Communication.instantiates",
"short": "Instantiates protocol or definition",
"definition": "A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.instantiates"
}
]
},
{
"id": "Communication.basedOn",
"path": "Communication.basedOn",
"short": "Request fulfilled by this communication",
"definition": "An order, proposal or plan fulfilled in whole or in part by this Communication.",
"comment": "This must point to some sort of a 'Request' resource, such as CarePlan, CommunicationRequest, ServiceRequest, MedicationRequest, etc.",
"alias": [
"fulfills"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.basedOn"
}
]
},
{
"id": "Communication.partOf",
"path": "Communication.partOf",
"short": "Part of this action",
"definition": "Part of this action.",
"alias": [
"container"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.partOf"
}
]
},
{
"id": "Communication.inResponseTo",
"path": "Communication.inResponseTo",
"short": "Reply to",
"definition": "Prior communication that this communication is in response to.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Communication"
]
}
]
},
{
"id": "Communication.status",
"path": "Communication.status",
"short": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error",
"definition": "The status of the transmission.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"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,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
}
],
"strength": "required",
"description": "The status of the communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/event-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "Communication.statusReason",
"path": "Communication.statusReason",
"short": "Reason for current status",
"definition": "Captures the reason for the current state of the Communication.",
"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.",
"alias": [
"Suspended Reason",
"Cancelled Reason"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationNotDoneReason"
}
],
"strength": "example",
"description": "Codes for the reason why a communication was not done.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.statusReason"
}
]
},
{
"id": "Communication.category",
"path": "Communication.category",
"short": "Message category",
"definition": "The type of message conveyed such as alert, notification, reminder, instruction, etc.",
"comment": "There may be multiple axes of categorization and one communication may serve multiple purposes.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationCategory"
}
],
"strength": "example",
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-category"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "Communication.priority",
"path": "Communication.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.",
"comment": "Used to prioritize workflow (such as which communication to read first) when the communication is planned or in progress.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"meaningWhenMissing": "If missing, this communication should be treated with normal priority",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
}
],
"strength": "required",
"description": "Codes indicating the relative importance of a communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/request-priority"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.grade"
}
]
},
{
"id": "Communication.medium",
"path": "Communication.medium",
"short": "A channel of communication",
"definition": "A channel that was used for this communication (e.g. email, fax).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationMedium"
}
],
"strength": "example",
"description": "Codes for communication mediums such as phone, fax, email, in person, etc.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
{
"id": "Communication.subject",
"path": "Communication.subject",
"short": "Focus of message",
"definition": "The patient or group that was the focus of this communication.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "Communication.recipient",
"path": "Communication.recipient",
"short": "Message recipient",
"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).",
"min": 0,
"max": "*",
"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"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "Communication.topic",
"path": "Communication.topic",
"short": "Description of the purpose/content",
"definition": "Description of the purpose/content, similar to a subject line in an email.",
"comment": "Communication.topic.text can be used without any codings.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationTopic"
}
],
"strength": "example",
"description": "Codes describing the purpose or content of the communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/communication-topic"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.about",
"path": "Communication.about",
"short": "Resources that pertain to this communication",
"definition": "Other resources that pertain to this communication and to which this communication should be associated.",
"comment": "Don't use Communication.about element when a more specific element exists, such as basedOn or reasonReference.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.context",
"path": "Communication.context",
"short": "Encounter or episode leading to message",
"definition": "The encounter within which the communication was sent.",
"alias": [
"encounter"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
}
]
},
{
"id": "Communication.sent",
"path": "Communication.sent",
"short": "When sent",
"definition": "The time when this communication was sent.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x] {Invariant: maps to period.start}"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
}
]
},
{
"id": "Communication.received",
"path": "Communication.received",
"short": "When received",
"definition": "The time when this communication arrived at the destination.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x] {Invariant: maps to period.end}"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
}
]
},
{
"id": "Communication.sender",
"path": "Communication.sender",
"short": "Message sender",
"definition": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.",
"min": 0,
"max": "1",
"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"
]
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "w5",
"map": "FiveWs.actor"
}
]
},
{
"id": "Communication.reasonCode",
"path": "Communication.reasonCode",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"comment": "Textual reasons can be captured using reasonCode.text.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationReason"
}
],
"strength": "example",
"description": "Codes for describing reasons for the occurrence of a communication.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "Communication.reasonReference",
"path": "Communication.reasonReference",
"short": "Why was communication done?",
"definition": "Indicates another resource whose existence justifies this communication.",
"min": 0,
"max": "*",
"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"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"id": "Communication.payload",
"path": "Communication.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) that was communicated to the recipient.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Communication.payload.content[x]",
"path": "Communication.payload.content[x]",
"short": "Message part content",
"definition": "A communicated content (or for multi-part communications, one portion of the communication).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
]
},
{
"id": "Communication.note",
"path": "Communication.note",
"short": "Comments made about the communication",
"definition": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:14+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change