This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
XML Format: StructureDefinition-deviceusestatement-uv-ips
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="deviceusestatement-uv-ips"/> <meta> <lastUpdated value="2018-02-15T06:25:36.732+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-deviceusestatement-uv-ips-definitions.html#DeviceUseStatement.subject" title="The patient using the device.">subject</a><a name="DeviceUseStatement.subject"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/references.html">Reference</a>(<a href="StructureDefinition-patient-uv-ips.html">Patient-uv-ips</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/uv/ips/StructureDefinition/deviceusestatement-uv-ips"/> <version value="0.1.0"/> <name value="DeviceUseStatement-uv-ips"/> <title value="Device (use statement)"/> <status value="draft"/> <experimental value="true"/> <date value="2018-02-14T00:00:00+11:00"/> <publisher value="HL7 International"/> <contact> <name value="François Macary - PHAST"/> </contact> <description value="This profile represents the constraints applied to the DeviceUseStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A statement about a device used by or implanted on the patient is described in the patient summary as an instance of a DeviceUseStatement resource constrained by this profile."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="This profile constrains the representation of a statement about a medical device used by or impanted on the patient, part of the "Medical Devices" section of the Composition resource representing the international patient summary, as specified by the IPS project of HL7 International."/> <fhirVersion value="3.0.1"/> <mapping> <identity value="quick"/> <uri value="http://wiki.siframework.org/CQF"/> <name value="Quality Improvement and Clinical Knowledge (QUICK)"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="DeviceUseStatement"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DeviceUseStatement"/> <derivation value="constraint"/> <snapshot> <element id="DeviceUseStatement"> <path value="DeviceUseStatement"/> <short value="Record of use of a device"/> <definition value="A record of a device being used by a patient where the record is the result of a report from the patient or another clinician."/> <min value="0"/> <max value="*"/> <base> <path value="DeviceUseStatement"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="quick"/> <map value="DeviceUsePerformanceOccurrence"/> </mapping> <mapping> <identity value="w5"/> <map value="workflow.order"/> </mapping> </element> <element id="DeviceUseStatement.id"> <path value="DeviceUseStatement.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="DeviceUseStatement.meta"> <path value="DeviceUseStatement.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="DeviceUseStatement.implicitRules"> <path value="DeviceUseStatement.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="DeviceUseStatement.language"> <path value="DeviceUseStatement.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="DeviceUseStatement.text"> <path value="DeviceUseStatement.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="DeviceUseStatement.contained"> <path value="DeviceUseStatement.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DeviceUseStatement.extension"> <path value="DeviceUseStatement.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DeviceUseStatement.modifierExtension"> <path value="DeviceUseStatement.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="DeviceUseStatement.identifier"> <path value="DeviceUseStatement.identifier"/> <short value="External identifier for this record"/> <definition value="An external identifier for this statement such as an IRI."/> <min value="0"/> <max value="*"/> <base> <path value="DeviceUseStatement.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <mapping> <identity value="quick"/> <map value="ClinicalStatement.identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="DeviceUseStatement.status"> <path value="DeviceUseStatement.status"/> <short value="active | completed | entered-in-error +"/> <definition value="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 value="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). This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid."/> <min value="1"/> <max value="1"/> <base> <path value="DeviceUseStatement.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="DeviceUseStatementStatus"/> </extension> <strength value="required"/> <description value="A coded concept indicating the current status of a the Device Usage"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/device-statement-status"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="quick"/> <map value="…status"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="DeviceUseStatement.subject"> <path value="DeviceUseStatement.subject"/> <short value="Patient using device"/> <definition value="The patient using the device."/> <min value="1"/> <max value="1"/> <base> <path value="DeviceUseStatement.subject"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/uv/ips/StructureDefinition/patient-uv-ips"/> </type> <mustSupport value="true"/> <mapping> <identity value="quick"/> <map value="ClinicalStatement.subject"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> </element> <element id="DeviceUseStatement.whenUsed"> <path value="DeviceUseStatement.whenUsed"/> <short value="Period device was used"/> <definition value="The time period over which the device was used."/> <min value="0"/> <max value="1"/> <base> <path value="DeviceUseStatement.whenUsed"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <mapping> <identity value="quick"/> <map value="Performance.performanceTime"/> </mapping> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="DeviceUseStatement.timing[x]"> <path value="DeviceUseStatement.timing[x]"/> <short value="How often the device was used"/> <definition value="How often the device was used."/> <min value="0"/> <max value="1"/> <base> <path value="DeviceUseStatement.timing[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Timing"/> </type> <type> <code value="Period"/> </type> <type> <code value="dateTime"/> </type> <mapping> <identity value="quick"/> <map value="DeviceUse.applicationSchedule"/> </mapping> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="DeviceUseStatement.recordedOn"> <path value="DeviceUseStatement.recordedOn"/> <short value="When statement was recorded"/> <definition value="The time at which the statement was made/recorded."/> <min value="0"/> <max value="1"/> <base> <path value="DeviceUseStatement.recordedOn"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mapping> <identity value="quick"/> <map value="ClinicalStatement.statementDateTime"/> </mapping> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element id="DeviceUseStatement.source"> <path value="DeviceUseStatement.source"/> <short value="Who made the statement"/> <definition value="Who reported the device was being used by the patient."/> <min value="0"/> <max value="1"/> <base> <path value="DeviceUseStatement.source"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <mapping> <identity value="w5"/> <map value="who.actor"/> </mapping> </element> <element id="DeviceUseStatement.device"> <path value="DeviceUseStatement.device"/> <short value="Reference to device used"/> <definition value="The details of the device used."/> <min value="1"/> <max value="1"/> <base> <path value="DeviceUseStatement.device"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <mapping> <identity value="quick"/> <map value="DeviceUse.device"/> </mapping> <mapping> <identity value="w5"/> <map value="who.actor"/> </mapping> </element> <element id="DeviceUseStatement.indication"> <path value="DeviceUseStatement.indication"/> <short value="Why device was used"/> <definition value="Reason or justification for the use of the device."/> <min value="0"/> <max value="*"/> <base> <path value="DeviceUseStatement.indication"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mapping> <identity value="quick"/> <map value="Action.indication.reason"/> </mapping> <mapping> <identity value="w5"/> <map value="why"/> </mapping> </element> <element id="DeviceUseStatement.bodySite"> <path value="DeviceUseStatement.bodySite"/> <short value="Target body site"/> <definition value="Indicates the site on the subject's body where the device was used ( i.e. the target site)."/> <requirements value="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/body-site-instance](null.html)."/> <min value="0"/> <max value="1"/> <base> <path value="DeviceUseStatement.bodySite"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="BodySite"/> </extension> <strength value="example"/> <description value="Codes describing anatomical locations. May include laterality."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/body-site"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="targetSiteCode"/> </mapping> </element> <element id="DeviceUseStatement.note"> <path value="DeviceUseStatement.note"/> <short value="Addition details (comments, instructions)"/> <definition value="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 value="0"/> <max value="*"/> <base> <path value="DeviceUseStatement.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <mapping> <identity value="quick"/> <map value="ClinicalStatement.additionalText"/> </mapping> </element> </snapshot> <differential> <element id="DeviceUseStatement.subject"> <path value="DeviceUseStatement.subject"/> <definition value="The patient using the device."/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/uv/ips/StructureDefinition/patient-uv-ips"/> </type> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
