Class SpecimenDefinition

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class SpecimenDefinition extends DomainResource
A kind of specimen with associated set of requirements.
See Also:
  • Field Details

    • url

      protected UriType url
      An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.
    • identifier

      A business identifier assigned to this SpecimenDefinition.
    • version

      protected StringType version
      The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.
    • title

      protected StringType title
      A short, descriptive, user-friendly title for the SpecimenDefinition.
    • derivedFromCanonical

      The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.
    • derivedFromUri

      The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.
    • status

      The current state of theSpecimenDefinition.
    • experimental

      A flag to indicate that this SpecimenDefinition is not authored for genuine usage.
    • subject

      protected DataType subject
      A code or group definition that describes the intended subject from which this kind of specimen is to be collected.
    • date

      protected DateTimeType date
      For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
    • publisher

      protected Reference publisher
      Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.
    • contact

      Contact details to assist a user in finding and communicating with the publisher.
    • description

      A free text natural language description of the SpecimenDefinition from the consumer's perspective.
    • useContext

      The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.
    • jurisdiction

      A jurisdiction in which the SpecimenDefinition is intended to be used.
    • purpose

      protected MarkdownType purpose
      Explains why this SpecimeDefinition is needed and why it has been designed as it has.
    • approvalDate

      The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • lastReviewDate

      The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
    • effectivePeriod

      The period during which the SpecimenDefinition content was or is planned to be effective.
    • typeCollected

      The kind of material to be collected.
    • patientPreparation

      Preparation of the patient for specimen collection.
    • timeAspect

      Time aspect of specimen collection (duration or offset).
    • collection

      The action to be performed for collecting the specimen.
    • typeTested

      Specimen conditioned in a container as expected by the testing laboratory.
    • SP_CONTAINER

      public static final String SP_CONTAINER
      Search parameter: container

      Description: The type of specimen conditioned in container expected by the lab
      Type: token
      Path: SpecimenDefinition.typeTested.container.type

      See Also:
    • CONTAINER

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

      Description: The type of specimen conditioned in container expected by the lab
      Type: token
      Path: SpecimenDefinition.typeTested.container.type

    • SP_EXPERIMENTAL

      public static final String SP_EXPERIMENTAL
      Search parameter: experimental

      Description: Not for genuine usage (true)
      Type: token
      Path: SpecimenDefinition.experimental

      See Also:
    • EXPERIMENTAL

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

      Description: Not for genuine usage (true)
      Type: token
      Path: SpecimenDefinition.experimental

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
    • 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 SpecimenDefinition
      Type: token
      Path: SpecimenDefinition.identifier

    • SP_IS_DERIVED

      public static final String SP_IS_DERIVED
      Search parameter: is-derived

      Description: Primary specimen (false) or derived specimen (true)
      Type: token
      Path: SpecimenDefinition.typeTested.isDerived

      See Also:
    • IS_DERIVED

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IS_DERIVED
      Fluent Client search parameter constant for is-derived

      Description: Primary specimen (false) or derived specimen (true)
      Type: token
      Path: SpecimenDefinition.typeTested.isDerived

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Publication status of the SpecimenDefinition: draft, active, retired, unknown
      Type: token
      Path: SpecimenDefinition.status

      See Also:
    • STATUS

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

      Description: Publication status of the SpecimenDefinition: draft, active, retired, unknown
      Type: token
      Path: SpecimenDefinition.status

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: Human-friendly name of the SpecimenDefinition
      Type: string
      Path: SpecimenDefinition.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: Human-friendly name of the SpecimenDefinition
      Type: string
      Path: SpecimenDefinition.title

    • SP_TYPE_TESTED

      public static final String SP_TYPE_TESTED
      Search parameter: type-tested

      Description: The type of specimen conditioned for testing
      Type: token
      Path: SpecimenDefinition.typeTested.type

      See Also:
    • TYPE_TESTED

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

      Description: The type of specimen conditioned for testing
      Type: token
      Path: SpecimenDefinition.typeTested.type

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: The type of collected specimen
      Type: token
      Path: SpecimenDefinition.typeCollected

      See Also:
    • TYPE

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

      Description: The type of collected specimen
      Type: token
      Path: SpecimenDefinition.typeCollected

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the specimen definition
      Type: uri
      Path: SpecimenDefinition.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the specimen definition
      Type: uri
      Path: SpecimenDefinition.url

  • Constructor Details

  • Method Details