![](/hapi-fhir/images/logos/raccoon-forwards.png)
Package org.hl7.fhir.r5.model
Class CanonicalResource
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
- 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:
ActorDefinition
,CapabilityStatement
,CompartmentDefinition
,ExampleScenario
,GraphDefinition
,ImplementationGuide
,MessageDefinition
,MetadataResource
,OperationDefinition
,Requirements
,SearchParameter
,StructureDefinition
,StructureMap
,SubscriptionTopic
,TerminologyCapabilities
,TestPlan
,TestScript
Common Interface declaration for conformance and knowledge artifact resources.
- 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
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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionabstract ContactDetail
abstract CanonicalResource
abstract Identifier
abstract CanonicalResource
abstract CodeableConcept
abstract CanonicalResource
abstract UsageContext
abstract CanonicalResource
abstract CanonicalResource
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
abstract List
<ContactDetail> abstract ContactDetail
int
How many allowed for this property by the implementationabstract String
abstract MarkdownType
abstract String
abstract StringType
int
How many allowed for this property by the implementationint
How many allowed for this property by the implementationabstract Date
getDate()
abstract DateTimeType
int
How many allowed for this property by the implementationabstract String
abstract MarkdownType
int
How many allowed for this property by the implementationabstract boolean
abstract BooleanType
int
How many allowed for this property by the implementationabstract List
<Identifier> abstract Identifier
int
How many allowed for this property by the implementationabstract List
<CodeableConcept> abstract CodeableConcept
int
How many allowed for this property by the implementationabstract String
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) abstract StringType
int
How many allowed for this property by the implementationgetOid()
Base[]
getProperty
(int hash, String name, boolean checkValid) abstract String
abstract StringType
int
How many allowed for this property by the implementationabstract String
abstract MarkdownType
int
How many allowed for this property by the implementationabstract Enumerations.PublicationStatus
abstract Enumeration
<Enumerations.PublicationStatus> int
How many allowed for this property by the implementationabstract String
getTitle()
abstract StringType
int
How many allowed for this property by the implementationString[]
getTypesForProperty
(int hash, String name) abstract String
getUrl()
abstract UriType
int
How many allowed for this property by the implementationabstract List
<UsageContext> abstract UsageContext
int
How many allowed for this property by the implementationabstract String
abstract DataType
abstract Coding
int
How many allowed for this property by the implementationabstract StringType
abstract StringType
int
How many allowed for this property by the implementationgetVUrl()
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
hasDate()
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
hasName()
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
hasTitle()
abstract boolean
abstract boolean
hasUrl()
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) oid()
present()
void
removeChild
(String name, Base value) abstract CanonicalResource
setContact
(List<ContactDetail> theContact) abstract CanonicalResource
setCopyright
(String value) abstract CanonicalResource
setCopyrightElement
(MarkdownType value) abstract CanonicalResource
setCopyrightLabel
(String value) abstract CanonicalResource
abstract CanonicalResource
abstract CanonicalResource
setDateElement
(DateTimeType value) abstract CanonicalResource
setDescription
(String value) abstract CanonicalResource
abstract CanonicalResource
setExperimental
(boolean value) abstract CanonicalResource
abstract CanonicalResource
setIdentifier
(List<Identifier> theIdentifier) abstract CanonicalResource
setJurisdiction
(List<CodeableConcept> theJurisdiction) abstract CanonicalResource
abstract CanonicalResource
setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) abstract CanonicalResource
setPublisher
(String value) abstract CanonicalResource
setPublisherElement
(StringType value) abstract CanonicalResource
setPurpose
(String value) abstract CanonicalResource
setPurposeElement
(MarkdownType value) abstract CanonicalResource
abstract CanonicalResource
abstract CanonicalResource
abstract CanonicalResource
setTitleElement
(StringType value) abstract CanonicalResource
abstract CanonicalResource
setUrlElement
(UriType value) abstract CanonicalResource
setUseContext
(List<UsageContext> theUseContext) abstract CanonicalResource
setVersion
(String value) abstract CanonicalResource
setVersionAlgorithm
(DataType value) abstract CanonicalResource
setVersionElement
(StringType value) boolean
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, getFHIRPublicationVersion, 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, 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, listChildrenByName, listChildrenByName, primitiveValue, 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
-
CanonicalResource
public CanonicalResource()Constructor -
CanonicalResource
Constructor
-
-
Method Details
-
getUrlMax
How many allowed for this property by the implementation -
getUrlElement
- Returns:
-
invalid reference
#url
-
hasUrlElement
-
hasUrl
-
setUrlElement
- Parameters:
value
-invalid reference
#url
-
getUrl
- Returns:
- An absolute URI that is used to identify this canonical resource 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 an authoritative instance of this canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.
-
setUrl
- Parameters:
value
- An absolute URI that is used to identify this canonical resource 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 an authoritative instance of this canonical resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the canonical resource is stored on different servers.
-
getIdentifierMax
How many allowed for this property by the implementation -
getIdentifier
- Returns:
-
invalid reference
#identifier
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
invalid reference
#identifier
-
getVersionMax
How many allowed for this property by the implementation -
getVersionElement
- Returns:
-
invalid reference
#version
-
hasVersionElement
-
hasVersion
-
setVersionElement
- Parameters:
value
-invalid reference
#version
-
getVersion
- Returns:
- The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 without additional knowledge. (See the versionAlgorithm element.)
-
setVersion
- Parameters:
value
- The identifier that is used to identify this version of the canonical resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the canonical resource 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 without additional knowledge. (See the versionAlgorithm element.)
-
getVersionAlgorithmMax
How many allowed for this property by the implementation -
getVersionAlgorithm
- Returns:
-
invalid reference
#versionAlgorithm
-
getVersionAlgorithmStringType
public abstract StringType getVersionAlgorithmStringType() throws org.hl7.fhir.exceptions.FHIRException- Returns:
-
invalid reference
#versionAlgorithm
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersionAlgorithmStringType
-
getVersionAlgorithmCoding
- Returns:
-
invalid reference
#versionAlgorithm
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersionAlgorithmCoding
-
hasVersionAlgorithm
-
setVersionAlgorithm
- Parameters:
value
-invalid reference
#versionAlgorithm
-
getNameMax
How many allowed for this property by the implementation -
getNameElement
- Returns:
-
invalid reference
#name
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-invalid reference
#name
-
getName
- Returns:
- A natural language name identifying the canonical resource. This name should be usable as an identifier for the resource by machine processing applications such as code generation.
-
setName
- Parameters:
value
- A natural language name identifying the canonical resource. This name should be usable as an identifier for the resource by machine processing applications such as code generation.
-
getTitleMax
How many allowed for this property by the implementation -
getTitleElement
- Returns:
-
invalid reference
#title
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-invalid reference
#title
-
getTitle
- Returns:
- A short, descriptive, user-friendly title for the canonical resource.
-
setTitle
- Parameters:
value
- A short, descriptive, user-friendly title for the canonical resource.
-
getStatusMax
How many allowed for this property by the implementation -
getStatusElement
- Returns:
-
invalid reference
#status
-
hasStatusElement
-
hasStatus
-
setStatusElement
public abstract CanonicalResource setStatusElement(Enumeration<Enumerations.PublicationStatus> value) - Parameters:
value
-invalid reference
#status
-
getStatus
- Returns:
- The current state of this canonical resource.
-
setStatus
- Parameters:
value
- The current state of this canonical resource.
-
getExperimentalMax
How many allowed for this property by the implementation -
getExperimentalElement
- Returns:
-
invalid reference
#experimental
-
hasExperimentalElement
-
hasExperimental
-
setExperimentalElement
- Parameters:
value
-invalid reference
#experimental
-
getExperimental
- Returns:
- A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.
-
setExperimental
- Parameters:
value
- A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.
-
getDateMax
How many allowed for this property by the implementation -
getDateElement
- Returns:
-
invalid reference
#date
-
hasDateElement
-
hasDate
-
setDateElement
- Parameters:
value
-invalid reference
#date
-
getDate
- Returns:
- The date (and optionally time) when the canonical resource was last significantly changed. 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 canonical resource changes.
-
setDate
- Parameters:
value
- The date (and optionally time) when the canonical resource was last significantly changed. 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 canonical resource changes.
-
getPublisherMax
How many allowed for this property by the implementation -
getPublisherElement
- Returns:
-
invalid reference
#publisher
-
hasPublisherElement
-
hasPublisher
-
setPublisherElement
- Parameters:
value
-invalid reference
#publisher
-
getPublisher
- Returns:
- The name of the organization or individual responsible for the release and ongoing maintenance of the canonical resource.
-
setPublisher
- Parameters:
value
- The name of the organization or individual responsible for the release and ongoing maintenance of the canonical resource.
-
getContactMax
How many allowed for this property by the implementation -
getContact
- Returns:
-
invalid reference
#contact
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
invalid reference
#contact
-
getDescriptionMax
How many allowed for this property by the implementation -
getDescriptionElement
- Returns:
-
invalid reference
#description
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-invalid reference
#description
-
getDescription
- Returns:
- A free text natural language description of the canonical resource from a consumer's perspective.
-
setDescription
- Parameters:
value
- A free text natural language description of the canonical resource from a consumer's perspective.
-
getUseContextMax
How many allowed for this property by the implementation -
getUseContext
- Returns:
-
invalid reference
#useContext
-
setUseContext
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
-
addUseContext
-
addUseContext
-
getUseContextFirstRep
- Returns:
- The first repetition of repeating field
invalid reference
#useContext
-
getJurisdictionMax
How many allowed for this property by the implementation -
getJurisdiction
- Returns:
-
invalid reference
#jurisdiction
-
setJurisdiction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
-
addJurisdiction
-
addJurisdiction
-
getJurisdictionFirstRep
- Returns:
- The first repetition of repeating field
invalid reference
#jurisdiction
-
getPurposeMax
How many allowed for this property by the implementation -
getPurposeElement
- Returns:
-
invalid reference
#purpose
-
hasPurposeElement
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-invalid reference
#purpose
-
getPurpose
- Returns:
- Explanation of why this canonical resource is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explanation of why this canonical resource is needed and why it has been designed as it has.
-
getCopyrightMax
How many allowed for this property by the implementation -
getCopyrightElement
- Returns:
-
invalid reference
#copyright
-
hasCopyrightElement
-
hasCopyright
-
setCopyrightElement
- Parameters:
value
-invalid reference
#copyright
-
getCopyright
- Returns:
- A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.
-
setCopyright
- Parameters:
value
- A copyright statement relating to the canonical resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the canonical resource.
-
getCopyrightLabelMax
How many allowed for this property by the implementation -
getCopyrightLabelElement
- Returns:
-
invalid reference
#copyrightLabel
-
hasCopyrightLabelElement
-
hasCopyrightLabel
-
setCopyrightLabelElement
- Parameters:
value
-invalid reference
#copyrightLabel
-
getCopyrightLabel
- Returns:
- A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
-
setCopyrightLabel
- Parameters:
value
- A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
toString
-
present
-
getVUrl
-
supportsCopyright
-
getVersionedUrl
-
oid
-
getOid
-