Data Model Libraries
    Preparing search index...

    SupplyRequest Class

    A record of a request for a medication, substance or device used in the healthcare setting.

    FHIR Specification

    • Short: Request for a medication, substance or device
    • Definition: A record of a request for a medication, substance or device used in the healthcare setting.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory hasCategory getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getItem setItem hasItem getItemCodeableConcept hasItemCodeableConcept getItemReference hasItemReference getQuantity setQuantity hasQuantity getParameter setParameter addParameter hasParameter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getRequester setRequester hasRequester getSupplier setSupplier addSupplier hasSupplier getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getDeliverFrom setDeliverFrom hasDeliverFrom getDeliverTo setDeliverTo hasDeliverTo 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 initParameter initSupplier initReasonCode initReasonReference

    Constructors

    Properties

    identifier?: Identifier[]

    SupplyRequest.identifier Element

    FHIR Specification

    • Short: Business Identifier for SupplyRequest
    • Definition: Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
    • Comment: The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.
    • Requirements: Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    supplyrequestStatusEnum: SupplyrequestStatusEnum

    FHIR CodeSystem: SupplyrequestStatus

    status?: EnumCodeType

    SupplyRequest.status Element

    FHIR Specification

    • Short: draft | active | suspended +
    • Definition: Status of the supply request.
    • 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: SupplyrequestStatusEnum

    category?: CodeableConcept

    SupplyRequest.category Element

    FHIR Specification

    • Short: The kind of supply (central, non-stock, etc.)
    • Definition: Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

    SupplyRequest.priority Element

    FHIR Specification

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

    CodeSystem Enumeration: RequestPriorityEnum

    item: null | IDataType

    SupplyRequest.item[x] Element

    @ChoiceDataTypesMeta('SupplyRequest.item[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Medication, Substance, or Device requested to be supplied
    • Definition: The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
    • Comment: Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    quantity: null | Quantity

    SupplyRequest.quantity Element

    FHIR Specification

    • Short: The requested amount of the item indicated
    • Definition: The amount that is being ordered of the indicated item.
    • FHIR Type: Quantity
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    SupplyRequest.parameter Element

    FHIR Specification

    • Short: Ordered item details
    • Definition: Specific parameters for the ordered item. For example, the size of the indicated item.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    occurrence?: IDataType

    SupplyRequest.occurrence[x] Element

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

    FHIR Specification

    • Short: When the request should be fulfilled
    • Definition: When the request should be fulfilled.
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authoredOn?: DateTimeType

    SupplyRequest.authoredOn Element

    FHIR Specification

    • Short: When the request was made
    • Definition: When the request was made.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    SupplyRequest.requester Element

    FHIR Specification

    supplier?: Reference[]

    SupplyRequest.supplier Element

    FHIR Specification

    reasonCode?: CodeableConcept[]

    SupplyRequest.reasonCode Element

    FHIR Specification

    • Short: The reason why the supply item was requested
    • Definition: The reason why the supply item was requested.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    SupplyRequest.reasonReference Element

    FHIR Specification

    deliverFrom?: Reference

    SupplyRequest.deliverFrom Element

    FHIR Specification

    deliverTo?: Reference

    SupplyRequest.deliverTo Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SupplyRequest

      • OptionaloptSourceField: string

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

      Returns undefined | SupplyRequest

      SupplyRequest data model or undefined for SupplyRequest

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Requester object value to the requester property.

      Parameters

      • value: undefined | Reference

        the requester object value

      Returns this

      this

      @ReferenceTargets('SupplyRequest.requester', ['Practitioner','PractitionerRole','Organization','Patient','RelatedPerson','Device',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('SupplyRequest.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

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

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('SupplyRequest.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      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