{
"description": "Profile of CommunicationRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.",
"_filename": "StructureDefinition-qicore-communicationrequest.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2018-08-22T00:00:00+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven, Inc. - CQI WG",
"fhirVersion": "3.0.1",
"name": "QICore-CommunicationRequest",
"mapping": [ {
"uri": "http://www.healthit.gov/quality-data-model",
"name": "Quality Data Model",
"identity": "qdm"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "CommunicationRequest",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "3.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "CommunicationRequest",
"min": 0,
"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.",
"short": "A request for information to be sent to a receiver",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Request",
"identity": "workflow"
}, {
"map": "workflow.order",
"identity": "w5"
}, {
"map": "“Note, there is no corresponding QDM concept to CommunicationRequest.”",
"identity": "qdm"
} ],
"mustSupport": false,
"max": "*",
"id": "CommunicationRequest",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest"
}
}, {
"path": "CommunicationRequest.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "CommunicationRequest.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "CommunicationRequest.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "CommunicationRequest.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "CommunicationRequest.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CommunicationRequest.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "CommunicationRequest.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "CommunicationRequest.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "CommunicationRequest.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "CommunicationRequest.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "CommunicationRequest.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "CommunicationRequest.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"id": "3",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "CommunicationRequest.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "Agent that ordered the communication.",
"isModifier": false,
"short": "Agent that ordered the communication",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/communicationrequest-orderedBy"
} ],
"mustSupport": false,
"sliceName": "orderedBy",
"max": "1",
"id": "CommunicationRequest.extension:orderedBy",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "The practitioner who authorized the communication request, usually the same as the orderer when the orderer is a practitioner.",
"isModifier": false,
"short": "Practitioner who authorized request",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/procedurerequest-authorizedBy"
} ],
"mustSupport": false,
"sliceName": "authorizedBy",
"max": "1",
"id": "CommunicationRequest.extension:authorizedBy",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "The reason associated with the rejection of this communication request by the receiver. Applicable only if the status is rejected.",
"isModifier": false,
"short": "Reason why request was rejected",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected"
} ],
"mustSupport": false,
"sliceName": "reasonRejected",
"max": "1",
"id": "CommunicationRequest.extension:reasonRejected",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "CommunicationRequest.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "CommunicationRequest.identifier",
"min": 0,
"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.",
"short": "Unique identifier",
"mapping": [ {
"map": "Request.identifier",
"identity": "workflow"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "CommunicationRequest.identifier",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.identifier"
},
"isSummary": true
}, {
"path": "CommunicationRequest.basedOn",
"requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"min": 0,
"definition": "A plan or proposal that is fulfilled in whole or in part by this request.",
"short": "Fulfills plan or proposal",
"mapping": [ {
"map": "Request.basedOn",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"alias": [ "fulfills" ],
"max": "*",
"id": "CommunicationRequest.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.basedOn"
},
"isSummary": true
}, {
"path": "CommunicationRequest.replaces",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"min": 0,
"definition": "Completed or terminated request(s) whose function is taken by this new request.",
"short": "Request(s) replaced by this request",
"mapping": [ {
"map": "Request.replaces",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RPLC].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
} ],
"alias": [ "supersedes", "prior" ],
"max": "*",
"id": "CommunicationRequest.replaces",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.replaces"
},
"isSummary": true
}, {
"path": "CommunicationRequest.groupIdentifier",
"min": 0,
"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.",
"short": "Composite request this is part of",
"mapping": [ {
"map": "Request.groupIdentifier",
"identity": "workflow"
}, {
"map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"alias": [ "grouperId" ],
"max": "1",
"id": "CommunicationRequest.groupIdentifier",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.groupIdentifier"
},
"isSummary": true
}, {
"path": "CommunicationRequest.status",
"min": 1,
"definition": "The status of the proposal or order.",
"isModifier": true,
"short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"mapping": [ {
"map": "Request.status",
"identity": "workflow"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Codes identifying the stage lifecycle stage of a request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"max": "1",
"id": "CommunicationRequest.status",
"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.",
"base": {
"max": "1",
"min": 1,
"path": "CommunicationRequest.status"
},
"isSummary": true
}, {
"path": "CommunicationRequest.category",
"min": 0,
"definition": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"short": "Message category",
"mapping": [ {
"map": "Request.code",
"identity": "workflow"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"max": "*",
"id": "CommunicationRequest.category",
"comment": "There may be multiple axes of categorization and one communication request may serve multiple purposes.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.category"
}
}, {
"path": "CommunicationRequest.priority",
"min": 0,
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"short": "Message urgency",
"mapping": [ {
"map": "Request.priority",
"identity": "workflow"
}, {
"map": "grade",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If missing, this task should be performed with normal priority",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CommunicationPriority"
} ],
"description": "Codes indicating the relative importance of a communication request.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-priority"
}
},
"max": "1",
"id": "CommunicationRequest.priority",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.priority"
},
"isSummary": true
}, {
"path": "CommunicationRequest.medium",
"min": 0,
"definition": "A channel that was used for this communication (e.g. email, fax).",
"short": "A channel of communication",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "A set of codes specifying the modality by which the Entity playing the Role is participating in the Act. Examples: Physically present, over the telephone, written communication. Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically. Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
"max": "*",
"id": "CommunicationRequest.medium",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.medium"
}
}, {
"path": "CommunicationRequest.subject",
"min": 0,
"definition": "The encounter or episode of care within which the communication request was created.",
"short": "Encounter or episode leading to message",
"mapping": [ {
"map": "Request.subject",
"identity": "workflow"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"mustSupport": true,
"alias": [ "patient" ],
"max": "1",
"id": "CommunicationRequest.subject",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.subject"
}
}, {
"path": "CommunicationRequest.recipient",
"min": 0,
"definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"short": "Message receipient",
"mapping": [ {
"map": "Request.performer",
"identity": "workflow"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
} ],
"mustSupport": true,
"max": "*",
"id": "CommunicationRequest.recipient",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.recipient"
}
}, {
"path": "CommunicationRequest.topic",
"min": 0,
"definition": "The resources which were related to producing this communication request.",
"short": "Focal resources",
"mapping": [ {
"map": "Request.supportingInfo",
"identity": "workflow"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "CommunicationRequest.topic",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.topic"
}
}, {
"path": "CommunicationRequest.context",
"min": 0,
"definition": "The encounter or episode of care within which the communication request was created.",
"short": "Encounter or episode leading to message",
"mapping": [ {
"map": "Request.context",
"identity": "workflow"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"mustSupport": true,
"alias": [ "encounter" ],
"max": "1",
"id": "CommunicationRequest.context",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.context"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "CommunicationRequest.payload",
"min": 0,
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"short": "Message payload",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CommunicationRequest.payload",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.payload"
}
}, {
"path": "CommunicationRequest.payload.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.payload.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CommunicationRequest.payload.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.payload.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CommunicationRequest.payload.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CommunicationRequest.payload.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "CommunicationRequest.payload.content[x]",
"min": 1,
"definition": "The communicated content (or for multi-part communications, one portion of the communication).",
"short": "Message part content",
"mapping": [ {
"map": "Request.supportingInfo IF Reference, Request.note if string; No mapping if Attachment",
"identity": "workflow"
} ],
"type": [ {
"code": "string"
}, {
"code": "Attachment"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "CommunicationRequest.payload.content[x]",
"base": {
"max": "1",
"min": 1,
"path": "CommunicationRequest.payload.content[x]"
}
}, {
"path": "CommunicationRequest.occurrence[x]",
"min": 0,
"definition": "The time when this communication is to occur.",
"short": "When scheduled",
"mapping": [ {
"map": "Request.occurrence",
"identity": "workflow"
}, {
"map": "when.planned",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"mustSupport": false,
"alias": [ "timing" ],
"max": "1",
"id": "CommunicationRequest.occurrence[x]",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.occurrence[x]"
},
"isSummary": true
}, {
"path": "CommunicationRequest.authoredOn",
"min": 0,
"definition": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.",
"short": "When request transitioned to being actionable",
"mapping": [ {
"map": "Request.authoredOn",
"identity": "workflow"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "createdOn" ],
"max": "1",
"id": "CommunicationRequest.authoredOn",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.authoredOn"
},
"isSummary": true
}, {
"path": "CommunicationRequest.sender",
"min": 0,
"definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
"short": "Message sender",
"mapping": [ {
"map": "Request.requester.agent",
"identity": "workflow"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson"
} ],
"mustSupport": true,
"max": "1",
"id": "CommunicationRequest.sender",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.sender"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "cmr-1",
"human": "onBehalfOf can only be specified if agent is practitioner or device",
"xpath": "contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))",
"source": "CommunicationRequest.requester",
"severity": "error",
"expression": "(agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()"
} ],
"path": "CommunicationRequest.requester",
"min": 0,
"definition": "The individual who initiated the request and has responsibility for its activation.",
"short": "Who/what us requesting service",
"mapping": [ {
"map": "Request.requester",
"identity": "workflow"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"alias": [ "author" ],
"max": "1",
"id": "CommunicationRequest.requester",
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.requester"
},
"isSummary": true
}, {
"path": "CommunicationRequest.requester.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CommunicationRequest.requester.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CommunicationRequest.requester.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CommunicationRequest.requester.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CommunicationRequest.requester.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CommunicationRequest.requester.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "CommunicationRequest.requester.agent",
"min": 1,
"definition": "The device, practitioner, etc. who initiated the request.",
"short": "Individual making the request",
"mapping": [ {
"map": "Request.requester.agent",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"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"
} ],
"max": "1",
"id": "CommunicationRequest.requester.agent",
"base": {
"max": "1",
"min": 1,
"path": "CommunicationRequest.requester.agent"
},
"isSummary": true
}, {
"path": "CommunicationRequest.requester.onBehalfOf",
"requirements": "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.",
"min": 0,
"definition": "The organization the device or practitioner was acting on behalf of.",
"short": "Organization agent is acting for",
"mapping": [ {
"map": "Request.requester.onBehalfOf",
"identity": "workflow"
}, {
"map": ".scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "CommunicationRequest.requester.onBehalfOf",
"condition": [ "cmr-1" ],
"base": {
"max": "1",
"min": 0,
"path": "CommunicationRequest.requester.onBehalfOf"
},
"isSummary": true
}, {
"path": "CommunicationRequest.reasonCode",
"min": 0,
"definition": "Describes why the request is being made in coded or textual form.",
"short": "Why is communication needed?",
"mapping": [ {
"map": "Request.reasonCode",
"identity": "workflow"
}, {
"map": ".reasonCode",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "A set of codes specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type \"has reason\" linking to another Act. Examples: Example reasons that might qualify for being coded in this field might be: \"routine requirement\", \"infectious disease reporting requirement\", \"on patient request\", \"required by law\".",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActReason"
}
},
"max": "*",
"id": "CommunicationRequest.reasonCode",
"comment": "Textual reasons can be caprued using reasonCode.text.",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.reasonCode"
},
"isSummary": true
}, {
"path": "CommunicationRequest.reasonReference",
"min": 0,
"definition": "Indicates another resource whose existence justifies this request.",
"short": "Why is communication needed?",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
} ],
"max": "*",
"id": "CommunicationRequest.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.reasonReference"
},
"isSummary": true
}, {
"path": "CommunicationRequest.note",
"min": 0,
"definition": "Comments made about the request by the requester, sender, recipient, subject or other participants.",
"short": "Comments made about communication request",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
}, {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "CommunicationRequest.note",
"base": {
"max": "*",
"min": 0,
"path": "CommunicationRequest.note"
}
} ]
},
"status": "draft",
"id": "f21e362d-58cc-42fb-86e4-baf3c7244bef",
"kind": "resource",
"url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-communicationrequest",
"version": "3.1.0",
"differential": {
"element": [ {
"id": "CommunicationRequest",
"path": "CommunicationRequest",
"mapping": [ {
"map": "“Note, there is no corresponding QDM concept to CommunicationRequest.”",
"identity": "qdm"
} ],
"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.",
"isModifier": false,
"mustSupport": false
}, {
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "Agent that ordered the communication.",
"isModifier": false,
"short": "Agent that ordered the communication",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/communicationrequest-orderedBy"
} ],
"mustSupport": false,
"sliceName": "orderedBy",
"max": "1",
"id": "CommunicationRequest.extension:orderedBy"
}, {
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "The practitioner who authorized the communication request, usually the same as the orderer when the orderer is a practitioner.",
"isModifier": false,
"short": "Practitioner who authorized request",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/procedurerequest-authorizedBy"
} ],
"mustSupport": false,
"sliceName": "authorizedBy",
"max": "1",
"id": "CommunicationRequest.extension:authorizedBy"
}, {
"path": "CommunicationRequest.extension",
"min": 0,
"definition": "The reason associated with the rejection of this communication request by the receiver. Applicable only if the status is rejected.",
"isModifier": false,
"short": "Reason why request was rejected",
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/communicationrequest-reasonRejected"
} ],
"mustSupport": false,
"sliceName": "reasonRejected",
"binding": {
"strength": "example",
"description": "Reason communication request was not performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/qicore/ValueSet/qicore-communication-reason-not-performed"
}
},
"max": "1",
"id": "CommunicationRequest.extension:reasonRejected"
}, {
"path": "CommunicationRequest.status",
"min": 1,
"definition": "The status of the proposal or order.",
"isModifier": false,
"short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown",
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Codes identifying the stage lifecycle stage of a request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/request-status"
}
},
"max": "1",
"id": "CommunicationRequest.status"
}, {
"path": "CommunicationRequest.category",
"min": 0,
"definition": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
"isModifier": false,
"short": "Message category",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"description": "Codes for general categories of communications such as alerts, instruction, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/communication-category"
}
},
"max": "*",
"id": "CommunicationRequest.category"
}, {
"path": "CommunicationRequest.medium",
"min": 0,
"definition": "A channel that was used for this communication (e.g. email, fax).",
"isModifier": false,
"short": "A channel of communication",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "A set of codes specifying the modality by which the Entity playing the Role is participating in the Act. Examples: Physically present, over the telephone, written communication. Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically. Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ParticipationMode"
}
},
"max": "*",
"id": "CommunicationRequest.medium"
}, {
"path": "CommunicationRequest.subject",
"min": 0,
"definition": "The encounter or episode of care within which the communication request was created.",
"isModifier": false,
"short": "Encounter or episode leading to message",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"mustSupport": true,
"max": "1",
"id": "CommunicationRequest.subject"
}, {
"path": "CommunicationRequest.recipient",
"min": 0,
"definition": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
"isModifier": false,
"short": "Message receipient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
} ],
"mustSupport": true,
"max": "*",
"id": "CommunicationRequest.recipient"
}, {
"path": "CommunicationRequest.context",
"min": 0,
"definition": "The encounter or episode of care within which the communication request was created.",
"isModifier": false,
"short": "Encounter or episode leading to message",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"mustSupport": true,
"max": "1",
"id": "CommunicationRequest.context"
}, {
"id": "CommunicationRequest.occurrence[x]",
"max": "1",
"min": 0,
"path": "CommunicationRequest.occurrence[x]",
"short": "When scheduled",
"definition": "The time when this communication is to occur.",
"isModifier": false,
"mustSupport": false
}, {
"path": "CommunicationRequest.sender",
"min": 0,
"definition": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
"isModifier": false,
"short": "Message sender",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson"
} ],
"mustSupport": true,
"max": "1",
"id": "CommunicationRequest.sender"
}, {
"path": "CommunicationRequest.requester",
"min": 0,
"definition": "The individual who initiated the request and has responsibility for its activation.",
"isModifier": false,
"short": "Who/what us requesting service",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "CommunicationRequest.requester"
}, {
"path": "CommunicationRequest.reasonCode",
"min": 0,
"definition": "Describes why the request is being made in coded or textual form.",
"isModifier": false,
"short": "Why is communication needed?",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"description": "A set of codes specifying the motivation, cause, or rationale of an Act, when such rationale is not reasonably represented as an ActRelationship of type \"has reason\" linking to another Act. Examples: Example reasons that might qualify for being coded in this field might be: \"routine requirement\", \"infectious disease reporting requirement\", \"on patient request\", \"required by law\".",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActReason"
}
},
"max": "*",
"id": "CommunicationRequest.reasonCode"
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/special/committees/CQI",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}