Package org.hl7.fhir.r5.model

Class MetadataResource

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.CanonicalResource

org.hl7.fhir.r5.model.MetadataResource

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

Direct Known Subclasses:

ActivityDefinition, ChargeItemDefinition, Citation, CodeSystem, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, Library, Measure, NamingSystem, PlanDefinition, Questionnaire, ValueSet

public abstract class MetadataResource
extends CanonicalResource

Common Interface declaration for conformance and knowledge artifact resources.

See Also:

• Serialized Form

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

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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
MetadataResource()	Constructor

Method Summary

Modifier and Type	Method	Description
abstract ContactDetail	addAuthor()
abstract MetadataResource	addAuthor(ContactDetail t)
Base	addChild(String name)
abstract ContactDetail	addEditor()
abstract MetadataResource	addEditor(ContactDetail t)
abstract ContactDetail	addEndorser()
abstract MetadataResource	addEndorser(ContactDetail t)
abstract RelatedArtifact	addRelatedArtifact()
abstract MetadataResource	addRelatedArtifact(RelatedArtifact t)
abstract ContactDetail	addReviewer()
abstract MetadataResource	addReviewer(ContactDetail t)
abstract CodeableConcept	addTopic()
abstract MetadataResource	addTopic(CodeableConcept t)
abstract MetadataResource	copy()
void	copyValues(MetadataResource dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
abstract Date	getApprovalDate()
abstract DateType	getApprovalDateElement()
int	getApprovalDateMax()	How many allowed for this property by the implementation
abstract List<ContactDetail>	getAuthor()
abstract ContactDetail	getAuthorFirstRep()
int	getAuthorMax()	How many allowed for this property by the implementation
abstract List<ContactDetail>	getEditor()
abstract ContactDetail	getEditorFirstRep()
int	getEditorMax()	How many allowed for this property by the implementation
abstract Period	getEffectivePeriod()
int	getEffectivePeriodMax()	How many allowed for this property by the implementation
abstract List<ContactDetail>	getEndorser()
abstract ContactDetail	getEndorserFirstRep()
int	getEndorserMax()	How many allowed for this property by the implementation
abstract Date	getLastReviewDate()
abstract DateType	getLastReviewDateElement()
int	getLastReviewDateMax()	How many allowed for this property by the implementation
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
abstract List<RelatedArtifact>	getRelatedArtifact()
abstract RelatedArtifact	getRelatedArtifactFirstRep()
int	getRelatedArtifactMax()	How many allowed for this property by the implementation
abstract List<ContactDetail>	getReviewer()
abstract ContactDetail	getReviewerFirstRep()
int	getReviewerMax()	How many allowed for this property by the implementation
abstract List<CodeableConcept>	getTopic()
abstract CodeableConcept	getTopicFirstRep()
int	getTopicMax()	How many allowed for this property by the implementation
String[]	getTypesForProperty(int hash, String name)
abstract boolean	hasApprovalDate()
abstract boolean	hasApprovalDateElement()
abstract boolean	hasAuthor()
abstract boolean	hasEditor()
abstract boolean	hasEffectivePeriod()
abstract boolean	hasEndorser()
abstract boolean	hasLastReviewDate()
abstract boolean	hasLastReviewDateElement()
abstract boolean	hasRelatedArtifact()
abstract boolean	hasReviewer()
abstract boolean	hasTopic()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
abstract MetadataResource	setApprovalDate(Date value)
abstract MetadataResource	setApprovalDateElement(DateType value)
abstract MetadataResource	setAuthor(List<ContactDetail> theAuthor)
abstract MetadataResource	setEditor(List<ContactDetail> theEditor)
abstract MetadataResource	setEffectivePeriod(Period value)
abstract MetadataResource	setEndorser(List<ContactDetail> theEndorser)
abstract MetadataResource	setLastReviewDate(Date value)
abstract MetadataResource	setLastReviewDateElement(DateType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
abstract MetadataResource	setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
abstract MetadataResource	setReviewer(List<ContactDetail> theReviewer)
abstract MetadataResource	setTopic(List<CodeableConcept> theTopic)

Methods inherited from class org.hl7.fhir.r5.model.CanonicalResource

addContact, addContact, addIdentifier, addIdentifier, addJurisdiction, addJurisdiction, addUseContext, addUseContext, copyValues, getContact, getContactFirstRep, getContactMax, getCopyright, getCopyrightElement, getCopyrightLabel, getCopyrightLabelElement, getCopyrightLabelMax, getCopyrightMax, getDate, getDateElement, getDateMax, getDescription, getDescriptionElement, getDescriptionMax, getExperimental, getExperimentalElement, getExperimentalMax, getIdentifier, getIdentifierFirstRep, getIdentifierMax, getJurisdiction, getJurisdictionFirstRep, getJurisdictionMax, getName, getNameElement, getNameMax, getOid, getPublisher, getPublisherElement, getPublisherMax, getPurpose, getPurposeElement, getPurposeMax, getStatus, getStatusElement, getStatusMax, getTitle, getTitleElement, getTitleMax, getUrl, getUrlElement, getUrlMax, getUseContext, getUseContextFirstRep, getUseContextMax, getVersion, getVersionAlgorithm, getVersionAlgorithmCoding, getVersionAlgorithmMax, getVersionAlgorithmStringType, getVersionedUrl, getVersionElement, getVersionMax, getVUrl, hasContact, hasCopyright, hasCopyrightElement, hasCopyrightLabel, hasCopyrightLabelElement, hasDate, hasDateElement, hasDescription, hasDescriptionElement, hasExperimental, hasExperimentalElement, hasIdentifier, hasJurisdiction, hasName, hasNameElement, hasPublisher, hasPublisherElement, hasPurpose, hasPurposeElement, hasStatus, hasStatusElement, hasTitle, hasTitleElement, hasUrl, hasUrlElement, hasUseContext, hasVersion, hasVersionAlgorithm, hasVersionAlgorithmCoding, hasVersionAlgorithmStringType, hasVersionElement, oid, present, setContact, setCopyright, setCopyrightElement, setCopyrightLabel, setCopyrightLabelElement, setDate, setDateElement, setDescription, setDescriptionElement, setExperimental, setExperimentalElement, setIdentifier, setJurisdiction, setName, setNameElement, setPublisher, setPublisherElement, setPurpose, setPurposeElement, setStatus, setStatusElement, setTitle, setTitleElement, setUrl, setUrlElement, setUseContext, setVersion, setVersionAlgorithm, setVersionElement, supportsCopyright, toString

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getResourceType, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Constructor Details

MetadataResource

public MetadataResource()

Constructor

Method Details

getApprovalDateMax

public int getApprovalDateMax()

How many allowed for this property by the implementation

getApprovalDateElement

public abstract 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 abstract boolean hasApprovalDateElement()

hasApprovalDate

public abstract boolean hasApprovalDate()

setApprovalDateElement

public abstract MetadataResource 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 abstract 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 abstract MetadataResource 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.

getLastReviewDateMax

public int getLastReviewDateMax()

How many allowed for this property by the implementation

getLastReviewDateElement

public abstract 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 abstract boolean hasLastReviewDateElement()

hasLastReviewDate

public abstract boolean hasLastReviewDate()

setLastReviewDateElement

public abstract MetadataResource 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 abstract 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 abstract MetadataResource 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.

getEffectivePeriodMax

public int getEffectivePeriodMax()

How many allowed for this property by the implementation

getEffectivePeriod

public abstract Period getEffectivePeriod()

Returns:

#effectivePeriod (The period during which the metadata resource content was or is planned to be in active use.)

hasEffectivePeriod

public abstract boolean hasEffectivePeriod()

setEffectivePeriod

public abstract MetadataResource setEffectivePeriod(Period value)

Parameters:

value - #effectivePeriod (The period during which the metadata resource content was or is planned to be in active use.)

getTopicMax

public int getTopicMax()

How many allowed for this property by the implementation

getTopic

public abstract List<CodeableConcept> getTopic()

Returns:

#topic (Descriptive topics related to the content of the metadata resource. Topics provide a high-level categorization as well as keywords for the metadata resource that can be useful for filtering and searching.)

setTopic

public abstract MetadataResource setTopic(List<CodeableConcept> theTopic)

Returns:

Returns a reference to this for easy method chaining

hasTopic

public abstract boolean hasTopic()

addTopic

public abstract CodeableConcept addTopic()

addTopic

public abstract MetadataResource addTopic(CodeableConcept t)

getTopicFirstRep

public abstract CodeableConcept getTopicFirstRep()

Returns:

The first repetition of repeating field #topic, creating it if it does not already exist {1}

getAuthorMax

public int getAuthorMax()

How many allowed for this property by the implementation

getAuthor

public abstract List<ContactDetail> getAuthor()

Returns:

#author (An individiual or organization primarily involved in the creation and maintenance of the metadata resource.)

setAuthor

public abstract MetadataResource setAuthor(List<ContactDetail> theAuthor)

Returns:

Returns a reference to this for easy method chaining

hasAuthor

public abstract boolean hasAuthor()

addAuthor

public abstract ContactDetail addAuthor()

addAuthor

public abstract MetadataResource addAuthor(ContactDetail t)

getAuthorFirstRep

public abstract ContactDetail getAuthorFirstRep()

Returns:

The first repetition of repeating field #author, creating it if it does not already exist {1}

getEditorMax

public int getEditorMax()

How many allowed for this property by the implementation

getEditor

public abstract List<ContactDetail> getEditor()

Returns:

#editor (An individual or organization primarily responsible for internal coherence of the metadata resource.)

setEditor

public abstract MetadataResource setEditor(List<ContactDetail> theEditor)

Returns:

Returns a reference to this for easy method chaining

hasEditor

public abstract boolean hasEditor()

addEditor

public abstract ContactDetail addEditor()

addEditor

public abstract MetadataResource addEditor(ContactDetail t)

getEditorFirstRep

public abstract ContactDetail getEditorFirstRep()

Returns:

The first repetition of repeating field #editor, creating it if it does not already exist {1}

getReviewerMax

public int getReviewerMax()

How many allowed for this property by the implementation

getReviewer

public abstract List<ContactDetail> getReviewer()

Returns:

#reviewer (An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the metadata resource.)

setReviewer

public abstract MetadataResource setReviewer(List<ContactDetail> theReviewer)

Returns:

Returns a reference to this for easy method chaining

hasReviewer

public abstract boolean hasReviewer()

addReviewer

public abstract ContactDetail addReviewer()

addReviewer

public abstract MetadataResource addReviewer(ContactDetail t)

getReviewerFirstRep

public abstract ContactDetail getReviewerFirstRep()

Returns:

The first repetition of repeating field #reviewer, creating it if it does not already exist {1}

getEndorserMax

public int getEndorserMax()

How many allowed for this property by the implementation

getEndorser

public abstract List<ContactDetail> getEndorser()

Returns:

#endorser (An individual or organization asserted by the publisher to be responsible for officially endorsing the metadata resource for use in some setting.)

setEndorser

public abstract MetadataResource setEndorser(List<ContactDetail> theEndorser)

Returns:

Returns a reference to this for easy method chaining

hasEndorser

public abstract boolean hasEndorser()

addEndorser

public abstract ContactDetail addEndorser()

addEndorser

public abstract MetadataResource addEndorser(ContactDetail t)

getEndorserFirstRep

public abstract ContactDetail getEndorserFirstRep()

Returns:

The first repetition of repeating field #endorser, creating it if it does not already exist {1}

getRelatedArtifactMax

public int getRelatedArtifactMax()

How many allowed for this property by the implementation

getRelatedArtifact

public abstract List<RelatedArtifact> getRelatedArtifact()

Returns:

#relatedArtifact (Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.)

setRelatedArtifact

public abstract MetadataResource setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)

Returns:

Returns a reference to this for easy method chaining

hasRelatedArtifact

public abstract boolean hasRelatedArtifact()

addRelatedArtifact

public abstract RelatedArtifact addRelatedArtifact()

addRelatedArtifact

public abstract MetadataResource addRelatedArtifact(RelatedArtifact t)

getRelatedArtifactFirstRep

public abstract RelatedArtifact getRelatedArtifactFirstRep()

Returns:

The first repetition of repeating field #relatedArtifact, creating it if it does not already exist {1}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class CanonicalResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class CanonicalResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class CanonicalResource

copy

public abstract MetadataResource copy()

Specified by:

copy in class CanonicalResource

copyValues

public void copyValues(MetadataResource dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class CanonicalResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class CanonicalResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class CanonicalResource