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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSpecimenDefinition.SpecimenContainedPreferencestatic classSpecimenDefinition.SpecimenContainedPreferenceEnumFactorystatic classSpecimenDefinition.SpecimenDefinitionTypeTestedComponentstatic classSpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponentstatic classSpecimenDefinition.SpecimenDefinitionTypeTestedContainerComponentstatic classSpecimenDefinition.SpecimenDefinitionTypeTestedHandlingComponent
-
Field Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the asset content was approved by the publisher.protected List<CodeableConcept>collectionThe action to be performed for collecting the specimen.protected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTAINERFluent Client search parameter constant for containerprotected MarkdownTypecopyrightCopyright statement relating to the SpecimenDefinition and/or its contents.protected DateTimeTypedateFor draft definitions, indicates the date of initial creation.protected List<CanonicalType>derivedFromCanonicalThe canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.protected List<UriType>derivedFromUriThe 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.protected MarkdownTypedescriptionA free text natural language description of the SpecimenDefinition from the consumer's perspective.protected PeriodeffectivePeriodThe period during which the SpecimenDefinition content was or is planned to be effective.protected BooleanTypeexperimentalA flag to indicate that this SpecimenDefinition is not authored for genuine usage.static ca.uhn.fhir.rest.gclient.TokenClientParamEXPERIMENTALFluent Client search parameter constant for experimentalprotected IdentifieridentifierA business identifier assigned to this SpecimenDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.rest.gclient.TokenClientParamIS_DERIVEDFluent Client search parameter constant for is-derivedprotected List<CodeableConcept>jurisdictionA jurisdiction in which the SpecimenDefinition is intended to be used.protected DateTypelastReviewDateThe date on which the asset content was last reviewed.protected List<CodeableConcept>patientPreparationPreparation of the patient for specimen collection.protected ReferencepublisherHelps establish the "authority/credibility" of the SpecimenDefinition.protected MarkdownTypepurposeExplains why this SpecimeDefinition is needed and why it has been designed as it has.static StringSP_CONTAINERSearch parameter: containerstatic StringSP_EXPERIMENTALSearch parameter: experimentalstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_IS_DERIVEDSearch parameter: is-derivedstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_TYPESearch parameter: typestatic StringSP_TYPE_TESTEDSearch parameter: type-testedstatic StringSP_URLSearch parameter: urlprotected Enumeration<Enumerations.PublicationStatus>statusThe current state of theSpecimenDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DataTypesubjectA code or group definition that describes the intended subject from which this kind of specimen is to be collected.protected StringTypetimeAspectTime aspect of specimen collection (duration or offset).protected StringTypetitleA short, descriptive, user-friendly title for the SpecimenDefinition.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.TokenClientParamTYPE_TESTEDFluent Client search parameter constant for type-testedprotected CodeableConcepttypeCollectedThe kind of material to be collected.protected List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent>typeTestedSpecimen conditioned in a container as expected by the testing laboratory.protected UriTypeurlAn absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance.-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SpecimenDefinition()ConstructorSpecimenDefinition(Enumerations.PublicationStatus status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
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.
-
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 Reference 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.
-
copyright
protected MarkdownType 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.
-
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_CONTAINER
public static final String SP_CONTAINER
Search parameter: containerDescription: The type of specimen conditioned in container expected by the lab
Type: token
Path: SpecimenDefinition.typeTested.container.type
- See Also:
- Constant Field Values
-
CONTAINER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER
Fluent Client search parameter constant for containerDescription: 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: experimentalDescription: Not for genuine usage (true)
Type: token
Path: SpecimenDefinition.experimental
- See Also:
- Constant Field Values
-
EXPERIMENTAL
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
Fluent Client search parameter constant for experimentalDescription: Not for genuine usage (true)
Type: token
Path: SpecimenDefinition.experimental
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: The unique identifier associated with the SpecimenDefinition
Type: token
Path: SpecimenDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: 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-derivedDescription: Primary specimen (false) or derived specimen (true)
Type: token
Path: SpecimenDefinition.typeTested.isDerived
- See Also:
- Constant Field Values
-
IS_DERIVED
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IS_DERIVED
Fluent Client search parameter constant for is-derivedDescription: Primary specimen (false) or derived specimen (true)
Type: token
Path: SpecimenDefinition.typeTested.isDerived
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Publication status of the SpecimenDefinition: draft, active, retired, unknown
Type: token
Path: SpecimenDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Publication status of the SpecimenDefinition: draft, active, retired, unknown
Type: token
Path: SpecimenDefinition.status
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Human-friendly name of the SpecimenDefinition
Type: string
Path: SpecimenDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: Human-friendly name of the SpecimenDefinition
Type: string
Path: SpecimenDefinition.title
-
SP_TYPE_TESTED
public static final String SP_TYPE_TESTED
Search parameter: type-testedDescription: The type of specimen conditioned for testing
Type: token
Path: SpecimenDefinition.typeTested.type
- See Also:
- Constant Field Values
-
TYPE_TESTED
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE_TESTED
Fluent Client search parameter constant for type-testedDescription: The type of specimen conditioned for testing
Type: token
Path: SpecimenDefinition.typeTested.type
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: The type of collected specimen
Type: token
Path: SpecimenDefinition.typeCollected
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: The type of collected specimen
Type: token
Path: SpecimenDefinition.typeCollected
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the specimen definition
Type: uri
Path: SpecimenDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the specimen definition
Type: uri
Path: SpecimenDefinition.url
-
-
Constructor Detail
-
SpecimenDefinition
public SpecimenDefinition()
Constructor
-
SpecimenDefinition
public SpecimenDefinition(Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
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.
-
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
thisfor 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
thisfor 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.
-
getPublisher
public Reference getPublisher()
- Returns:
publisher(Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.)
-
hasPublisher
public boolean hasPublisher()
-
setPublisher
public SpecimenDefinition setPublisher(Reference value)
- Parameters:
value-publisher(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
thisfor 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
thisfor 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
thisfor 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.
-
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
thisfor 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
thisfor 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
thisfor 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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public SpecimenDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(SpecimenDefinition dst)
-
typedCopy
protected SpecimenDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-