Data Model Libraries
    Preparing search index...

    Class DeviceUsage

    DeviceUsage Class

    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.

    FHIR Specification

    • 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.
    • FHIR Version: 5.0.0

    FHIR DeviceUsage

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? deviceusageStatusEnum status category? patient derivedFrom? context? timing? dateAsserted? usageStatus? usageReason? adherence? informationSource? device reason? bodySite? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getPatient setPatient hasPatient getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getContext setContext hasContext getTiming setTiming hasTiming getTimingTiming hasTimingTiming getTimingPeriod hasTimingPeriod getTimingDateTimeType hasTimingDateTimeType getDateAssertedElement setDateAssertedElement hasDateAssertedElement getDateAsserted setDateAsserted hasDateAsserted getUsageStatus setUsageStatus hasUsageStatus getUsageReason setUsageReason addUsageReason hasUsageReason getAdherence setAdherence hasAdherence getInformationSource setInformationSource hasInformationSource getDevice setDevice hasDevice getReason setReason addReason hasReason getBodySite setBodySite hasBodySite getNote setNote addNote hasNote fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initCategory initDerivedFrom initUsageReason initReason initNote

    Constructors

    Properties

    identifier?: Identifier[]

    DeviceUsage.identifier Element

    FHIR Specification

    • Short: External identifier for this record
    • Definition: An external identifier for this statement such as an IRI.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    DeviceUsage.basedOn Element

    FHIR Specification

    • Short: Fulfills plan, proposal or order
    • Definition: A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.
    • Requirements: Allows tracing of authorization for the DeviceUsage and tracking whether proposals/recommendations were acted upon.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    deviceusageStatusEnum: DeviceusageStatusEnum

    FHIR CodeSystem: DeviceusageStatus

    DeviceusageStatusEnum

    status: null | EnumCodeType

    DeviceUsage.status Element

    FHIR Specification

    • Short: active | completed | not-done | 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). This element is labeled as a modifier because the status contains the codes that mark the statement as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • 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

    CodeSystem Enumeration: DeviceusageStatusEnum

    category?: CodeableConcept[]

    DeviceUsage.category Element

    FHIR Specification

    • 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).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    patient: null | Reference

    DeviceUsage.patient Element

    FHIR Specification

    derivedFrom?: Reference[]

    DeviceUsage.derivedFrom Element

    FHIR Specification

    context?: Reference

    DeviceUsage.context Element

    FHIR Specification

    timing?: IDataType

    DeviceUsage.timing[x] Element

    @ChoiceDataTypesMeta('DeviceUsage.timing[x]', ['Timing','Period','dateTime',]

    FHIR Specification

    • Short: How often the device was used
    • Definition: How often the device was used.
    • FHIR Types: 'Timing', 'Period', 'dateTime',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dateAsserted?: DateTimeType

    DeviceUsage.dateAsserted Element

    FHIR Specification

    • Short: When the statement was made (and recorded)
    • Definition: The time at which the statement was recorded by informationSource.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    usageStatus?: CodeableConcept

    DeviceUsage.usageStatus Element

    FHIR Specification

    • 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    usageReason?: CodeableConcept[]

    DeviceUsage.usageReason Element

    FHIR Specification

    • 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    adherence?: DeviceUsageAdherenceComponent

    DeviceUsage.adherence Element

    FHIR Specification

    • Short: How device is being used
    • Definition: This indicates how or if the device is being used.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    informationSource?: Reference

    DeviceUsage.informationSource Element

    FHIR Specification

    device: null | CodeableReference

    DeviceUsage.device Element

    FHIR Specification

    reason?: CodeableReference[]

    DeviceUsage.reason Element

    FHIR Specification

    bodySite?: CodeableReference

    DeviceUsage.bodySite Element

    FHIR Specification

    • 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.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    DeviceUsage.note Element

    FHIR Specification

    • 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.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided DeviceUsage JSON to instantiate the DeviceUsage data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceUsage

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DeviceUsage

      Returns undefined | DeviceUsage

      DeviceUsage data model or undefined for DeviceUsage

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the derivedFrom property.

      Parameters

      • value: undefined | Reference[]

        the derivedFrom array value

      Returns this

      this

      @ReferenceTargets('DeviceUsage.derivedFrom', ['ServiceRequest','Procedure','Claim','Observation','QuestionnaireResponse','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the derivedFrom array property.

      Parameters

      • value: undefined | Reference

        the derivedFrom value

      Returns this

      this

      @ReferenceTargets('DeviceUsage.derivedFrom', ['ServiceRequest','Procedure','Claim','Observation','QuestionnaireResponse','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided InformationSource object value to the informationSource property.

      Parameters

      • value: undefined | Reference

        the informationSource object value

      Returns this

      this

      @ReferenceTargets('DeviceUsage.informationSource', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnaddBasedOnhasBasedOngetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetPatientsetPatienthasPatientgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetContextsetContexthasContextgetTimingsetTiminghasTiminggetTimingTiminghasTimingTiminggetTimingPeriodhasTimingPeriodgetTimingDateTimeTypehasTimingDateTimeTypegetDateAssertedElementsetDateAssertedElementhasDateAssertedElementgetDateAssertedsetDateAssertedhasDateAssertedgetUsageStatussetUsageStatushasUsageStatusgetUsageReasonsetUsageReasonaddUsageReasonhasUsageReasongetAdherencesetAdherencehasAdherencegetInformationSourcesetInformationSourcehasInformationSourcegetDevicesetDevicehasDevicegetReasonsetReasonaddReasonhasReasongetBodySitesetBodySitehasBodySitegetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitCategoryinitDerivedFrominitUsageReasoninitReasoninitNote