FHIR Release 3 (STU)
AdministrationThis page is part of the FHIR Specification (v3.0.2: STU 3). 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": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"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": "2019-10-24T11:53:00+11: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": "Base StructureDefinition for Communication Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"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": "*",
"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",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "com-1",
"severity": "error",
"human": "Not Done Reason can only be specified if NotDone is \"true\"",
"expression": "notDone or notDoneReason.exists().not()",
"xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "w5",
"map": "workflow.encounter"
}
]
},
{
"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"
}
],
"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 may 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"
}
],
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"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"
}
],
"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.",
"valueSetReference": {
"reference": "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 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.",
"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"
],
"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"
}
],
"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. 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.",
"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"
}
],
"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. 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.",
"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,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Communication.identifier",
"path": "Communication.identifier",
"short": "Unique identifier",
"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).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Communication.definition",
"path": "Communication.definition",
"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": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.definition"
}
]
},
{
"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, ReferralRequest, 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.status",
"path": "Communication.status",
"short": "preparation | in-progress | 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,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
}
],
"strength": "required",
"description": "The status of the communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Communication.notDone",
"path": "Communication.notDone",
"short": "Communication did not occur",
"definition": "If true, indicates that the described communication event did not actually occur.",
"comment": "This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.",
"requirements": "Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.notDone"
}
]
},
{
"id": "Communication.notDoneReason",
"path": "Communication.notDoneReason",
"short": "Why communication did not occur",
"definition": "Describes why the communication event did not occur in coded and/or textual form.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"com-1"
],
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.notDoneReason"
}
]
},
{
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"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.",
"valueSetReference": {
"reference": "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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Communication.recipient",
"path": "Communication.recipient",
"short": "Message recipient",
"definition": "The entity (e.g. person, organization, clinical information system, 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"
},
{
"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/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Communication.topic",
"path": "Communication.topic",
"short": "Focal resources",
"definition": "The resources which were responsible for or related to producing this communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "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.occurrenceDateTime (Invariant: maps to either sent OR received)"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"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.occurrenceDateTime (Invariant: maps to either sent OR received)"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"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"
},
{
"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/RelatedPerson"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "Communication.reasonCode",
"path": "Communication.reasonCode",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"comment": "Textual reasons can be caprued 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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCodableConcept"
},
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"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"
}
],
"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"
}
]
},
{
"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"
}
],
"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. 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.",
"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"
}
],
"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 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.",
"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,
"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",
"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"
}
]
}
]
},
"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": "*",
"constraint": [
{
"key": "com-1",
"severity": "error",
"human": "Not Done Reason can only be specified if NotDone is \"true\"",
"expression": "notDone or notDoneReason.exists().not()",
"xpath": "f:notDone/@value=true() or not(exists(f:notDoneReason))"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "w5",
"map": "workflow.encounter"
}
]
},
{
"id": "Communication.identifier",
"path": "Communication.identifier",
"short": "Unique identifier",
"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).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Communication.definition",
"path": "Communication.definition",
"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": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.definition"
}
]
},
{
"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, ReferralRequest, 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.status",
"path": "Communication.status",
"short": "preparation | in-progress | 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,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationStatus"
}
],
"strength": "required",
"description": "The status of the communication.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Communication.notDone",
"path": "Communication.notDone",
"short": "Communication did not occur",
"definition": "If true, indicates that the described communication event did not actually occur.",
"comment": "This element is labeled as a modifier because it marks the communication as a communication that did not occur. The more attributes are populated, the more constrained the negated statement is.",
"requirements": "Creating a Communication where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.notDone"
}
]
},
{
"id": "Communication.notDoneReason",
"path": "Communication.notDoneReason",
"short": "Why communication did not occur",
"definition": "Describes why the communication event did not occur in coded and/or textual form.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"com-1"
],
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-not-done-reason"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.notDoneReason"
}
]
},
{
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"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.",
"valueSetReference": {
"reference": "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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Communication.recipient",
"path": "Communication.recipient",
"short": "Message recipient",
"definition": "The entity (e.g. person, organization, clinical information system, 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"
},
{
"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/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Communication.topic",
"path": "Communication.topic",
"short": "Focal resources",
"definition": "The resources which were responsible for or related to producing this communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "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.occurrenceDateTime (Invariant: maps to either sent OR received)"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"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.occurrenceDateTime (Invariant: maps to either sent OR received)"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"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"
},
{
"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/RelatedPerson"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "Communication.reasonCode",
"path": "Communication.reasonCode",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"comment": "Textual reasons can be caprued 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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCodableConcept"
},
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonReference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"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 Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change