Structure Definition: CommunicationRequest
Status: WIP, will receive additional profile notes in the near future
Canonical URL: http://hl7.org/fhir/StructureDefinition/communicationrequest
Simplifier project page: Not Applicable
Derived from: CommunicationRequest (R4)
Module: File Exchange and Communications Module
Formal profile content
{ "resourceType": "StructureDefinition", "id": "CommunicationRequest", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Clinical.Request & Response" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pc" } ], "url": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", "version": "4.0.1", "name": "CommunicationRequest", "status": "draft", "date": "2019-11-01T09:29:23+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": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern 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": "*", "base": { "path": "CommunicationRequest", "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": "http://hl7.org/fhir/StructureDefinition/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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" } ] }, { "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": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "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. 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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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": "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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "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": "preferred", "description": "A human language.", "valueSet": "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 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 information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "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": "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. 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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "CommunicationRequest.identifier", "path": "CommunicationRequest.identifier", "short": "Unique identifier", "definition": "Business identifiers assigned to this communication request 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 request as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.basedOn", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "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": "*", "base": { "path": "CommunicationRequest.replaces", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CommunicationRequest" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "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", "base": { "path": "CommunicationRequest.groupIdentifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "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 | on-hold | revoked | completed | entered-in-error | unknown", "definition": "The status of the proposal or order.", "min": 1, "max": "1", "base": { "path": "CommunicationRequest.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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": "CommunicationRequestStatus" } ], "strength": "required", "description": "The status of the communication request.", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "FiveWs.status" } ] }, { "id": "CommunicationRequest.statusReason", "path": "CommunicationRequest.statusReason", "short": "Reason for current status", "definition": "Captures the reason for the current state of the CommunicationRequest.", "comment": "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].", "alias": [ "Suspended Reason", "Cancelled Reason" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.statusReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationRequestStatusReason" } ], "strength": "example", "description": "Codes identifying the reason for the current state of a request." }, "mapping": [ { "identity": "workflow", "map": "Request.statusReason" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.category", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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.", "valueSet": "http://hl7.org/fhir/ValueSet/communication-category" }, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ] }, { "id": "CommunicationRequest.priority", "path": "CommunicationRequest.priority", "short": "routine | urgent | asap | stat", "definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.priority", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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 request.", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" } ] }, { "id": "CommunicationRequest.doNotPerform", "path": "CommunicationRequest.doNotPerform", "short": "True if request is prohibiting action", "definition": "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.", "comment": "The attributes provided with the request qualify what is not to be done.", "alias": [ "prohibited" ], "min": 0, "max": "1", "base": { "path": "CommunicationRequest.doNotPerform", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "If do not perform is not specified, the request is a positive request e.g. \"do perform\"", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.doNotPerform" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.medium", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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.", "valueSet": "http://terminology.hl7.org/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", "base": { "path": "CommunicationRequest.subject", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.about", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" }, { "identity": "w5", "map": "FiveWs.context" } ] }, { "id": "CommunicationRequest.encounter", "path": "CommunicationRequest.encounter", "short": "Encounter created as part of", "definition": "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.", "comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.", "min": 0, "max": "1", "base": { "path": "CommunicationRequest.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "FiveWs.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": "*", "base": { "path": "CommunicationRequest.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() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false }, { "id": "CommunicationRequest.payload.id", "path": "CommunicationRequest.payload.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "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": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "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. 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" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "CommunicationRequest.payload.modifierExtension", "path": "CommunicationRequest.payload.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "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", "base": { "path": "CommunicationRequest.payload.content[x]", "min": 1, "max": "1" }, "type": [ { "code": "string" }, { "code": "Attachment" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.note" } ] }, { "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", "base": { "path": "CommunicationRequest.occurrence[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.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", "base": { "path": "CommunicationRequest.authoredOn", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "FiveWs.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", "base": { "path": "CommunicationRequest.requester", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.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", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "FiveWs.actor" } ] }, { "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", "base": { "path": "CommunicationRequest.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", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "FiveWs.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 captured using reasonCode.text.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.reasonCode", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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.", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActReason" }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "CommunicationRequest.reasonReference", "path": "CommunicationRequest.reasonReference", "short": "Why is communication needed?", "definition": "Indicates another resource whose existence justifies this request.", "min": 0, "max": "*", "base": { "path": "CommunicationRequest.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" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" } ] }, { "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": "*", "base": { "path": "CommunicationRequest.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "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" } ] }, { "id": "CommunicationRequest.identifier", "path": "CommunicationRequest.identifier", "short": "Unique identifier", "definition": "Business identifiers assigned to this communication request 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 request 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": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" } ] }, { "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 | on-hold | revoked | completed | entered-in-error | unknown", "definition": "The status of the proposal or order.", "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": "CommunicationRequestStatus" } ], "strength": "required", "description": "The status of the communication request.", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "FiveWs.status" } ] }, { "id": "CommunicationRequest.statusReason", "path": "CommunicationRequest.statusReason", "short": "Reason for current status", "definition": "Captures the reason for the current state of the CommunicationRequest.", "comment": "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].", "alias": [ "Suspended Reason", "Cancelled Reason" ], "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CommunicationRequestStatusReason" } ], "strength": "example", "description": "Codes identifying the reason for the current state of a request." }, "mapping": [ { "identity": "workflow", "map": "Request.statusReason" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" } ] }, { "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.", "valueSet": "http://hl7.org/fhir/ValueSet/communication-category" }, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ] }, { "id": "CommunicationRequest.priority", "path": "CommunicationRequest.priority", "short": "routine | urgent | asap | stat", "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.", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" } ] }, { "id": "CommunicationRequest.doNotPerform", "path": "CommunicationRequest.doNotPerform", "short": "True if request is prohibiting action", "definition": "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.", "comment": "The attributes provided with the request qualify what is not to be done.", "alias": [ "prohibited" ], "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "meaningWhenMissing": "If do not perform is not specified, the request is a positive request e.g. \"do perform\"", "isModifier": true, "isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.doNotPerform" } ] }, { "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.", "valueSet": "http://terminology.hl7.org/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", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "w5", "map": "FiveWs.subject" } ] }, { "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" } ] }, { "id": "CommunicationRequest.encounter", "path": "CommunicationRequest.encounter", "short": "Encounter created as part of", "definition": "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.", "comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "FiveWs.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.note" } ] }, { "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" } ] }, { "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" } ] }, { "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", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "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" } ] }, { "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", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "FiveWs.actor" } ] }, { "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", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "FiveWs.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 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.", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActReason" }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "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", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "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" } ] }, { "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]" } ] } ] } }
Profile usage
asdf.
Profile element notes
.status
- Required field that will represent the status of a communicationrequest