R4 Draft for Comment
AdministrationThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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 communicationrequest
{
"resourceType": "StructureDefinition",
"id": "CommunicationRequest",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+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/CommunicationRequest",
"name": "CommunicationRequest",
"status": "draft",
"date": "2017-12-20T15:52:34+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": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"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": "CommunicationRequest",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "CommunicationRequest",
"path": "CommunicationRequest",
"short": "A request for information to be sent to a receiver",
"definition": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be 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 or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "w5",
"map": "workflow.order"
}
]
},
{
"id": "CommunicationRequest.id",
"path": "CommunicationRequest.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": "CommunicationRequest.meta",
"path": "CommunicationRequest.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"
}
],
"isSummary": true
},
{
"id": "CommunicationRequest.implicitRules",
"path": "CommunicationRequest.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": "CommunicationRequest.language",
"path": "CommunicationRequest.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": "CommunicationRequest.text",
"path": "CommunicationRequest.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": "CommunicationRequest.contained",
"path": "CommunicationRequest.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": "CommunicationRequest.extension",
"path": "CommunicationRequest.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": "CommunicationRequest.modifierExtension",
"path": "CommunicationRequest.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": "CommunicationRequest.identifier",
"path": "CommunicationRequest.identifier",
"short": "Unique identifier",
"definition": "A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "CommunicationRequest.basedOn",
"path": "CommunicationRequest.basedOn",
"short": "Fulfills plan or proposal",
"definition": "A plan or proposal that is fulfilled in whole or in part by this request.",
"requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias": [
"fulfills"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.basedOn"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"id": "CommunicationRequest.replaces",
"path": "CommunicationRequest.replaces",
"short": "Request(s) replaced by this request",
"definition": "Completed or terminated request(s) whose function is taken by this new request.",
"comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias": [
"supersedes",
"prior"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.replaces"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RPLC].target"
}
]
},
{
"id": "CommunicationRequest.groupIdentifier",
"path": "CommunicationRequest.groupIdentifier",
"short": "Composite request this is part of",
"definition": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment": "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"alias": [
"grouperId"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.groupIdentifier"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}
]
},
{
"id": "CommunicationRequest.status",
"path": "CommunicationRequest.status",
"short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"definition": "The status of the proposal or order.",
"comment": "This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request 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": "CommunicationRequestStatus"
}
],
"strength": "required",
"description": "The status of the communication request.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CommunicationRequest.category",
"path": "CommunicationRequest.category",
"short": "Message category",
"definition": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"comment": "There may be multiple axes of categorization and one communication request 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": "Request.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "CommunicationRequest.priority",
"path": "CommunicationRequest.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"meaningWhenMissing": "If missing, this task should be performed 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 request.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.priority"
},
{
"identity": "w5",
"map": "FiveWs.grade"
},
{
"identity": "w5",
"map": "grade"
}
]
},
{
"id": "CommunicationRequest.medium",
"path": "CommunicationRequest.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": "CommunicationRequest.subject",
"path": "CommunicationRequest.subject",
"short": "Focus of message",
"definition": "The patient or group that is the focus of this communication request.",
"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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "CommunicationRequest.recipient",
"path": "CommunicationRequest.recipient",
"short": "Message recipient",
"definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "CommunicationRequest.about",
"path": "CommunicationRequest.about",
"short": "Resources that pertain to this communication request",
"definition": "Other resources that pertain to this communication request and to which this communication request should be associated.",
"comment": "Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CommunicationRequest.context",
"path": "CommunicationRequest.context",
"short": "Encounter or episode leading to message",
"definition": "The encounter or episode of care within which the communication request was created.",
"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": "Request.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CommunicationRequest.payload",
"path": "CommunicationRequest.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be 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": "CommunicationRequest.payload.id",
"path": "CommunicationRequest.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": "CommunicationRequest.payload.extension",
"path": "CommunicationRequest.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": "CommunicationRequest.payload.modifierExtension",
"path": "CommunicationRequest.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": "CommunicationRequest.payload.content[x]",
"path": "CommunicationRequest.payload.content[x]",
"short": "Message part content",
"definition": "The 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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo, Request.note {supportingInfo if Reference, note if string, No mapping if Attachment}"
}
]
},
{
"id": "CommunicationRequest.occurrence[x]",
"path": "CommunicationRequest.occurrence[x]",
"short": "When scheduled",
"definition": "The time when this communication is to occur.",
"alias": [
"timing"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.planned"
},
{
"identity": "w5",
"map": "when.planned"
}
]
},
{
"id": "CommunicationRequest.authoredOn",
"path": "CommunicationRequest.authoredOn",
"short": "When request transitioned to being actionable",
"definition": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"alias": [
"createdOn"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "CommunicationRequest.requester",
"path": "CommunicationRequest.requester",
"short": "Who/what is requesting service",
"definition": "The device, individual, or organization who initiated the request and has responsibility for its activation.",
"alias": [
"author"
],
"min": 0,
"max": "1",
"type": [
{
"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/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.requester"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "CommunicationRequest.sender",
"path": "CommunicationRequest.sender",
"short": "Message sender",
"definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be 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/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
},
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "CommunicationRequest.reasonCode",
"path": "CommunicationRequest.reasonCode",
"short": "Why is communication needed?",
"definition": "Describes why the request is being made in coded or textual form.",
"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/v3-ActReason"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CommunicationRequest.reasonReference",
"path": "CommunicationRequest.reasonReference",
"short": "Why is communication needed?",
"definition": "Indicates another resource whose existence justifies this request.",
"min": 0,
"max": "*",
"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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CommunicationRequest.note",
"path": "CommunicationRequest.note",
"short": "Comments made about communication request",
"definition": "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.note"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "CommunicationRequest",
"path": "CommunicationRequest",
"short": "A request for information to be sent to a receiver",
"definition": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "w5",
"map": "workflow.order"
}
]
},
{
"id": "CommunicationRequest.identifier",
"path": "CommunicationRequest.identifier",
"short": "Unique identifier",
"definition": "A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "CommunicationRequest.basedOn",
"path": "CommunicationRequest.basedOn",
"short": "Fulfills plan or proposal",
"definition": "A plan or proposal that is fulfilled in whole or in part by this request.",
"requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias": [
"fulfills"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.basedOn"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"id": "CommunicationRequest.replaces",
"path": "CommunicationRequest.replaces",
"short": "Request(s) replaced by this request",
"definition": "Completed or terminated request(s) whose function is taken by this new request.",
"comment": "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias": [
"supersedes",
"prior"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.replaces"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RPLC].target"
}
]
},
{
"id": "CommunicationRequest.groupIdentifier",
"path": "CommunicationRequest.groupIdentifier",
"short": "Composite request this is part of",
"definition": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment": "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"alias": [
"grouperId"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.groupIdentifier"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}
]
},
{
"id": "CommunicationRequest.status",
"path": "CommunicationRequest.status",
"short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"definition": "The status of the proposal or order.",
"comment": "This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request 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": "CommunicationRequestStatus"
}
],
"strength": "required",
"description": "The status of the communication request.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CommunicationRequest.category",
"path": "CommunicationRequest.category",
"short": "Message category",
"definition": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"comment": "There may be multiple axes of categorization and one communication request 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": "Request.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "CommunicationRequest.priority",
"path": "CommunicationRequest.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"meaningWhenMissing": "If missing, this task should be performed 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 request.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.priority"
},
{
"identity": "w5",
"map": "FiveWs.grade"
},
{
"identity": "w5",
"map": "grade"
}
]
},
{
"id": "CommunicationRequest.medium",
"path": "CommunicationRequest.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": "CommunicationRequest.subject",
"path": "CommunicationRequest.subject",
"short": "Focus of message",
"definition": "The patient or group that is the focus of this communication request.",
"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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "CommunicationRequest.recipient",
"path": "CommunicationRequest.recipient",
"short": "Message recipient",
"definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "CommunicationRequest.about",
"path": "CommunicationRequest.about",
"short": "Resources that pertain to this communication request",
"definition": "Other resources that pertain to this communication request and to which this communication request should be associated.",
"comment": "Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CommunicationRequest.context",
"path": "CommunicationRequest.context",
"short": "Encounter or episode leading to message",
"definition": "The encounter or episode of care within which the communication request was created.",
"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": "Request.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CommunicationRequest.payload",
"path": "CommunicationRequest.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CommunicationRequest.payload.content[x]",
"path": "CommunicationRequest.payload.content[x]",
"short": "Message part content",
"definition": "The 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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo, Request.note {supportingInfo if Reference, note if string, No mapping if Attachment}"
}
]
},
{
"id": "CommunicationRequest.occurrence[x]",
"path": "CommunicationRequest.occurrence[x]",
"short": "When scheduled",
"definition": "The time when this communication is to occur.",
"alias": [
"timing"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.planned"
},
{
"identity": "w5",
"map": "when.planned"
}
]
},
{
"id": "CommunicationRequest.authoredOn",
"path": "CommunicationRequest.authoredOn",
"short": "When request transitioned to being actionable",
"definition": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"alias": [
"createdOn"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "CommunicationRequest.requester",
"path": "CommunicationRequest.requester",
"short": "Who/what is requesting service",
"definition": "The device, individual, or organization who initiated the request and has responsibility for its activation.",
"alias": [
"author"
],
"min": 0,
"max": "1",
"type": [
{
"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/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.requester"
},
{
"identity": "w5",
"map": "FiveWs.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"id": "CommunicationRequest.sender",
"path": "CommunicationRequest.sender",
"short": "Message sender",
"definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be 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/PractitionerRole"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
},
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "CommunicationRequest.reasonCode",
"path": "CommunicationRequest.reasonCode",
"short": "Why is communication needed?",
"definition": "Describes why the request is being made in coded or textual form.",
"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/v3-ActReason"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonCode"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".reasonCode"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CommunicationRequest.reasonReference",
"path": "CommunicationRequest.reasonReference",
"short": "Why is communication needed?",
"definition": "Indicates another resource whose existence justifies this request.",
"min": 0,
"max": "*",
"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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CommunicationRequest.note",
"path": "CommunicationRequest.note",
"short": "Comments made about communication request",
"definition": "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.note"
},
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}
]
}
]
}
}
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 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:56+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change