Class Specimen

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Specimen
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Specimen extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Specimen Resource (clinical.diagnostics)

Definition: A sample to be used for analysis.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Specimen

See Also:
Serialized Form
  • Field Details

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description: The subject of the specimen
      Type: reference
      Path: Specimen.subject

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: The subject of the specimen
      Type: reference
      Path: Specimen.subject

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description: The patient the specimen comes from
      Type: reference
      Path: Specimen.subject

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: The patient the specimen comes from
      Type: reference
      Path: Specimen.subject

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The unique identifier associated with the specimen
      Type: token
      Path: Specimen.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The unique identifier associated with the specimen
      Type: token
      Path: Specimen.identifier

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description: The specimen type
      Type: token
      Path: Specimen.type

      See Also:
      Constant Field Values
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: The specimen type
      Type: token
      Path: Specimen.type

    • SP_PARENT

      public static final String SP_PARENT
      Search parameter constant for parent

      Description: The parent of the specimen
      Type: reference
      Path: Specimen.parent

      See Also:
      Constant Field Values
    • PARENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
      Fluent Client search parameter constant for parent

      Description: The parent of the specimen
      Type: reference
      Path: Specimen.parent

    • SP_ACCESSION

      public static final String SP_ACCESSION
      Search parameter constant for accession

      Description: The accession number associated with the specimen
      Type: token
      Path: Specimen.accessionIdentifier

      See Also:
      Constant Field Values
    • ACCESSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
      Fluent Client search parameter constant for accession

      Description: The accession number associated with the specimen
      Type: token
      Path: Specimen.accessionIdentifier

    • SP_COLLECTED

      public static final String SP_COLLECTED
      Search parameter constant for collected

      Description: The date the specimen was collected
      Type: date
      Path: Specimen.collection.collected[x]

      See Also:
      Constant Field Values
    • COLLECTED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam COLLECTED
      Fluent Client search parameter constant for collected

      Description: The date the specimen was collected
      Type: date
      Path: Specimen.collection.collected[x]

    • SP_COLLECTOR

      public static final String SP_COLLECTOR
      Search parameter constant for collector

      Description: Who collected the specimen
      Type: reference
      Path: Specimen.collection.collector

      See Also:
      Constant Field Values
    • COLLECTOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COLLECTOR
      Fluent Client search parameter constant for collector

      Description: Who collected the specimen
      Type: reference
      Path: Specimen.collection.collector

    • SP_BODYSITE

      public static final String SP_BODYSITE
      Search parameter constant for bodysite

      Description: The code for the body site from where the specimen originated
      Type: token
      Path: Specimen.collection.bodySite

      See Also:
      Constant Field Values
    • BODYSITE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
      Fluent Client search parameter constant for bodysite

      Description: The code for the body site from where the specimen originated
      Type: token
      Path: Specimen.collection.bodySite

    • SP_CONTAINER_ID

      public static final String SP_CONTAINER_ID
      Search parameter constant for container-id

      Description: The unique identifier associated with the specimen container
      Type: token
      Path: Specimen.container.identifier

      See Also:
      Constant Field Values
    • CONTAINER_ID

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER_ID
      Fluent Client search parameter constant for container-id

      Description: The unique identifier associated with the specimen container
      Type: token
      Path: Specimen.container.identifier

    • SP_CONTAINER

      public static final String SP_CONTAINER
      Search parameter constant for container

      Description: The kind of specimen container
      Type: token
      Path: Specimen.container.type

      See Also:
      Constant Field Values
    • CONTAINER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER
      Fluent Client search parameter constant for container

      Description: The kind of specimen container
      Type: token
      Path: Specimen.container.type

    • INCLUDE_COLLECTOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COLLECTOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:collector".
    • INCLUDE_PARENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:parent".
    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:patient".
    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Specimen:subject".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: Id for specimen

    • setIdentifier

      public Specimen setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: Id for specimen

    • addIdentifier

      Adds and returns a new value for identifier (id)

      Definition: Id for specimen

    • addIdentifier

      public Specimen addIdentifier(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: Id for specimen

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: Id for specimen

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<SpecimenStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The availability of the specimen

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The availability of the specimen

    • setStatus

      public Specimen setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<SpecimenStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The availability of the specimen

    • setStatus

      public Specimen setStatus(SpecimenStatusEnum theValue)
      Sets the value(s) for status (status)

      Definition: The availability of the specimen

    • getType

      Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

      Definition: The kind of material that forms the specimen

    • setType

      public Specimen setType(CodeableConceptDt theValue)
      Sets the value(s) for type (class)

      Definition: The kind of material that forms the specimen

    • getParent

      Gets the value(s) for parent (). creating it if it does not exist. Will not return null.

      Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

    • setParent

      public Specimen setParent(List<ResourceReferenceDt> theValue)
      Sets the value(s) for parent ()

      Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

    • addParent

      Adds and returns a new value for parent ()

      Definition: Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

    • getSubject

      Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

      Definition:

    • setSubject

      public Specimen setSubject(ResourceReferenceDt theValue)
      Sets the value(s) for subject (who.focus)

      Definition:

    • getAccessionIdentifier

      Gets the value(s) for accessionIdentifier (id). creating it if it does not exist. Will not return null.

      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.

    • setAccessionIdentifier

      Sets the value(s) for accessionIdentifier (id)

      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.

    • getReceivedTimeElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getReceivedTimeElement()
      Gets the value(s) for receivedTime (when.done). creating it if it does not exist. Will not return null.

      Definition: Time when specimen was received for processing or testing

    • getReceivedTime

      Gets the value(s) for receivedTime (when.done). creating it if it does not exist. This method may return null.

      Definition: Time when specimen was received for processing or testing

    • setReceivedTime

      public Specimen setReceivedTime(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for receivedTime (when.done)

      Definition: Time when specimen was received for processing or testing

    • setReceivedTime

      public Specimen setReceivedTime(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for receivedTime (when.done)

      Definition: Time when specimen was received for processing or testing

    • setReceivedTimeWithSecondsPrecision

      Sets the value for receivedTime (when.done)

      Definition: Time when specimen was received for processing or testing

    • getCollection

      Gets the value(s) for collection (). creating it if it does not exist. Will not return null.

      Definition: Details concerning the specimen collection

    • setCollection

      Sets the value(s) for collection ()

      Definition: Details concerning the specimen collection

    • getTreatment

      Gets the value(s) for treatment (). creating it if it does not exist. Will not return null.

      Definition: Details concerning treatment and processing steps for the specimen

    • setTreatment

      Sets the value(s) for treatment ()

      Definition: Details concerning treatment and processing steps for the specimen

    • addTreatment

      Adds and returns a new value for treatment ()

      Definition: Details concerning treatment and processing steps for the specimen

    • addTreatment

      Adds a given new value for treatment ()

      Definition: Details concerning treatment and processing steps for the specimen

      Parameters:
      theValue - The treatment to add (must not be null)
    • getTreatmentFirstRep

      Gets the first repetition for treatment (), creating it if it does not already exist.

      Definition: Details concerning treatment and processing steps for the specimen

    • getContainer

      Gets the value(s) for container (). creating it if it does not exist. Will not return null.

      Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

    • setContainer

      Sets the value(s) for container ()

      Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

    • addContainer

      Adds and returns a new value for container ()

      Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

    • addContainer

      Adds a given new value for container ()

      Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

      Parameters:
      theValue - The container to add (must not be null)
    • getContainerFirstRep

      Gets the first repetition for container (), creating it if it does not already exist.

      Definition: The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource