Class Citation
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.Citation
-
- 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 Citation extends DomainResource
The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Field Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the resource content was approved by the publisher.protected List<ContactDetail>authorWho authored the Citation.protected Citation.CitationCitedArtifactComponentcitedArtifactThe article or artifact being described.protected List<Citation.CitationClassificationComponent>classificationThe assignment to an organizing scheme.protected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightUse and/or publishing restrictions for the Citation, not for the cited artifact.protected List<CodeableConcept>currentStateThe status of the citation.protected DateTimeTypedateThe date (and optionally time) when the citation was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected MarkdownTypedescriptionA free text natural language description of the citation from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected List<ContactDetail>editorWho edited the Citation.static ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected PeriodeffectivePeriodThe period during which the citation content was or is planned to be in active use.protected List<ContactDetail>endorserWho endorsed the Citation.protected BooleanTypeexperimentalA Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.protected List<Identifier>identifierA formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<CodeableConcept>jurisdictionA legal or geographic region in which the citation is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected DateTypelastReviewDateThe date on which the resource content was last reviewed.protected StringTypenameA natural language name identifying the citation.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<Annotation>noteUsed for general notes and annotations not coded elsewhere.protected StringTypepublisherThe name of the organization or individual that published the citation.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this citation is needed and why it has been designed as it has.protected List<Citation.CitationRelatesToComponent>relatesToArtifact related to the Citation Resource.protected List<ContactDetail>reviewerWho reviewed the Citation.static StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this summary.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<Citation.CitationStatusDateComponent>statusDateAn effective date or period for a status of the citation.protected List<ContactDetail>summaryA human-readable display of the citation.protected StringTypetitleA short, descriptive, user-friendly title for the citation.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected UriTypeurlAn absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier.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 citation when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Citation()ConstructorCitation(Enumerations.PublicationStatus status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.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.r4b.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.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.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 URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
-
identifier
protected List<Identifier> identifier
A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version
protected StringType version
The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name
protected StringType name
A natural language name identifying the citation. 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 citation.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this summary. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType experimental
A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
date
protected DateTimeType date
The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
-
publisher
protected StringType publisher
The name of the organization or individual that published the citation.
-
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 citation from a 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the citation is intended to be used.
-
purpose
protected MarkdownType purpose
Explanation of why this citation is needed and why it has been designed as it has.
-
copyright
protected MarkdownType copyright
Use and/or publishing restrictions for the Citation, not for the cited artifact.
-
approvalDate
protected DateType approvalDate
The date on which the resource 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 resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
effectivePeriod
protected Period effectivePeriod
The period during which the citation content was or is planned to be in active use.
-
author
protected List<ContactDetail> author
Who authored the Citation.
-
editor
protected List<ContactDetail> editor
Who edited the Citation.
-
reviewer
protected List<ContactDetail> reviewer
Who reviewed the Citation.
-
endorser
protected List<ContactDetail> endorser
Who endorsed the Citation.
-
summary
protected List<ContactDetail> summary
A human-readable display of the citation.
-
classification
protected List<Citation.CitationClassificationComponent> classification
The assignment to an organizing scheme.
-
note
protected List<Annotation> note
Used for general notes and annotations not coded elsewhere.
-
currentState
protected List<CodeableConcept> currentState
The status of the citation.
-
statusDate
protected List<Citation.CitationStatusDateComponent> statusDate
An effective date or period for a status of the citation.
-
relatesTo
protected List<Citation.CitationRelatesToComponent> relatesTo
Artifact related to the Citation Resource.
-
citedArtifact
protected Citation.CitationCitedArtifactComponent citedArtifact
The article or artifact being described.
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the citation
Type: quantity
Path: (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the citation
Type: quantity
Path: (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the citation
Type: composite
Path: Citation.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the citation
Type: composite
Path: Citation.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the citation
Type: composite
Path: Citation.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the citation
Type: composite
Path: Citation.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the citation
Type: token
Path: Citation.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the citation
Type: token
Path: Citation.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the citation
Type: token
Path: (Citation.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the citation
Type: token
Path: (Citation.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The citation publication date
Type: date
Path: Citation.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The citation publication date
Type: date
Path: Citation.date
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the citation
Type: string
Path: Citation.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the citation
Type: string
Path: Citation.description
-
SP_EFFECTIVE
public static final String SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the citation is intended to be in use
Type: date
Path: Citation.effectivePeriod
- See Also:
- Constant Field Values
-
EFFECTIVE
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the citation is intended to be in use
Type: date
Path: Citation.effectivePeriod
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the citation
Type: token
Path: Citation.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the citation
Type: token
Path: Citation.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the citation
Type: token
Path: Citation.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the citation
Type: token
Path: Citation.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the citation
Type: string
Path: Citation.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the citation
Type: string
Path: Citation.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the citation
Type: string
Path: Citation.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the citation
Type: string
Path: Citation.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the citation
Type: token
Path: Citation.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the citation
Type: token
Path: Citation.status
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the citation
Type: string
Path: Citation.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the citation
Type: string
Path: Citation.title
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the citation
Type: uri
Path: Citation.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 citation
Type: uri
Path: Citation.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the citation
Type: token
Path: Citation.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the citation
Type: token
Path: Citation.version
-
-
Constructor Detail
-
Citation
public Citation()
Constructor
-
Citation
public Citation(Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.). 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 Citation setUrlElement(UriType value)
- Parameters:
value-url(An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.). 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 URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
-
setUrl
public Citation setUrl(String value)
- Parameters:
value- An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
public Citation setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Citation addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Returns:
version(The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). 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 Citation setVersionElement(StringType value)
- Parameters:
value-version(The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). 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 citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
setVersion
public Citation setVersion(String value)
- Parameters:
value- The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
getNameElement
public StringType getNameElement()
- Returns:
name(A natural language name identifying the citation. 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 Citation setNameElement(StringType value)
- Parameters:
value-name(A natural language name identifying the citation. 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 citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
public Citation setName(String value)
- Parameters:
value- A natural language name identifying the citation. 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 citation.). 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 Citation setTitleElement(StringType value)
- Parameters:
value-title(A short, descriptive, user-friendly title for the citation.). 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 citation.
-
setTitle
public Citation setTitle(String value)
- Parameters:
value- A short, descriptive, user-friendly title for the citation.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status(The status of this summary. Enables tracking the life-cycle of the content.). 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 Citation setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value-status(The status of this summary. Enables tracking the life-cycle of the content.). 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 status of this summary. Enables tracking the life-cycle of the content.
-
setStatus
public Citation setStatus(Enumerations.PublicationStatus value)
- Parameters:
value- The status of this summary. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental(A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used 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 Citation setExperimentalElement(BooleanType value)
- Parameters:
value-experimental(A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used 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 Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
setExperimental
public Citation setExperimental(boolean value)
- Parameters:
value- A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.). 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 Citation setDateElement(DateTimeType value)
- Parameters:
value-date(The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
-
setDate
public Citation setDate(Date value)
- Parameters:
value- The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(The name of the organization or individual that published the citation.). 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 Citation setPublisherElement(StringType value)
- Parameters:
value-publisher(The name of the organization or individual that published the citation.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- The name of the organization or individual that published the citation.
-
setPublisher
public Citation setPublisher(String value)
- Parameters:
value- The name of the organization or individual that published the citation.
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public Citation setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public Citation 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 citation from a 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 Citation setDescriptionElement(MarkdownType value)
- Parameters:
value-description(A free text natural language description of the citation from a 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 citation from a consumer's perspective.
-
setDescription
public Citation setDescription(String value)
- Parameters:
value- A free text natural language description of the citation from a 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.)
-
setUseContext
public Citation setUseContext(List<UsageContext> theUseContext)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public UsageContext addUseContext()
-
addUseContext
public Citation 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 legal or geographic region in which the citation is intended to be used.)
-
setJurisdiction
public Citation setJurisdiction(List<CodeableConcept> theJurisdiction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
-
addJurisdiction
public CodeableConcept addJurisdiction()
-
addJurisdiction
public Citation 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(Explanation of why this citation 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 Citation setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explanation of why this citation 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:
- Explanation of why this citation is needed and why it has been designed as it has.
-
setPurpose
public Citation setPurpose(String value)
- Parameters:
value- Explanation of why this citation is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(Use and/or publishing restrictions for the Citation, not for the cited artifact.). 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 Citation setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(Use and/or publishing restrictions for the Citation, not for the cited artifact.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- Use and/or publishing restrictions for the Citation, not for the cited artifact.
-
setCopyright
public Citation setCopyright(String value)
- Parameters:
value- Use and/or publishing restrictions for the Citation, not for the cited artifact.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- Returns:
approvalDate(The date on which the resource 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 Citation setApprovalDateElement(DateType value)
- Parameters:
value-approvalDate(The date on which the resource 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 resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
public Citation setApprovalDate(Date value)
- Parameters:
value- The date on which the resource 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 resource content was last reviewed. Review happens periodically after approval but does not 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 Citation setLastReviewDateElement(DateType value)
- Parameters:
value-lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not 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 resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
setLastReviewDate
public Citation setLastReviewDate(Date value)
- Parameters:
value- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Returns:
effectivePeriod(The period during which the citation content was or is planned to be in active use.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
setEffectivePeriod
public Citation setEffectivePeriod(Period value)
- Parameters:
value-effectivePeriod(The period during which the citation content was or is planned to be in active use.)
-
getAuthor
public List<ContactDetail> getAuthor()
- Returns:
author(Who authored the Citation.)
-
setAuthor
public Citation setAuthor(List<ContactDetail> theAuthor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
-
addAuthor
public ContactDetail addAuthor()
-
addAuthor
public Citation addAuthor(ContactDetail t)
-
getAuthorFirstRep
public ContactDetail getAuthorFirstRep()
- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getEditor
public List<ContactDetail> getEditor()
- Returns:
editor(Who edited the Citation.)
-
setEditor
public Citation setEditor(List<ContactDetail> theEditor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEditor
public boolean hasEditor()
-
addEditor
public ContactDetail addEditor()
-
addEditor
public Citation addEditor(ContactDetail t)
-
getEditorFirstRep
public ContactDetail getEditorFirstRep()
- Returns:
- The first repetition of repeating field
editor, creating it if it does not already exist {3}
-
getReviewer
public List<ContactDetail> getReviewer()
- Returns:
reviewer(Who reviewed the Citation.)
-
setReviewer
public Citation setReviewer(List<ContactDetail> theReviewer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReviewer
public boolean hasReviewer()
-
addReviewer
public ContactDetail addReviewer()
-
addReviewer
public Citation addReviewer(ContactDetail t)
-
getReviewerFirstRep
public ContactDetail getReviewerFirstRep()
- Returns:
- The first repetition of repeating field
reviewer, creating it if it does not already exist {3}
-
getEndorser
public List<ContactDetail> getEndorser()
- Returns:
endorser(Who endorsed the Citation.)
-
setEndorser
public Citation setEndorser(List<ContactDetail> theEndorser)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndorser
public boolean hasEndorser()
-
addEndorser
public ContactDetail addEndorser()
-
addEndorser
public Citation addEndorser(ContactDetail t)
-
getEndorserFirstRep
public ContactDetail getEndorserFirstRep()
- Returns:
- The first repetition of repeating field
endorser, creating it if it does not already exist {3}
-
getSummary
public List<ContactDetail> getSummary()
- Returns:
summary(A human-readable display of the citation.)
-
setSummary
public Citation setSummary(List<ContactDetail> theSummary)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSummary
public boolean hasSummary()
-
addSummary
public ContactDetail addSummary()
-
addSummary
public Citation addSummary(ContactDetail t)
-
getSummaryFirstRep
public ContactDetail getSummaryFirstRep()
- Returns:
- The first repetition of repeating field
summary, creating it if it does not already exist {3}
-
getClassification
public List<Citation.CitationClassificationComponent> getClassification()
- Returns:
classification(The assignment to an organizing scheme.)
-
setClassification
public Citation setClassification(List<Citation.CitationClassificationComponent> theClassification)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasClassification
public boolean hasClassification()
-
addClassification
public Citation.CitationClassificationComponent addClassification()
-
addClassification
public Citation addClassification(Citation.CitationClassificationComponent t)
-
getClassificationFirstRep
public Citation.CitationClassificationComponent getClassificationFirstRep()
- Returns:
- The first repetition of repeating field
classification, creating it if it does not already exist {3}
-
getNote
public List<Annotation> getNote()
- Returns:
note(Used for general notes and annotations not coded elsewhere.)
-
setNote
public Citation setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public Citation addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
getCurrentState
public List<CodeableConcept> getCurrentState()
- Returns:
currentState(The status of the citation.)
-
setCurrentState
public Citation setCurrentState(List<CodeableConcept> theCurrentState)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCurrentState
public boolean hasCurrentState()
-
addCurrentState
public CodeableConcept addCurrentState()
-
addCurrentState
public Citation addCurrentState(CodeableConcept t)
-
getCurrentStateFirstRep
public CodeableConcept getCurrentStateFirstRep()
- Returns:
- The first repetition of repeating field
currentState, creating it if it does not already exist {3}
-
getStatusDate
public List<Citation.CitationStatusDateComponent> getStatusDate()
- Returns:
statusDate(An effective date or period for a status of the citation.)
-
setStatusDate
public Citation setStatusDate(List<Citation.CitationStatusDateComponent> theStatusDate)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasStatusDate
public boolean hasStatusDate()
-
addStatusDate
public Citation.CitationStatusDateComponent addStatusDate()
-
addStatusDate
public Citation addStatusDate(Citation.CitationStatusDateComponent t)
-
getStatusDateFirstRep
public Citation.CitationStatusDateComponent getStatusDateFirstRep()
- Returns:
- The first repetition of repeating field
statusDate, creating it if it does not already exist {3}
-
getRelatesTo
public List<Citation.CitationRelatesToComponent> getRelatesTo()
- Returns:
relatesTo(Artifact related to the Citation Resource.)
-
setRelatesTo
public Citation setRelatesTo(List<Citation.CitationRelatesToComponent> theRelatesTo)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatesTo
public boolean hasRelatesTo()
-
addRelatesTo
public Citation.CitationRelatesToComponent addRelatesTo()
-
addRelatesTo
public Citation addRelatesTo(Citation.CitationRelatesToComponent t)
-
getRelatesToFirstRep
public Citation.CitationRelatesToComponent getRelatesToFirstRep()
- Returns:
- The first repetition of repeating field
relatesTo, creating it if it does not already exist {3}
-
getCitedArtifact
public Citation.CitationCitedArtifactComponent getCitedArtifact()
- Returns:
citedArtifact(The article or artifact being described.)
-
hasCitedArtifact
public boolean hasCitedArtifact()
-
setCitedArtifact
public Citation setCitedArtifact(Citation.CitationCitedArtifactComponent value)
- Parameters:
value-citedArtifact(The article or artifact being described.)
-
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 Citation copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Citation dst)
-
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
-
-