Data Model Libraries
    Preparing search index...

    Class Specimen

    Specimen Class

    A sample to be used for analysis.

    FHIR Specification

    • Short: Sample for analysis
    • Definition: A sample to be used for analysis.
    • FHIR Version: 5.0.0

    FHIR Specimen

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? accessionIdentifier? specimenStatusEnum status? type_? subject? receivedTime? parent? request? specimenCombinedEnum combined? role? feature? collection? processing? container? condition? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getAccessionIdentifier setAccessionIdentifier hasAccessionIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getType setType hasType getSubject setSubject hasSubject getReceivedTimeElement setReceivedTimeElement hasReceivedTimeElement getReceivedTime setReceivedTime hasReceivedTime getParent setParent addParent hasParent getRequest setRequest addRequest hasRequest getCombinedEnumType setCombinedEnumType hasCombinedEnumType getCombinedElement setCombinedElement hasCombinedElement getCombined setCombined hasCombined getRole setRole addRole hasRole getFeature setFeature addFeature hasFeature getCollection setCollection hasCollection getProcessing setProcessing addProcessing hasProcessing getContainer setContainer addContainer hasContainer getCondition setCondition addCondition hasCondition getNote setNote addNote hasNote fhirType isEmpty 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 isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initParent initRequest initRole initFeature initProcessing initContainer initCondition initNote

    Constructors

    Properties

    identifier?: Identifier[]

    Specimen.identifier Element

    FHIR Specification

    • Short: External Identifier
    • Definition: Id for specimen.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    accessionIdentifier?: Identifier

    Specimen.accessionIdentifier Element

    FHIR Specification

    • Short: Identifier assigned by the lab
    • Definition: The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    specimenStatusEnum: SpecimenStatusEnum

    FHIR CodeSystem: SpecimenStatus

    SpecimenStatusEnum

    status?: EnumCodeType

    Specimen.status Element

    FHIR Specification

    • Short: available | unavailable | unsatisfactory | entered-in-error
    • Definition: The availability of the specimen.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 0..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: SpecimenStatusEnum

    Private Optionaltype_

    type_?: CodeableConcept

    Specimen.type Element

    FHIR Specification

    • Short: Kind of material that forms the specimen
    • Definition: The kind of material that forms the specimen.
    • Comment: The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference

    Specimen.subject Element

    FHIR Specification

    receivedTime?: DateTimeType

    Specimen.receivedTime Element

    FHIR Specification

    • Short: The time when specimen is received by the testing laboratory
    • Definition: Time when specimen is received by the testing laboratory for processing or testing.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    parent?: Reference[]

    Specimen.parent Element

    FHIR Specification

    • Short: Specimen from which this specimen originated
    • Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
    • Comment: The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    request?: Reference[]

    Specimen.request Element

    FHIR Specification

    • Short: Why the specimen was collected
    • Definition: Details concerning a service request that required a specimen to be collected.
    • Comment: The request may be explicit or implied such with a ServiceRequest that requires a blood draw.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specimenCombinedEnum: SpecimenCombinedEnum

    FHIR CodeSystem: SpecimenCombined

    SpecimenCombinedEnum

    combined?: EnumCodeType

    Specimen.combined Element

    FHIR Specification

    • Short: grouped | pooled
    • Definition: This element signifies if the specimen is part of a group or pooled.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SpecimenCombinedEnum

    role?: CodeableConcept[]

    Specimen.role Element

    FHIR Specification

    • Short: The role the specimen serves
    • Definition: The role or reason for the specimen in the testing workflow.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    feature?: SpecimenFeatureComponent[]

    Specimen.feature Element

    FHIR Specification

    • Short: The physical feature of a specimen
    • Definition: A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    collection?: SpecimenCollectionComponent

    Specimen.collection Element

    FHIR Specification

    • Short: Collection details
    • Definition: Details concerning the specimen collection.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    processing?: SpecimenProcessingComponent[]

    Specimen.processing Element

    FHIR Specification

    • Short: Processing and processing step details
    • Definition: Details concerning processing and processing steps for the specimen.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    container?: SpecimenContainerComponent[]

    Specimen.container Element

    FHIR Specification

    • Short: Direct container of specimen (tube/slide, etc.)
    • Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    condition?: CodeableConcept[]

    Specimen.condition Element

    FHIR Specification

    • Short: State of the specimen
    • Definition: A mode or state of being that describes the nature of the specimen.
    • Comment: Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.
    • Requirements: The specimen condition can be used to assess its quality or appropriateness for a specific test.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    Specimen.note Element

    FHIR Specification

    • Short: Comments
    • Definition: To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Specimen

      • OptionaloptSourceField: string

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

      Returns undefined | Specimen

      Specimen data model or undefined for Specimen

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('Specimen.subject', ['Patient','Group','Device','BiologicallyDerivedProduct','Substance','Location',])

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetAccessionIdentifiersetAccessionIdentifierhasAccessionIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetTypesetTypehasTypegetSubjectsetSubjecthasSubjectgetReceivedTimeElementsetReceivedTimeElementhasReceivedTimeElementgetReceivedTimesetReceivedTimehasReceivedTimegetParentsetParentaddParenthasParentgetRequestsetRequestaddRequesthasRequestgetCombinedEnumTypesetCombinedEnumTypehasCombinedEnumTypegetCombinedElementsetCombinedElementhasCombinedElementgetCombinedsetCombinedhasCombinedgetRolesetRoleaddRolehasRolegetFeaturesetFeatureaddFeaturehasFeaturegetCollectionsetCollectionhasCollectiongetProcessingsetProcessingaddProcessinghasProcessinggetContainersetContaineraddContainerhasContainergetConditionsetConditionaddConditionhasConditiongetNotesetNoteaddNotehasNotefhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitParentinitRequestinitRoleinitFeatureinitProcessinginitContainerinitConditioninitNote