Release 5 Preview #3
WorkflowThis page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4B R4 R3 R2
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for deviceusestatement
{
"resourceType" : "StructureDefinition",
"id" : "DeviceUseStatement",
"meta" : {
"lastUpdated" : "2020-08-20T17:41:31.970+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement",
"version" : "4.5.0",
"name" : "DeviceUseStatement",
"status" : "draft",
"date" : "2020-08-20T17:41:31+10:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.",
"fhirVersion" : "4.5.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "quick",
"uri" : "http://siframework.org/cqf",
"name" : "Quality Improvement and Clinical Knowledge (QUICK)"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "DeviceUseStatement",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "DeviceUseStatement",
"path" : "DeviceUseStatement",
"short" : "Record of use of a device",
"definition" : "A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "quick",
"map" : "DeviceUsePerformanceOccurrence"
}]
},
{
"id" : "DeviceUseStatement.id",
"path" : "DeviceUseStatement.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "DeviceUseStatement.meta",
"path" : "DeviceUseStatement.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "DeviceUseStatement.implicitRules",
"path" : "DeviceUseStatement.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "DeviceUseStatement.language",
"path" : "DeviceUseStatement.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "DeviceUseStatement.text",
"path" : "DeviceUseStatement.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "DeviceUseStatement.contained",
"path" : "DeviceUseStatement.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "DeviceUseStatement.extension",
"path" : "DeviceUseStatement.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "DeviceUseStatement.modifierExtension",
"path" : "DeviceUseStatement.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "DeviceUseStatement.identifier",
"path" : "DeviceUseStatement.identifier",
"short" : "External identifier for this record",
"definition" : "An external identifier for this statement such as an IRI.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.identifier"
}]
},
{
"id" : "DeviceUseStatement.basedOn",
"path" : "DeviceUseStatement.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.",
"requirements" : "Allows tracing of authorization for the DeviceUseStatement and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "DeviceUseStatement.status",
"path" : "DeviceUseStatement.status",
"short" : "active | completed | entered-in-error +",
"definition" : "A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.",
"comment" : "DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceUseStatementStatus"
}],
"strength" : "required",
"description" : "A coded concept indicating the current status of the Device Usage.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-statement-status|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "quick",
"map" : "…status"
}]
},
{
"id" : "DeviceUseStatement.category",
"path" : "DeviceUseStatement.category",
"short" : "The category of the statement - classifying how the statement is made",
"definition" : "This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DeviceUseStatement.subject",
"path" : "DeviceUseStatement.subject",
"short" : "Patient using device",
"definition" : "The patient who used the device.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "DeviceUseStatement.derivedFrom",
"path" : "DeviceUseStatement.derivedFrom",
"short" : "Supporting information",
"definition" : "Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.",
"comment" : "The most common use cases for deriving a DeviceUseStatement comes from creating it from a request or from an observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the DeviceUseStatement from.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.derivedFrom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Claim",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "DeviceUseStatement.context",
"path" : "DeviceUseStatement.context",
"short" : "The encounter or episode of care that establishes the context for this device use statement",
"definition" : "The encounter or episode of care that establishes the context for this device use statement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
}]
},
{
"id" : "DeviceUseStatement.timing[x]",
"path" : "DeviceUseStatement.timing[x]",
"short" : "How often the device was used",
"definition" : "How often the device was used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.timing[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Timing"
},
{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "quick",
"map" : "DeviceUse.applicationSchedule"
}]
},
{
"id" : "DeviceUseStatement.dateAsserted",
"path" : "DeviceUseStatement.dateAsserted",
"short" : "When the statement was made (and recorded)",
"definition" : "The time at which the statement was recorded by informationSource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.dateAsserted",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.statementDateTime"
}]
},
{
"id" : "DeviceUseStatement.usageStatus",
"path" : "DeviceUseStatement.usageStatus",
"short" : "The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement",
"definition" : "The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.usageStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DeviceUseStatement.usageReason",
"path" : "DeviceUseStatement.usageReason",
"short" : "The reason for asserting the usage status - for example forgot, lost, stolen, broken",
"definition" : "The reason for asserting the usage status - for example forgot, lost, stolen, broken.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.usageReason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DeviceUseStatement.informationSource",
"path" : "DeviceUseStatement.informationSource",
"short" : "Who made the statement",
"definition" : "Who reported the device was being used by the patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.informationSource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "DeviceUseStatement.device",
"path" : "DeviceUseStatement.device",
"short" : "Code or Reference to device used",
"definition" : "Code or Reference to device used.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.device",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "DeviceUseStatement.reason",
"path" : "DeviceUseStatement.reason",
"short" : "Why device was used",
"definition" : "Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUseStatement.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.reason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
},
{
"identity" : "quick",
"map" : "Action.indication.reason"
}]
},
{
"id" : "DeviceUseStatement.bodySite",
"path" : "DeviceUseStatement.bodySite",
"short" : "Target body site",
"definition" : "Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).",
"requirements" : "Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension [http://hl7.org/fhir/StructureDefinition/bodySite](null.html).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DeviceUseStatement.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/BodyStructure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
}]
},
{
"id" : "DeviceUseStatement.note",
"path" : "DeviceUseStatement.note",
"short" : "Addition details (comments, instructions)",
"definition" : "Details about the device statement 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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DeviceUseStatement.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.additionalText"
}]
}]
},
"differential" : {
"element" : [{
"id" : "DeviceUseStatement",
"path" : "DeviceUseStatement",
"short" : "Record of use of a device",
"definition" : "A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "quick",
"map" : "DeviceUsePerformanceOccurrence"
}]
},
{
"id" : "DeviceUseStatement.identifier",
"path" : "DeviceUseStatement.identifier",
"short" : "External identifier for this record",
"definition" : "An external identifier for this statement such as an IRI.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.identifier"
}]
},
{
"id" : "DeviceUseStatement.basedOn",
"path" : "DeviceUseStatement.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.",
"requirements" : "Allows tracing of authorization for the DeviceUseStatement and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "DeviceUseStatement.status",
"path" : "DeviceUseStatement.status",
"short" : "active | completed | entered-in-error +",
"definition" : "A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.",
"comment" : "DeviceUseStatment is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for contains codes that assert the status of the use by the patient (for example, stopped or on hold) as well as codes that assert the status of the resource itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceUseStatementStatus"
}],
"strength" : "required",
"description" : "A coded concept indicating the current status of the Device Usage.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-statement-status|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "quick",
"map" : "…status"
}]
},
{
"id" : "DeviceUseStatement.category",
"path" : "DeviceUseStatement.category",
"short" : "The category of the statement - classifying how the statement is made",
"definition" : "This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "DeviceUseStatement.subject",
"path" : "DeviceUseStatement.subject",
"short" : "Patient using device",
"definition" : "The patient who used the device.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "DeviceUseStatement.derivedFrom",
"path" : "DeviceUseStatement.derivedFrom",
"short" : "Supporting information",
"definition" : "Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.",
"comment" : "The most common use cases for deriving a DeviceUseStatement comes from creating it from a request or from an observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the DeviceUseStatement from.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Claim",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "DeviceUseStatement.context",
"path" : "DeviceUseStatement.context",
"short" : "The encounter or episode of care that establishes the context for this device use statement",
"definition" : "The encounter or episode of care that establishes the context for this device use statement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
}]
},
{
"id" : "DeviceUseStatement.timing[x]",
"path" : "DeviceUseStatement.timing[x]",
"short" : "How often the device was used",
"definition" : "How often the device was used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Timing"
},
{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "quick",
"map" : "DeviceUse.applicationSchedule"
}]
},
{
"id" : "DeviceUseStatement.dateAsserted",
"path" : "DeviceUseStatement.dateAsserted",
"short" : "When the statement was made (and recorded)",
"definition" : "The time at which the statement was recorded by informationSource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.statementDateTime"
}]
},
{
"id" : "DeviceUseStatement.usageStatus",
"path" : "DeviceUseStatement.usageStatus",
"short" : "The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement",
"definition" : "The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "DeviceUseStatement.usageReason",
"path" : "DeviceUseStatement.usageReason",
"short" : "The reason for asserting the usage status - for example forgot, lost, stolen, broken",
"definition" : "The reason for asserting the usage status - for example forgot, lost, stolen, broken.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "DeviceUseStatement.informationSource",
"path" : "DeviceUseStatement.informationSource",
"short" : "Who made the statement",
"definition" : "Who reported the device was being used by the patient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "DeviceUseStatement.device",
"path" : "DeviceUseStatement.device",
"short" : "Code or Reference to device used",
"definition" : "Code or Reference to device used.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "DeviceUseStatement.reason",
"path" : "DeviceUseStatement.reason",
"short" : "Why device was used",
"definition" : "Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUseStatement.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
},
{
"identity" : "quick",
"map" : "Action.indication.reason"
}]
},
{
"id" : "DeviceUseStatement.bodySite",
"path" : "DeviceUseStatement.bodySite",
"short" : "Target body site",
"definition" : "Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).",
"requirements" : "Knowing where the device is targeted is important for tracking if multiple sites are possible. If more information than just a code is required, use the extension [http://hl7.org/fhir/StructureDefinition/bodySite](null.html).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/BodyStructure"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
}]
},
{
"id" : "DeviceUseStatement.note",
"path" : "DeviceUseStatement.note",
"short" : "Addition details (comments, instructions)",
"definition" : "Details about the device statement 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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.additionalText"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:45+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change