{ "description": "Profile of DeviceRequest for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.", "_filename": "StructureDefinition-qicore-devicerequest.json", "package_name": "hl7.fhir.us.qicore", "date": "2019-07-11T00:00:00-04:00", "derivation": "constraint", "publisher": "Health Level Seven, Inc. - CQI WG", "fhirVersion": "4.0.0", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166", "display": "United States of America" } ] } ], "name": "QICoreDeviceRequest", "mapping": [ { "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern", "identity": "workflow" }, { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping", "identity": "w5" }, { "uri": "http://siframework.org/cqf", "name": "Quality Improvement and Clinical Knowledge (QUICK)", "identity": "quick" } ], "abstract": false, "type": "DeviceRequest", "experimental": "false", "resourceType": "StructureDefinition", "title": null, "package_version": "3.3.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-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 or SHALL refer to the containing resource", "xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "DomainResource", "severity": "error", "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()" }, { "key": "dom-6", "human": "A resource should have narrative for robust management", "xpath": "exists(f:text/h:div)", "source": "DomainResource", "severity": "warning", "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." } ], "expression": "text.div.exists()" }, { "key": "dom-5", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "DomainResource", "severity": "error", "expression": "contained.meta.security.empty()" } ], "path": "DeviceRequest", "min": 0, "definition": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.", "isModifier": false, "short": "Medical device request", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "Request", "identity": "workflow" }, { "map": "ORC", "identity": "v2" }, { "map": "Act[moodCode<=INT]", "identity": "rim" } ], "mustSupport": false, "max": "*", "id": "DeviceRequest", "base": { "max": "*", "min": 0, "path": "DeviceRequest" }, "isSummary": false }, { "path": "DeviceRequest.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "isModifier": false, "short": "Logical id of this artifact", "type": [ { "code": "id" } ], "max": "1", "id": "DeviceRequest.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": "DeviceRequest.meta", "min": 0, "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.", "isModifier": false, "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "max": "1", "id": "DeviceRequest.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "path": "DeviceRequest.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "DeviceRequest.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. 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.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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 }, { "path": "DeviceRequest.language", "min": 0, "definition": "The base language in which the resource is written.", "isModifier": false, "short": "Language of the resource content", "type": [ { "code": "code" } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/languages", "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 } ], "description": "A human language." }, "max": "1", "id": "DeviceRequest.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" }, "isSummary": false }, { "path": "DeviceRequest.text", "min": 0, "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.", "isModifier": false, "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": "DeviceRequest.text", "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.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "isSummary": false }, { "path": "DeviceRequest.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.", "isModifier": false, "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "DeviceRequest.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "isSummary": false }, { "path": "DeviceRequest.extension", "min": 0, "definition": "An Extension", "isModifier": false, "short": "Extension", "slicing": { "rules": "open", "ordered": false, "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "max": "*", "id": "DeviceRequest.extension", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "isSummary": false }, { "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() or (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": "DeviceRequest.extension", "min": 0, "definition": "If true indicates that the request is asking for the specified action to not occur.", "isModifier": true, "short": "true if request is prohibiting action", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/request-doNotPerform" ] } ], "mustSupport": true, "sliceName": "doNotPerform", "max": "1", "id": "DeviceRequest.extension:doNotPerform", "condition": [ "ele-1" ], "comment": "The attributes provided with the request qualify what is not to be done. For example, if an effectiveTime is provided, the \"do not\" request only applies within the specified time. If a performerType is specified then the \"do not\" request only applies to performers of that type. Qualifiers include: code, subject, occurrence, perormerType and performer.\r\rIn some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. \"NPO\" (nothing by mouth), \"DNR\" (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. \"Do not DNR\").", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "isModifierReason": "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur." }, { "path": "DeviceRequest.modifierExtension", "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](http://hl7.org/fhir/R4/extensibility.html#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 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).", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "DeviceRequest.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" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false }, { "path": "DeviceRequest.identifier", "min": 0, "definition": "Identifiers assigned to this order by the orderer or by the receiver.", "isModifier": false, "short": "External Request identifier", "mapping": [ { "map": "Request.identifier", "identity": "workflow" }, { "map": "FiveWs.identifier", "identity": "w5" }, { "map": "ORC.2, ORC.3", "identity": "v2" }, { "map": ".identifier", "identity": "rim" }, { "map": "ClinicalStatement.identifier", "identity": "quick" } ], "type": [ { "code": "Identifier" } ], "mustSupport": true, "max": "*", "id": "DeviceRequest.identifier", "base": { "max": "*", "min": 0, "path": "DeviceRequest.identifier" }, "isSummary": true }, { "path": "DeviceRequest.instantiatesCanonical", "min": 0, "definition": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.", "isModifier": false, "short": "Instantiates FHIR protocol or definition", "mapping": [ { "map": "Request.instantiatesCanonical", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition" ] } ], "max": "*", "id": "DeviceRequest.instantiatesCanonical", "comment": "Note: This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/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.", "base": { "max": "*", "min": 0, "path": "DeviceRequest.instantiatesCanonical" }, "isSummary": true }, { "path": "DeviceRequest.instantiatesUri", "min": 0, "definition": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.", "isModifier": false, "short": "Instantiates external protocol or definition", "mapping": [ { "map": "Request.instantiatesUri", "identity": "workflow" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=DEFN].target", "identity": "rim" } ], "type": [ { "code": "uri" } ], "max": "*", "id": "DeviceRequest.instantiatesUri", "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "base": { "max": "*", "min": 0, "path": "DeviceRequest.instantiatesUri" }, "isSummary": true }, { "path": "DeviceRequest.basedOn", "min": 0, "definition": "Plan/proposal/order fulfilled by this request.", "isModifier": false, "short": "What request fulfills", "mapping": [ { "map": "Request.basedOn", "identity": "workflow" }, { "map": "ORC.8 (plus others)", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=FLFS].target", "identity": "rim" }, { "map": "Proposal.prnReason.reason", "identity": "quick" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "max": "*", "id": "DeviceRequest.basedOn", "base": { "max": "*", "min": 0, "path": "DeviceRequest.basedOn" }, "isSummary": true }, { "path": "DeviceRequest.priorRequest", "min": 0, "definition": "The request takes the place of the referenced completed or terminated request(s).", "isModifier": false, "short": "What request replaces", "mapping": [ { "map": "Request.replaces", "identity": "workflow" }, { "map": "Handled by message location of ORC (ORC.1=RO or RU)", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=RPLC].target", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "max": "*", "id": "DeviceRequest.priorRequest", "base": { "max": "*", "min": 0, "path": "DeviceRequest.priorRequest" }, "isSummary": true }, { "path": "DeviceRequest.groupIdentifier", "min": 0, "definition": "Composite request this is part of.", "isModifier": false, "short": "Identifier of composite request", "mapping": [ { "map": "Request.groupIdentifier", "identity": "workflow" }, { "map": "ORC.4", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "1", "id": "DeviceRequest.groupIdentifier", "base": { "max": "1", "min": 0, "path": "DeviceRequest.groupIdentifier" }, "isSummary": true }, { "path": "DeviceRequest.status", "min": 0, "definition": "The status of the request.", "isModifier": true, "short": "draft | active | suspended | completed | entered-in-error | cancelled", "mapping": [ { "map": "Request.status", "identity": "workflow" }, { "map": "FiveWs.status", "identity": "w5" }, { "map": "ORC.5", "identity": "v2" }, { "map": ".status", "identity": "rim" }, { "map": "Action.currentStatus", "identity": "quick" } ], "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestStatus" } ], "description": "Codes representing the status of the request." }, "max": "1", "id": "DeviceRequest.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": 0, "path": "DeviceRequest.status" }, "isModifierReason": "This element is labeled 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 }, { "path": "DeviceRequest.intent", "min": 1, "definition": "Whether the request is a proposal, plan, an original order or a reflex order.", "isModifier": true, "short": "proposal | plan | original-order | encoded | reflex-order", "mapping": [ { "map": "Request.intent", "identity": "workflow" }, { "map": "FiveWs.class", "identity": "w5" }, { "map": "N/A", "identity": "v2" }, { "map": ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-intent|4.0.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "description": "The kind of diagnostic request." }, "max": "1", "id": "DeviceRequest.intent", "base": { "max": "1", "min": 1, "path": "DeviceRequest.intent" }, "isModifierReason": "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request", "isSummary": true }, { "path": "DeviceRequest.priority", "min": 0, "definition": "Indicates how quickly the {{title}} should be addressed with respect to other requests.", "isModifier": false, "short": "Indicates how quickly the {{title}} should be addressed with respect to other requests", "mapping": [ { "map": "Request.priority", "identity": "workflow" }, { "map": "FiveWs.grade", "identity": "w5" }, { "map": "TQ1.9", "identity": "v2" }, { "map": ".priorityCode", "identity": "rim" } ], "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, normal priority", "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "description": "Identifies the level of importance to be assigned to actioning the request." }, "max": "1", "id": "DeviceRequest.priority", "base": { "max": "1", "min": 0, "path": "DeviceRequest.priority" }, "isSummary": true }, { "path": "DeviceRequest.code[x]", "min": 1, "definition": "The details of the device to be used.", "isModifier": false, "short": "Device requested", "mapping": [ { "map": "Request.code", "identity": "workflow" }, { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".code", "identity": "rim" }, { "map": "DeviceUse.device", "identity": "quick" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device" ] }, { "code": "CodeableConcept" } ], "mustSupport": true, "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/device-kind", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestCode" } ], "description": "Codes for devices that can be requested." }, "max": "1", "id": "DeviceRequest.code[x]", "base": { "max": "1", "min": 1, "path": "DeviceRequest.code[x]" }, "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() or (children().count() > id.count())" } ], "path": "DeviceRequest.parameter", "min": 0, "definition": "Specific parameters for the ordered item. For example, the prism value for lenses.", "isModifier": false, "short": "Device details", "mapping": [ { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".code", "identity": "rim" }, { "map": "DeviceUse.device", "identity": "quick" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "DeviceRequest.parameter", "base": { "max": "*", "min": 0, "path": "DeviceRequest.parameter" }, "isSummary": false }, { "path": "DeviceRequest.parameter.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.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "DeviceRequest.parameter.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "path": "DeviceRequest.parameter.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "DeviceRequest.parameter.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" }, "isSummary": false }, { "path": "DeviceRequest.parameter.modifierExtension", "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](http://hl7.org/fhir/R4/extensibility.html#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 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).", "isModifier": true, "short": "Extensions that cannot be ignored even if unrecognized", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "DeviceRequest.parameter.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" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true }, { "path": "DeviceRequest.parameter.code", "min": 0, "definition": "A code or string that identifies the device detail being asserted.", "isModifier": false, "short": "Device detail", "mapping": [ { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".code", "identity": "rim" }, { "map": "DeviceUse.device", "identity": "quick" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParameterCode" } ], "description": "A code that identifies the device detail." }, "max": "1", "id": "DeviceRequest.parameter.code", "base": { "max": "1", "min": 0, "path": "DeviceRequest.parameter.code" }, "isSummary": false }, { "path": "DeviceRequest.parameter.value[x]", "min": 0, "definition": "The value of the device detail.", "isModifier": false, "short": "Value of detail", "mapping": [ { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "Varies by domain", "identity": "v2" }, { "map": ".code", "identity": "rim" }, { "map": "DeviceUse.device", "identity": "quick" } ], "type": [ { "code": "CodeableConcept" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "boolean" } ], "max": "1", "id": "DeviceRequest.parameter.value[x]", "comment": "Range means device should have a value that falls somewhere within the specified range.", "base": { "max": "1", "min": 0, "path": "DeviceRequest.parameter.value[x]" }, "isSummary": false }, { "path": "DeviceRequest.subject", "min": 1, "definition": "The patient who will use the device.", "isModifier": false, "short": "Focus of request", "mapping": [ { "map": "Request.subject", "identity": "workflow" }, { "map": "FiveWs.subject[x]", "identity": "w5" }, { "map": "Accompanying PID segment", "identity": "v2" }, { "map": ".participation[typeCode=SBJ].role", "identity": "rim" }, { "map": "ClinicalStatement.subject", "identity": "quick" }, { "map": "FiveWs.subject", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient" ] } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.subject", "base": { "max": "1", "min": 1, "path": "DeviceRequest.subject" }, "isSummary": true }, { "path": "DeviceRequest.encounter", "min": 0, "definition": "An encounter that provides additional context in which this request is made.", "isModifier": false, "short": "Encounter motivating request", "mapping": [ { "map": "Request.encounter", "identity": "workflow" }, { "map": "FiveWs.context", "identity": "w5" }, { "map": "Accompanying PV1", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]", "identity": "rim" }, { "map": "ClinicalStatement.encounter", "identity": "quick" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter" ] } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.encounter", "base": { "max": "1", "min": 0, "path": "DeviceRequest.encounter" }, "isSummary": true }, { "path": "DeviceRequest.occurrence[x]", "min": 0, "definition": "The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".", "isModifier": false, "short": "Desired time or schedule for use", "mapping": [ { "map": "Request.occurrence[x]", "identity": "workflow" }, { "map": "FiveWs.planned", "identity": "w5" }, { "map": "Accompanying TQ1/TQ2 segments", "identity": "v2" }, { "map": ".effectiveTime", "identity": "rim" }, { "map": "DeviceUse.applicationSchedule", "identity": "quick" } ], "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.occurrence[x]", "base": { "max": "1", "min": 0, "path": "DeviceRequest.occurrence[x]" }, "isSummary": true }, { "path": "DeviceRequest.authoredOn", "min": 0, "definition": "When the request transitioned to being actionable.", "isModifier": false, "short": "When recorded", "mapping": [ { "map": "Request.authoredOn", "identity": "workflow" }, { "map": "FiveWs.recorded", "identity": "w5" }, { "map": "ORC.9", "identity": "v2" }, { "map": ".participation[typeCode=AUT].time", "identity": "rim" }, { "map": "ClinicalStatement.statementDateTime", "identity": "quick" } ], "type": [ { "code": "dateTime" } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.authoredOn", "base": { "max": "1", "min": 0, "path": "DeviceRequest.authoredOn" }, "isSummary": true }, { "path": "DeviceRequest.requester", "min": 0, "definition": "The individual who initiated the request and has responsibility for its activation.", "isModifier": false, "short": "Who/what is requesting diagnostics", "mapping": [ { "map": "Request.requester", "identity": "workflow" }, { "map": "FiveWs.author", "identity": "w5" }, { "map": "ORC.12", "identity": "v2" }, { "map": ".participation[typeCode=AUT].role", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization" ] } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.requester", "base": { "max": "1", "min": 0, "path": "DeviceRequest.requester" }, "isSummary": true }, { "path": "DeviceRequest.performerType", "min": 0, "definition": "Desired type of performer for doing the diagnostic testing.", "isModifier": false, "short": "Filler role", "mapping": [ { "map": "Request.performerType", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" }, { "map": "PRT", "identity": "v2" }, { "map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/participant-role", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestParticipantRole" } ], "description": "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc." }, "max": "1", "id": "DeviceRequest.performerType", "base": { "max": "1", "min": 0, "path": "DeviceRequest.performerType" }, "isSummary": true }, { "path": "DeviceRequest.performer", "min": 0, "definition": "The desired performer for doing the diagnostic testing.", "isModifier": false, "short": "Requested Filler", "mapping": [ { "map": "Request.performer", "identity": "workflow" }, { "map": "FiveWs.actor", "identity": "w5" }, { "map": "PRT", "identity": "v2" }, { "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-careteam", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson" ] } ], "mustSupport": true, "max": "1", "id": "DeviceRequest.performer", "base": { "max": "1", "min": 0, "path": "DeviceRequest.performer" }, "isSummary": true }, { "path": "DeviceRequest.reasonCode", "min": 0, "definition": "Reason or justification for the use of this device.", "isModifier": false, "short": "Coded Reason for request", "mapping": [ { "map": "Request.reasonCode", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "ORC.16", "identity": "v2" }, { "map": ".reasonCode", "identity": "rim" }, { "map": "Action.indication.reason", "identity": "quick" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceRequestReason" } ], "description": "Diagnosis or problem codes justifying the reason for requesting the device." }, "max": "*", "id": "DeviceRequest.reasonCode", "base": { "max": "*", "min": 0, "path": "DeviceRequest.reasonCode" }, "isSummary": true }, { "path": "DeviceRequest.reasonReference", "min": 0, "definition": "Reason or justification for the use of this device.", "isModifier": false, "short": "Linked Reason for request", "mapping": [ { "map": "Request.reasonReference", "identity": "workflow" }, { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": "ORC.16", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=RSON].target", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-condition", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-observation" ] } ], "mustSupport": true, "max": "*", "id": "DeviceRequest.reasonReference", "base": { "max": "*", "min": 0, "path": "DeviceRequest.reasonReference" }, "isSummary": true }, { "path": "DeviceRequest.insurance", "min": 0, "definition": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", "isModifier": false, "short": "Associated insurance coverage", "mapping": [ { "map": "Request.insurance", "identity": "workflow" }, { "map": "IN1/IN2", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=COVBY].target", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Coverage", "http://hl7.org/fhir/StructureDefinition/ClaimResponse" ] } ], "max": "*", "id": "DeviceRequest.insurance", "base": { "max": "*", "min": 0, "path": "DeviceRequest.insurance" }, "isSummary": false }, { "path": "DeviceRequest.supportingInfo", "requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.", "min": 0, "definition": "Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).", "isModifier": false, "short": "Additional clinical information", "mapping": [ { "map": "Request.supportingInfo", "identity": "workflow" }, { "map": "Accompanying segments", "identity": "v2" }, { "map": ".outboundRelationship[typeCode=PERT].target", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "max": "*", "id": "DeviceRequest.supportingInfo", "base": { "max": "*", "min": 0, "path": "DeviceRequest.supportingInfo" }, "isSummary": false }, { "path": "DeviceRequest.note", "min": 0, "definition": "Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.", "isModifier": false, "short": "Notes or comments", "mapping": [ { "map": "Request.note", "identity": "workflow" }, { "map": "NTE", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]", "identity": "rim" }, { "map": "ClinicalStatement.additionalText", "identity": "quick" } ], "type": [ { "code": "Annotation" } ], "max": "*", "id": "DeviceRequest.note", "base": { "max": "*", "min": 0, "path": "DeviceRequest.note" }, "isSummary": false }, { "path": "DeviceRequest.relevantHistory", "min": 0, "definition": "Key events in the history of the request.", "isModifier": false, "short": "Request provenance", "mapping": [ { "map": "Request.relevantHistory", "identity": "workflow" }, { "map": "N/A", "identity": "v2" }, { "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ] } ], "max": "*", "id": "DeviceRequest.relevantHistory", "comment": "This might not include provenances for all versions of the request - only those deemed \"relevant\" or important.\rThis SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a \"relevant\" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude\rAll Provenances should have some historical version of this Request as their subject.", "base": { "max": "*", "min": 0, "path": "DeviceRequest.relevantHistory" }, "isSummary": false } ] }, "status": "draft", "id": "552e3edc-589a-4dd4-a3a4-a974da70d634", "kind": "resource", "url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-devicerequest", "version": "3.3.0", "differential": { "element": [ { "id": "DeviceRequest", "path": "DeviceRequest", "mustSupport": false }, { "id": "DeviceRequest.extension:doNotPerform", "max": "1", "min": 0, "path": "DeviceRequest.extension", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/request-doNotPerform" ] } ], "sliceName": "doNotPerform", "mustSupport": true }, { "id": "DeviceRequest.identifier", "path": "DeviceRequest.identifier", "mustSupport": true }, { "id": "DeviceRequest.status", "path": "DeviceRequest.status", "mustSupport": true }, { "id": "DeviceRequest.intent", "path": "DeviceRequest.intent", "mustSupport": true }, { "id": "DeviceRequest.code[x]", "path": "DeviceRequest.code[x]", "mustSupport": true }, { "id": "DeviceRequest.subject", "path": "DeviceRequest.subject", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient" ] } ], "mustSupport": true }, { "id": "DeviceRequest.encounter", "path": "DeviceRequest.encounter", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter" ] } ], "mustSupport": true }, { "id": "DeviceRequest.occurrence[x]", "path": "DeviceRequest.occurrence[x]", "mustSupport": true }, { "id": "DeviceRequest.authoredOn", "path": "DeviceRequest.authoredOn", "mustSupport": true }, { "id": "DeviceRequest.requester", "path": "DeviceRequest.requester", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization" ] } ], "mustSupport": true }, { "id": "DeviceRequest.performer", "path": "DeviceRequest.performer", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitioner", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-practitionerrole", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-careteam", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-device", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson" ] } ], "mustSupport": true }, { "id": "DeviceRequest.reasonReference", "path": "DeviceRequest.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-condition", "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-observation" ] } ], "mustSupport": true } ] }, "contact": [ { "telecom": [ { "value": "http://hl7.org/special/committees/CQI", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DeviceRequest" }