Package org.hl7.fhir.r5.model

Class SpecimenDefinition

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.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

      protected Identifier 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.

    • versionAlgorithm

      protected DataType versionAlgorithm
      Indicates the mechanism used to compare versions to determine which is more current.

    • name

      protected StringType name
      A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    • title

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

    • derivedFromCanonical

      protected List<CanonicalType> derivedFromCanonical
      The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.

    • derivedFromUri

      protected List<UriType> 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

      protected Enumeration<Enumerations.PublicationStatus> status
      The current state of theSpecimenDefinition.

    • experimental

      protected BooleanType 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 StringType publisher
      Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.

    • contact

      protected List<ContactDetail> contact
      Contact details to assist a user in finding and communicating with the publisher.

    • description

      protected MarkdownType description
      A free text natural language description of the SpecimenDefinition from the consumer's perspective.

    • useContext

      protected List<UsageContext> 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

      protected List<CodeableConcept> 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.

    • copyrightLabel

      protected StringType copyrightLabel
      A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

    • approvalDate

      protected DateType 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

      protected DateType 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

      protected Period effectivePeriod
      The period during which the SpecimenDefinition content was or is planned to be effective.

    • typeCollected

      protected CodeableConcept typeCollected
      The kind of material to be collected.

    • patientPreparation

      protected List<CodeableConcept> patientPreparation
      Preparation of the patient for specimen collection.

    • timeAspect

      protected StringType timeAspect
      Time aspect of specimen collection (duration or offset).

    • collection

      protected List<CodeableConcept> collection
      The action to be performed for collecting the specimen.

    • typeTested

      protected List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> typeTested
      Specimen conditioned in a container as expected by the testing laboratory.

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

      See Also:

    • IDENTIFIER

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
      Type: token
      Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

      See Also:

    • STATUS

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
      Type: token
      Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
      Type: string
      Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title

      See Also:

    • TITLE

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
      Type: string
      Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
      Type: uri
      Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url

      See Also:

    • URL

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

      Description: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
      Type: uri
      Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url

    • 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_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_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

  • Constructor Details

  • Method Details

    • getUrlElement

      public UriType getUrlElement()
      Returns:
      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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public SpecimenDefinition setUrlElement(UriType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • getUrl

      public String getUrl()
      Returns:
      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.

    • setUrl

      public SpecimenDefinition setUrl(String value)
      Parameters:
      value - 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.

    • getIdentifier

      public Identifier getIdentifier()
      Returns:
      identifier (A business identifier assigned to this SpecimenDefinition.)

    • hasIdentifier

      public boolean hasIdentifier()

    • setIdentifier

      public SpecimenDefinition setIdentifier(Identifier value)
      Parameters:
      value - identifier (A business identifier assigned to this SpecimenDefinition.)

    • getVersionElement

      public StringType getVersionElement()
      Returns:
      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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • setVersionElement

      public SpecimenDefinition setVersionElement(StringType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • getVersion

      public String getVersion()
      Returns:
      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.

    • setVersion

      public SpecimenDefinition setVersion(String value)
      Parameters:
      value - 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.

    • getVersionAlgorithm

      public DataType getVersionAlgorithm()
      Returns:
      versionAlgorithm (Indicates the mechanism used to compare versions to determine which is more current.)

    • getVersionAlgorithmStringType

      public StringType getVersionAlgorithmStringType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      versionAlgorithm (Indicates the mechanism used to compare versions to determine which is more current.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasVersionAlgorithmStringType

      public boolean hasVersionAlgorithmStringType()

    • getVersionAlgorithmCoding

      public Coding getVersionAlgorithmCoding() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      versionAlgorithm (Indicates the mechanism used to compare versions to determine which is more current.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasVersionAlgorithmCoding

      public boolean hasVersionAlgorithmCoding()

    • hasVersionAlgorithm

      public boolean hasVersionAlgorithm()

    • setVersionAlgorithm

      public SpecimenDefinition setVersionAlgorithm(DataType value)
      Parameters:
      value - versionAlgorithm (Indicates the mechanism used to compare versions to determine which is more current.)

    • getNameElement

      public StringType getNameElement()
      Returns:
      name (A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • hasNameElement

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public SpecimenDefinition setNameElement(StringType value)
      Parameters:
      value - name (A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • getName

      public String getName()
      Returns:
      A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    • setName

      public SpecimenDefinition setName(String value)
      Parameters:
      value - A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    • getTitleElement

      public StringType getTitleElement()
      Returns:
      title (A short, descriptive, user-friendly title for the SpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

    • hasTitleElement

      public boolean hasTitleElement()

    • hasTitle

      public boolean hasTitle()

    • setTitleElement

      public SpecimenDefinition setTitleElement(StringType value)
      Parameters:
      value - title (A short, descriptive, user-friendly title for the SpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

    • getTitle

      public String getTitle()
      Returns:
      A short, descriptive, user-friendly title for the SpecimenDefinition.

    • setTitle

      public SpecimenDefinition setTitle(String value)
      Parameters:
      value - A short, descriptive, user-friendly title for the SpecimenDefinition.

    • getDerivedFromCanonical

      public List<CanonicalType> getDerivedFromCanonical()
      Returns:
      derivedFromCanonical (The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.)

    • setDerivedFromCanonical

      public SpecimenDefinition setDerivedFromCanonical(List<CanonicalType> theDerivedFromCanonical)
      Returns:
      Returns a reference to this for easy method chaining

    • hasDerivedFromCanonical

      public boolean hasDerivedFromCanonical()

    • addDerivedFromCanonicalElement

      public CanonicalType addDerivedFromCanonicalElement()
      Returns:
      derivedFromCanonical (The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.)

    • addDerivedFromCanonical

      public SpecimenDefinition addDerivedFromCanonical(String value)
      Parameters:
      value - derivedFromCanonical (The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.)

    • hasDerivedFromCanonical

      public boolean hasDerivedFromCanonical(String value)
      Parameters:
      value - derivedFromCanonical (The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.)

    • getDerivedFromUri

      public List<UriType> getDerivedFromUri()
      Returns:
      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.)

    • setDerivedFromUri

      public SpecimenDefinition setDerivedFromUri(List<UriType> theDerivedFromUri)
      Returns:
      Returns a reference to this for easy method chaining

    • hasDerivedFromUri

      public boolean hasDerivedFromUri()

    • addDerivedFromUriElement

      public UriType addDerivedFromUriElement()
      Returns:
      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.)

    • addDerivedFromUri

      public SpecimenDefinition addDerivedFromUri(String value)
      Parameters:
      value - 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.)

    • hasDerivedFromUri

      public boolean hasDerivedFromUri(String value)
      Parameters:
      value - 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.)

    • getStatusElement

      public Enumeration<Enumerations.PublicationStatus> getStatusElement()
      Returns:
      status (The current state of theSpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public SpecimenDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
      Parameters:
      value - status (The current state of theSpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.PublicationStatus getStatus()
      Returns:
      The current state of theSpecimenDefinition.

    • setStatus

      public SpecimenDefinition setStatus(Enumerations.PublicationStatus value)
      Parameters:
      value - The current state of theSpecimenDefinition.

    • getExperimentalElement

      public BooleanType getExperimentalElement()
      Returns:
      experimental (A flag to indicate that this SpecimenDefinition is not authored for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

    • hasExperimentalElement

      public boolean hasExperimentalElement()

    • hasExperimental

      public boolean hasExperimental()

    • setExperimentalElement

      public SpecimenDefinition setExperimentalElement(BooleanType value)
      Parameters:
      value - experimental (A flag to indicate that this SpecimenDefinition is not authored for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

    • getExperimental

      public boolean getExperimental()
      Returns:
      A flag to indicate that this SpecimenDefinition is not authored for genuine usage.

    • setExperimental

      public SpecimenDefinition setExperimental(boolean value)
      Parameters:
      value - A flag to indicate that this SpecimenDefinition is not authored for genuine usage.

    • getSubject

      public DataType getSubject()
      Returns:
      subject (A code or group definition that describes the intended subject from which this kind of specimen is to be collected.)

    • getSubjectCodeableConcept

      public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      subject (A code or group definition that describes the intended subject from which this kind of specimen is to be collected.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasSubjectCodeableConcept

      public boolean hasSubjectCodeableConcept()

    • getSubjectReference

      public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      subject (A code or group definition that describes the intended subject from which this kind of specimen is to be collected.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasSubjectReference

      public boolean hasSubjectReference()

    • hasSubject

      public boolean hasSubject()

    • setSubject

      public SpecimenDefinition setSubject(DataType value)
      Parameters:
      value - subject (A code or group definition that describes the intended subject from which this kind of specimen is to be collected.)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public SpecimenDefinition setDateElement(DateTimeType value)
      Parameters:
      value - 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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • getDate

      public Date getDate()
      Returns:
      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.

    • setDate

      public SpecimenDefinition setDate(Date value)
      Parameters:
      value - 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.

    • getPublisherElement

      public StringType getPublisherElement()
      Returns:
      publisher (Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

    • hasPublisherElement

      public boolean hasPublisherElement()

    • hasPublisher

      public boolean hasPublisher()

    • setPublisherElement

      public SpecimenDefinition setPublisherElement(StringType value)
      Parameters:
      value - publisher (Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

    • getPublisher

      public String getPublisher()
      Returns:
      Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.

    • setPublisher

      public SpecimenDefinition setPublisher(String value)
      Parameters:
      value - Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.

    • getContact

      public List<ContactDetail> getContact()
      Returns:
      contact (Contact details to assist a user in finding and communicating with the publisher.)

    • setContact

      public SpecimenDefinition setContact(List<ContactDetail> theContact)
      Returns:
      Returns a reference to this for easy method chaining

    • hasContact

      public boolean hasContact()

    • addContact

      public ContactDetail addContact()

    • addContact

      public SpecimenDefinition addContact(ContactDetail t)

    • getContactFirstRep

      public ContactDetail getContactFirstRep()
      Returns:
      The first repetition of repeating field contact, creating it if it does not already exist {3}

    • getDescriptionElement

      public MarkdownType getDescriptionElement()
      Returns:
      description (A free text natural language description of the SpecimenDefinition from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public SpecimenDefinition setDescriptionElement(MarkdownType value)
      Parameters:
      value - description (A free text natural language description of the SpecimenDefinition from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      A free text natural language description of the SpecimenDefinition from the consumer's perspective.

    • setDescription

      public SpecimenDefinition setDescription(String value)
      Parameters:
      value - A free text natural language description of the SpecimenDefinition from the consumer's perspective.

    • getUseContext

      public List<UsageContext> getUseContext()
      Returns:
      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.)

    • setUseContext

      public SpecimenDefinition setUseContext(List<UsageContext> theUseContext)
      Returns:
      Returns a reference to this for easy method chaining

    • hasUseContext

      public boolean hasUseContext()

    • addUseContext

      public UsageContext addUseContext()

    • addUseContext

      public SpecimenDefinition addUseContext(UsageContext t)

    • getUseContextFirstRep

      public UsageContext getUseContextFirstRep()
      Returns:
      The first repetition of repeating field useContext, creating it if it does not already exist {3}

    • getJurisdiction

      public List<CodeableConcept> getJurisdiction()
      Returns:
      jurisdiction (A jurisdiction in which the SpecimenDefinition is intended to be used.)

    • setJurisdiction

      public SpecimenDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
      Returns:
      Returns a reference to this for easy method chaining

    • hasJurisdiction

      public boolean hasJurisdiction()

    • addJurisdiction

      public CodeableConcept addJurisdiction()

    • addJurisdiction

      public SpecimenDefinition addJurisdiction(CodeableConcept t)

    • getJurisdictionFirstRep

      public CodeableConcept getJurisdictionFirstRep()
      Returns:
      The first repetition of repeating field jurisdiction, creating it if it does not already exist {3}

    • getPurposeElement

      public MarkdownType getPurposeElement()
      Returns:
      purpose (Explains why this SpecimeDefinition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

    • hasPurposeElement

      public boolean hasPurposeElement()

    • hasPurpose

      public boolean hasPurpose()

    • setPurposeElement

      public SpecimenDefinition setPurposeElement(MarkdownType value)
      Parameters:
      value - purpose (Explains why this SpecimeDefinition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

    • getPurpose

      public String getPurpose()
      Returns:
      Explains why this SpecimeDefinition is needed and why it has been designed as it has.

    • setPurpose

      public SpecimenDefinition setPurpose(String value)
      Parameters:
      value - Explains why this SpecimeDefinition is needed and why it has been designed as it has.

    • getCopyrightElement

      public MarkdownType getCopyrightElement()
      Returns:
      copyright (Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

    • hasCopyrightElement

      public boolean hasCopyrightElement()

    • hasCopyright

      public boolean hasCopyright()

    • setCopyrightElement

      public SpecimenDefinition setCopyrightElement(MarkdownType value)
      Parameters:
      value - copyright (Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

    • getCopyright

      public String getCopyright()
      Returns:
      Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.

    • setCopyright

      public SpecimenDefinition setCopyright(String value)
      Parameters:
      value - Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.

    • getCopyrightLabelElement

      public StringType getCopyrightLabelElement()
      Returns:
      copyrightLabel (A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').). This is the underlying object with id, value and extensions. The accessor "getCopyrightLabel" gives direct access to the value

    • hasCopyrightLabelElement

      public boolean hasCopyrightLabelElement()

    • hasCopyrightLabel

      public boolean hasCopyrightLabel()

    • setCopyrightLabelElement

      public SpecimenDefinition setCopyrightLabelElement(StringType value)
      Parameters:
      value - copyrightLabel (A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').). This is the underlying object with id, value and extensions. The accessor "getCopyrightLabel" gives direct access to the value

    • getCopyrightLabel

      public String getCopyrightLabel()
      Returns:
      A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

    • setCopyrightLabel

      public SpecimenDefinition setCopyrightLabel(String value)
      Parameters:
      value - A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

    • getApprovalDateElement

      public DateType getApprovalDateElement()
      Returns:
      approvalDate (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value

    • hasApprovalDateElement

      public boolean hasApprovalDateElement()

    • hasApprovalDate

      public boolean hasApprovalDate()

    • setApprovalDateElement

      public SpecimenDefinition setApprovalDateElement(DateType value)
      Parameters:
      value - approvalDate (The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value

    • getApprovalDate

      public Date getApprovalDate()
      Returns:
      The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

    • setApprovalDate

      public SpecimenDefinition setApprovalDate(Date value)
      Parameters:
      value - The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

    • getLastReviewDateElement

      public DateType getLastReviewDateElement()
      Returns:
      lastReviewDate (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value

    • hasLastReviewDateElement

      public boolean hasLastReviewDateElement()

    • hasLastReviewDate

      public boolean hasLastReviewDate()

    • setLastReviewDateElement

      public SpecimenDefinition setLastReviewDateElement(DateType value)
      Parameters:
      value - lastReviewDate (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value

    • getLastReviewDate

      public Date getLastReviewDate()
      Returns:
      The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

    • setLastReviewDate

      public SpecimenDefinition setLastReviewDate(Date value)
      Parameters:
      value - The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

    • getEffectivePeriod

      public Period getEffectivePeriod()
      Returns:
      effectivePeriod (The period during which the SpecimenDefinition content was or is planned to be effective.)

    • hasEffectivePeriod

      public boolean hasEffectivePeriod()

    • setEffectivePeriod

      public SpecimenDefinition setEffectivePeriod(Period value)
      Parameters:
      value - effectivePeriod (The period during which the SpecimenDefinition content was or is planned to be effective.)

    • getTypeCollected

      public CodeableConcept getTypeCollected()
      Returns:
      typeCollected (The kind of material to be collected.)

    • hasTypeCollected

      public boolean hasTypeCollected()

    • setTypeCollected

      public SpecimenDefinition setTypeCollected(CodeableConcept value)
      Parameters:
      value - typeCollected (The kind of material to be collected.)

    • getPatientPreparation

      public List<CodeableConcept> getPatientPreparation()
      Returns:
      patientPreparation (Preparation of the patient for specimen collection.)

    • setPatientPreparation

      public SpecimenDefinition setPatientPreparation(List<CodeableConcept> thePatientPreparation)
      Returns:
      Returns a reference to this for easy method chaining

    • hasPatientPreparation

      public boolean hasPatientPreparation()

    • addPatientPreparation

      public CodeableConcept addPatientPreparation()

    • addPatientPreparation

      public SpecimenDefinition addPatientPreparation(CodeableConcept t)

    • getPatientPreparationFirstRep

      public CodeableConcept getPatientPreparationFirstRep()
      Returns:
      The first repetition of repeating field patientPreparation, creating it if it does not already exist {3}

    • getTimeAspectElement

      public StringType getTimeAspectElement()
      Returns:
      timeAspect (Time aspect of specimen collection (duration or offset).). This is the underlying object with id, value and extensions. The accessor "getTimeAspect" gives direct access to the value

    • hasTimeAspectElement

      public boolean hasTimeAspectElement()

    • hasTimeAspect

      public boolean hasTimeAspect()

    • setTimeAspectElement

      public SpecimenDefinition setTimeAspectElement(StringType value)
      Parameters:
      value - timeAspect (Time aspect of specimen collection (duration or offset).). This is the underlying object with id, value and extensions. The accessor "getTimeAspect" gives direct access to the value

    • getTimeAspect

      public String getTimeAspect()
      Returns:
      Time aspect of specimen collection (duration or offset).

    • setTimeAspect

      public SpecimenDefinition setTimeAspect(String value)
      Parameters:
      value - Time aspect of specimen collection (duration or offset).

    • getCollection

      public List<CodeableConcept> getCollection()
      Returns:
      collection (The action to be performed for collecting the specimen.)

    • setCollection

      public SpecimenDefinition setCollection(List<CodeableConcept> theCollection)
      Returns:
      Returns a reference to this for easy method chaining

    • hasCollection

      public boolean hasCollection()

    • addCollection

      public CodeableConcept addCollection()

    • addCollection

      public SpecimenDefinition addCollection(CodeableConcept t)

    • getCollectionFirstRep

      public CodeableConcept getCollectionFirstRep()
      Returns:
      The first repetition of repeating field collection, creating it if it does not already exist {3}

    • getTypeTested

      public List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> getTypeTested()
      Returns:
      typeTested (Specimen conditioned in a container as expected by the testing laboratory.)

    • setTypeTested

      public SpecimenDefinition setTypeTested(List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> theTypeTested)
      Returns:
      Returns a reference to this for easy method chaining

    • hasTypeTested

      public boolean hasTypeTested()

    • addTypeTested

      public SpecimenDefinition.SpecimenDefinitionTypeTestedComponent addTypeTested()

    • addTypeTested

      public SpecimenDefinition addTypeTested(SpecimenDefinition.SpecimenDefinitionTypeTestedComponent t)

    • getTypeTestedFirstRep

      public SpecimenDefinition.SpecimenDefinitionTypeTestedComponent getTypeTestedFirstRep()
      Returns:
      The first repetition of repeating field typeTested, creating it if it does not already exist {3}

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public SpecimenDefinition copy()
      Specified by:
      copy in class DomainResource

    • copyValues

      public void copyValues(SpecimenDefinition dst)

    • typedCopy

      protected SpecimenDefinition typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource