Package org.hl7.fhir.r5.model
Class Citation.CitationCitedArtifactPublicationFormComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPublicationFormComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
Citation
public static class Citation.CitationCitedArtifactPublicationFormComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected StringType
Entry number or identifier for inclusion in a database.protected DateTimeType
The date the article was added to the database, or the date the article was released.protected CodeableConcept
Describes the form of the medium cited.protected MarkdownType
Copyright notice for the full article or artifact.protected StringType
Used for isolated representation of first page.protected StringType
Issue, part or supplement of journal or other collection in which the article is published.protected List
<CodeableConcept> The language or languages in which this form of the article is published.protected StringType
Used for isolated representation of last page.protected DateTimeType
The date the article was last revised or updated in the database.protected StringType
Actual or approximate number of pages or screens.protected StringType
Used for full display of pagination.protected StringType
Spring, Summer, Fall/Autumn, Winter.protected StringType
Text representation of the date on which the issue of the cited artifact was published.The collection the cited article or artifact is published in.protected StringType
Volume number of journal or other collection in which the article is published.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getIssue()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasIssue()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAccessionNumber
(String value) setArticleDate
(Date value) setCitedMedium
(CodeableConcept value) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setFirstPage
(String value) setFirstPageElement
(StringType value) setIssueElement
(StringType value) setLanguage
(List<CodeableConcept> theLanguage) setLastPage
(String value) setLastPageElement
(StringType value) setLastRevisionDate
(Date value) setPageCount
(String value) setPageCountElement
(StringType value) setPageString
(String value) setPageStringElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublicationDateSeason
(String value) setPublicationDateText
(String value) setVolumeElement
(StringType value) Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
publishedIn
The collection the cited article or artifact is published in. -
citedMedium
Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue. -
volume
Volume number of journal or other collection in which the article is published. -
issue
Issue, part or supplement of journal or other collection in which the article is published. -
articleDate
The date the article was added to the database, or the date the article was released. -
publicationDateText
Text representation of the date on which the issue of the cited artifact was published. -
publicationDateSeason
Spring, Summer, Fall/Autumn, Winter. -
lastRevisionDate
The date the article was last revised or updated in the database. -
language
The language or languages in which this form of the article is published. -
accessionNumber
Entry number or identifier for inclusion in a database. -
pageString
Used for full display of pagination. -
firstPage
Used for isolated representation of first page. -
lastPage
Used for isolated representation of last page. -
pageCount
Actual or approximate number of pages or screens. Distinct from reporting the page numbers. -
copyright
Copyright notice for the full article or artifact.
-
-
Constructor Details
-
CitationCitedArtifactPublicationFormComponent
Constructor
-
-
Method Details
-
getPublishedIn
- Returns:
publishedIn
(The collection the cited article or artifact is published in.)
-
hasPublishedIn
-
setPublishedIn
public Citation.CitationCitedArtifactPublicationFormComponent setPublishedIn(Citation.CitationCitedArtifactPublicationFormPublishedInComponent value) - Parameters:
value
-publishedIn
(The collection the cited article or artifact is published in.)
-
getCitedMedium
- Returns:
citedMedium
(Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.)
-
hasCitedMedium
-
setCitedMedium
- Parameters:
value
-citedMedium
(Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.)
-
getVolumeElement
- Returns:
volume
(Volume number of journal or other collection in which the article is published.). This is the underlying object with id, value and extensions. The accessor "getVolume" gives direct access to the value
-
hasVolumeElement
-
hasVolume
-
setVolumeElement
- Parameters:
value
-volume
(Volume number of journal or other collection in which the article is published.). This is the underlying object with id, value and extensions. The accessor "getVolume" gives direct access to the value
-
getVolume
- Returns:
- Volume number of journal or other collection in which the article is published.
-
setVolume
- Parameters:
value
- Volume number of journal or other collection in which the article is published.
-
getIssueElement
- Returns:
issue
(Issue, part or supplement of journal or other collection in which the article is published.). This is the underlying object with id, value and extensions. The accessor "getIssue" gives direct access to the value
-
hasIssueElement
-
hasIssue
-
setIssueElement
- Parameters:
value
-issue
(Issue, part or supplement of journal or other collection in which the article is published.). This is the underlying object with id, value and extensions. The accessor "getIssue" gives direct access to the value
-
getIssue
- Returns:
- Issue, part or supplement of journal or other collection in which the article is published.
-
setIssue
- Parameters:
value
- Issue, part or supplement of journal or other collection in which the article is published.
-
getArticleDateElement
- Returns:
articleDate
(The date the article was added to the database, or the date the article was released.). This is the underlying object with id, value and extensions. The accessor "getArticleDate" gives direct access to the value
-
hasArticleDateElement
-
hasArticleDate
-
setArticleDateElement
public Citation.CitationCitedArtifactPublicationFormComponent setArticleDateElement(DateTimeType value) - Parameters:
value
-articleDate
(The date the article was added to the database, or the date the article was released.). This is the underlying object with id, value and extensions. The accessor "getArticleDate" gives direct access to the value
-
getArticleDate
- Returns:
- The date the article was added to the database, or the date the article was released.
-
setArticleDate
- Parameters:
value
- The date the article was added to the database, or the date the article was released.
-
getPublicationDateTextElement
- Returns:
publicationDateText
(Text representation of the date on which the issue of the cited artifact was published.). This is the underlying object with id, value and extensions. The accessor "getPublicationDateText" gives direct access to the value
-
hasPublicationDateTextElement
-
hasPublicationDateText
-
setPublicationDateTextElement
public Citation.CitationCitedArtifactPublicationFormComponent setPublicationDateTextElement(StringType value) - Parameters:
value
-publicationDateText
(Text representation of the date on which the issue of the cited artifact was published.). This is the underlying object with id, value and extensions. The accessor "getPublicationDateText" gives direct access to the value
-
getPublicationDateText
- Returns:
- Text representation of the date on which the issue of the cited artifact was published.
-
setPublicationDateText
- Parameters:
value
- Text representation of the date on which the issue of the cited artifact was published.
-
getPublicationDateSeasonElement
- Returns:
publicationDateSeason
(Spring, Summer, Fall/Autumn, Winter.). This is the underlying object with id, value and extensions. The accessor "getPublicationDateSeason" gives direct access to the value
-
hasPublicationDateSeasonElement
-
hasPublicationDateSeason
-
setPublicationDateSeasonElement
public Citation.CitationCitedArtifactPublicationFormComponent setPublicationDateSeasonElement(StringType value) - Parameters:
value
-publicationDateSeason
(Spring, Summer, Fall/Autumn, Winter.). This is the underlying object with id, value and extensions. The accessor "getPublicationDateSeason" gives direct access to the value
-
getPublicationDateSeason
- Returns:
- Spring, Summer, Fall/Autumn, Winter.
-
setPublicationDateSeason
public Citation.CitationCitedArtifactPublicationFormComponent setPublicationDateSeason(String value) - Parameters:
value
- Spring, Summer, Fall/Autumn, Winter.
-
getLastRevisionDateElement
- Returns:
lastRevisionDate
(The date the article was last revised or updated in the database.). This is the underlying object with id, value and extensions. The accessor "getLastRevisionDate" gives direct access to the value
-
hasLastRevisionDateElement
-
hasLastRevisionDate
-
setLastRevisionDateElement
public Citation.CitationCitedArtifactPublicationFormComponent setLastRevisionDateElement(DateTimeType value) - Parameters:
value
-lastRevisionDate
(The date the article was last revised or updated in the database.). This is the underlying object with id, value and extensions. The accessor "getLastRevisionDate" gives direct access to the value
-
getLastRevisionDate
- Returns:
- The date the article was last revised or updated in the database.
-
setLastRevisionDate
- Parameters:
value
- The date the article was last revised or updated in the database.
-
getLanguage
- Returns:
language
(The language or languages in which this form of the article is published.)
-
setLanguage
public Citation.CitationCitedArtifactPublicationFormComponent setLanguage(List<CodeableConcept> theLanguage) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasLanguage
-
addLanguage
-
addLanguage
-
getLanguageFirstRep
- Returns:
- The first repetition of repeating field
language
, creating it if it does not already exist {3}
-
getAccessionNumberElement
- Returns:
accessionNumber
(Entry number or identifier for inclusion in a database.). This is the underlying object with id, value and extensions. The accessor "getAccessionNumber" gives direct access to the value
-
hasAccessionNumberElement
-
hasAccessionNumber
-
setAccessionNumberElement
public Citation.CitationCitedArtifactPublicationFormComponent setAccessionNumberElement(StringType value) - Parameters:
value
-accessionNumber
(Entry number or identifier for inclusion in a database.). This is the underlying object with id, value and extensions. The accessor "getAccessionNumber" gives direct access to the value
-
getAccessionNumber
- Returns:
- Entry number or identifier for inclusion in a database.
-
setAccessionNumber
- Parameters:
value
- Entry number or identifier for inclusion in a database.
-
getPageStringElement
- Returns:
pageString
(Used for full display of pagination.). This is the underlying object with id, value and extensions. The accessor "getPageString" gives direct access to the value
-
hasPageStringElement
-
hasPageString
-
setPageStringElement
public Citation.CitationCitedArtifactPublicationFormComponent setPageStringElement(StringType value) - Parameters:
value
-pageString
(Used for full display of pagination.). This is the underlying object with id, value and extensions. The accessor "getPageString" gives direct access to the value
-
getPageString
- Returns:
- Used for full display of pagination.
-
setPageString
- Parameters:
value
- Used for full display of pagination.
-
getFirstPageElement
- Returns:
firstPage
(Used for isolated representation of first page.). This is the underlying object with id, value and extensions. The accessor "getFirstPage" gives direct access to the value
-
hasFirstPageElement
-
hasFirstPage
-
setFirstPageElement
- Parameters:
value
-firstPage
(Used for isolated representation of first page.). This is the underlying object with id, value and extensions. The accessor "getFirstPage" gives direct access to the value
-
getFirstPage
- Returns:
- Used for isolated representation of first page.
-
setFirstPage
- Parameters:
value
- Used for isolated representation of first page.
-
getLastPageElement
- Returns:
lastPage
(Used for isolated representation of last page.). This is the underlying object with id, value and extensions. The accessor "getLastPage" gives direct access to the value
-
hasLastPageElement
-
hasLastPage
-
setLastPageElement
- Parameters:
value
-lastPage
(Used for isolated representation of last page.). This is the underlying object with id, value and extensions. The accessor "getLastPage" gives direct access to the value
-
getLastPage
- Returns:
- Used for isolated representation of last page.
-
setLastPage
- Parameters:
value
- Used for isolated representation of last page.
-
getPageCountElement
- Returns:
pageCount
(Actual or approximate number of pages or screens. Distinct from reporting the page numbers.). This is the underlying object with id, value and extensions. The accessor "getPageCount" gives direct access to the value
-
hasPageCountElement
-
hasPageCount
-
setPageCountElement
- Parameters:
value
-pageCount
(Actual or approximate number of pages or screens. Distinct from reporting the page numbers.). This is the underlying object with id, value and extensions. The accessor "getPageCount" gives direct access to the value
-
getPageCount
- Returns:
- Actual or approximate number of pages or screens. Distinct from reporting the page numbers.
-
setPageCount
- Parameters:
value
- Actual or approximate number of pages or screens. Distinct from reporting the page numbers.
-
getCopyrightElement
- Returns:
copyright
(Copyright notice for the full article or artifact.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
-
hasCopyright
-
setCopyrightElement
public Citation.CitationCitedArtifactPublicationFormComponent setCopyrightElement(MarkdownType value) - Parameters:
value
-copyright
(Copyright notice for the full article or artifact.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
- Returns:
- Copyright notice for the full article or artifact.
-
setCopyright
- Parameters:
value
- Copyright notice for the full article or artifact.
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
- Returns:
- the FHIR type name of the instance (not the java class name)
-