Data Model Libraries
    Preparing search index...

    InventoryReport Class

    A report of inventory or stock items.

    FHIR Specification

    • Short: A report of inventory or stock items
    • Definition: A report of inventory or stock items.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCountTypeEnumType setCountTypeEnumType hasCountTypeEnumType getCountTypeElement setCountTypeElement hasCountTypeElement getCountType setCountType hasCountType getOperationType setOperationType hasOperationType getOperationTypeReason setOperationTypeReason hasOperationTypeReason getReportedDateTimeElement setReportedDateTimeElement hasReportedDateTimeElement getReportedDateTime setReportedDateTime hasReportedDateTime getReporter setReporter hasReporter getReportingPeriod setReportingPeriod hasReportingPeriod getInventoryListing setInventoryListing addInventoryListing hasInventoryListing 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 initInventoryListing initNote

    Constructors

    Properties

    identifier?: Identifier[]

    InventoryReport.identifier Element

    FHIR Specification

    • Short: Business identifier for the report
    • Definition: Business identifier for the InventoryReport.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    inventoryreportStatusEnum: InventoryreportStatusEnum

    FHIR CodeSystem: InventoryreportStatus

    status: null | EnumCodeType

    InventoryReport.status Element

    FHIR Specification

    • Short: draft | requested | active | entered-in-error
    • Definition: The status of the inventory check or notification - whether this is draft (e.g. the report is still pending some updates) or active.
    • 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: InventoryreportStatusEnum

    inventoryreportCounttypeEnum: InventoryreportCounttypeEnum

    FHIR CodeSystem: InventoryreportCounttype

    countType: null | EnumCodeType

    InventoryReport.countType Element

    FHIR Specification

    • Short: snapshot | difference
    • Definition: Whether the report is about the current inventory count (snapshot) or a differential change in inventory (change).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: Not known why this is labelled a modifier
    • isSummary: true

    CodeSystem Enumeration: InventoryreportCounttypeEnum

    operationType?: CodeableConcept

    InventoryReport.operationType Element

    FHIR Specification

    • Short: addition | subtraction
    • Definition: What type of operation is being performed - addition or subtraction.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    operationTypeReason?: CodeableConcept

    InventoryReport.operationTypeReason Element

    FHIR Specification

    • Short: The reason for this count - regular count, ad-hoc count, new arrivals, etc
    • Definition: The reason for this count - regular count, ad-hoc count, new arrivals, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reportedDateTime: null | DateTimeType

    InventoryReport.reportedDateTime Element

    FHIR Specification

    • Short: When the report has been submitted
    • Definition: When the report has been submitted.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    reporter?: Reference

    InventoryReport.reporter Element

    FHIR Specification

    reportingPeriod?: Period

    InventoryReport.reportingPeriod Element

    FHIR Specification

    • Short: The period the report refers to
    • Definition: The period the report refers to.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    InventoryReport.inventoryListing Element

    FHIR Specification

    • Short: An inventory listing section (grouped by any of the attributes)
    • Definition: An inventory listing section (grouped by any of the attributes).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    InventoryReport.note Element

    FHIR Specification

    • Short: A note associated with the InventoryReport
    • Definition: A note associated with the InventoryReport.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InventoryReport

      • OptionaloptSourceField: string

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

      Returns undefined | InventoryReport

      InventoryReport data model or undefined for InventoryReport

      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