Data Model Libraries
    Preparing search index...

    DeviceRequest Class

    Represents a request a device to be provided to a specific patient. The device may be an implantable device to be subsequently implanted, or an external assistive device, such as a walker, to be delivered and subsequently be used.

    FHIR Specification

    • Short: Medical device request
    • 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.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getReplaces setReplaces addReplaces hasReplaces getGroupIdentifier setGroupIdentifier hasGroupIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getCode setCode hasCode getQuantityElement setQuantityElement hasQuantityElement getQuantity setQuantity hasQuantity getParameter setParameter addParameter hasParameter getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getRequester setRequester hasRequester getPerformer setPerformer hasPerformer getReason setReason addReason hasReason getAsNeededElement setAsNeededElement hasAsNeededElement getAsNeeded setAsNeeded hasAsNeeded getAsNeededFor setAsNeededFor hasAsNeededFor getInsurance setInsurance addInsurance hasInsurance getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getNote setNote addNote hasNote getRelevantHistory setRelevantHistory addRelevantHistory hasRelevantHistory 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 initInstantiatesCanonical initInstantiatesUri initBasedOn initReplaces initParameter initReason initInsurance initSupportingInfo initNote initRelevantHistory

    Constructors

    Properties

    identifier?: Identifier[]

    DeviceRequest.identifier Element

    FHIR Specification

    • Short: External Request identifier
    • Definition: Identifiers assigned to this order by the orderer or by the receiver.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesCanonical?: CanonicalType[]

    DeviceRequest.instantiatesCanonical Element

    FHIR Specification

    • Short: Instantiates FHIR protocol or definition
    • 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.
    • Comment: Note: This is a business identifier, not a resource identifier (see discussion). 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.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType[]

    DeviceRequest.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • 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.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    DeviceRequest.basedOn Element

    FHIR Specification

    replaces?: Reference[]

    DeviceRequest.replaces Element

    FHIR Specification

    • Short: What request replaces
    • Definition: The request takes the place of the referenced completed or terminated request(s).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    groupIdentifier?: Identifier

    DeviceRequest.groupIdentifier Element

    FHIR Specification

    • Short: Identifier of composite request
    • Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestStatusEnum: RequestStatusEnum

    FHIR CodeSystem: RequestStatus

    status?: EnumCodeType

    DeviceRequest.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: The status of the request.
    • Comment: This element is labeled as a modifier because the status contains the codes revoked and entered-in-error that mark the request as not currently valid.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • 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

    CodeSystem Enumeration: RequestStatusEnum

    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    intent: null | EnumCodeType

    DeviceRequest.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Whether the request is a proposal, plan, an original order or a reflex order.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • 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

    CodeSystem Enumeration: RequestIntentEnum

    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

    DeviceRequest.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the request should be addressed with respect to other requests.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RequestPriorityEnum

    doNotPerform?: BooleanType

    DeviceRequest.doNotPerform Element

    FHIR Specification

    • Short: True if the request is to stop or not to start using the device
    • Definition: If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.
    • Comment: If do not perform is not specified, the request is a positive request e.g. "do perform". DeviceRequest.reasonCode includes the reason for marking the DeviceRequest as 'do not perform'.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc.)
    • isSummary: true
    code: null | CodeableReference

    DeviceRequest.code Element

    FHIR Specification

    quantity?: IntegerType

    DeviceRequest.quantity Element

    FHIR Specification

    • Short: Quantity of devices to supply
    • Definition: The number of devices to be provided.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    DeviceRequest.parameter Element

    FHIR Specification

    • Short: Device details
    • Definition: Specific parameters for the ordered item. For example, the prism value for lenses.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    subject: null | Reference

    DeviceRequest.subject Element

    FHIR Specification

    encounter?: Reference

    DeviceRequest.encounter Element

    FHIR Specification

    • Short: Encounter motivating request
    • Definition: An encounter that provides additional context in which this request is made.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    occurrence?: IDataType

    DeviceRequest.occurrence[x] Element

    @ChoiceDataTypesMeta('DeviceRequest.occurrence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: Desired time or schedule for use
    • 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".
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authoredOn?: DateTimeType

    DeviceRequest.authoredOn Element

    FHIR Specification

    • Short: When recorded
    • Definition: When the request transitioned to being actionable.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    DeviceRequest.requester Element

    FHIR Specification

    performer?: CodeableReference

    DeviceRequest.performer Element

    FHIR Specification

    DeviceRequest.reason Element

    FHIR Specification

    asNeeded?: BooleanType

    DeviceRequest.asNeeded Element

    FHIR Specification

    • Short: PRN status of request
    • Definition: This status is to indicate whether the request is a PRN or may be given as needed.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    asNeededFor?: CodeableConcept

    DeviceRequest.asNeededFor Element

    FHIR Specification

    • Short: Device usage reason
    • Definition: The reason for using the device.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    insurance?: Reference[]

    DeviceRequest.insurance Element

    FHIR Specification

    supportingInfo?: Reference[]

    DeviceRequest.supportingInfo Element

    FHIR Specification

    • Short: Additional clinical information
    • 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).
    • Requirements: Knowing where the device is targeted is important for tracking if multiple sites are possible.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    DeviceRequest.note Element

    FHIR Specification

    • Short: Notes or comments
    • 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.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relevantHistory?: Reference[]

    DeviceRequest.relevantHistory Element

    FHIR Specification

    • Short: Request provenance
    • Definition: Key events in the history of the request.
    • Comment: This might not include provenances for all versions of the request - only those deemed "relevant" or important. This 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 All Provenances should have some historical version of this Request as their subject.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceRequest

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceRequest

      DeviceRequest data model or undefined for DeviceRequest

      JsonError if the provided JSON is not a valid JSON object

    • 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