Class 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:
CapabilityStatement, CapabilityStatement2, CodeSystem, CompartmentDefinition, ConceptMap, ConceptMap2, ExampleScenario, GraphDefinition, ImplementationGuide, MessageDefinition, MetadataResource, NamingSystem, OperationDefinition, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript, ValueSet

public abstract class CanonicalResource extends DomainResource
Common Ancestor declaration for conformance and knowledge artifact resources.
See Also:
  • Constructor Details

  • Method Details

    • getUrlMax

      public int getUrlMax()
      How many allowed for this property by the implementation
    • getUrlElement

      public abstract UriType getUrlElement()
      Returns:
      #url (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 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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
    • hasUrlElement

      public abstract boolean hasUrlElement()
    • hasUrl

      public abstract boolean hasUrl()
    • setUrlElement

      public abstract CanonicalResource setUrlElement(UriType value)
      Parameters:
      value - #url (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 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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
    • getUrl

      public abstract String 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 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

      public abstract CanonicalResource setUrl(String value)
      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 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

      public int getIdentifierMax()
      How many allowed for this property by the implementation
    • getIdentifier

      public abstract List<Identifier> getIdentifier()
      Returns:
      #identifier (A formal identifier that is used to identify this canonical resource when it is represented in other formats, or referenced in a specification, model, design or an instance.)
    • setIdentifier

      public abstract CanonicalResource setIdentifier(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining
    • hasIdentifier

      public abstract boolean hasIdentifier()
    • addIdentifier

      public abstract Identifier addIdentifier()
    • addIdentifier

    • getIdentifierFirstRep

      public abstract Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field #identifier, creating it if it does not already exist {1}
    • getVersionMax

      public int getVersionMax()
      How many allowed for this property by the implementation
    • getVersionElement

      public abstract StringType getVersionElement()
      Returns:
      #version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
    • hasVersionElement

      public abstract boolean hasVersionElement()
    • hasVersion

      public abstract boolean hasVersion()
    • setVersionElement

      Parameters:
      value - #version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
    • getVersion

      public abstract String 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.
    • setVersion

      public abstract CanonicalResource setVersion(String value)
      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.
    • getNameMax

      public int getNameMax()
      How many allowed for this property by the implementation
    • getNameElement

      public abstract StringType getNameElement()
      Returns:
      #name (A natural language name identifying the canonical resource. 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 abstract boolean hasNameElement()
    • hasName

      public abstract boolean hasName()
    • setNameElement

      public abstract CanonicalResource setNameElement(StringType value)
      Parameters:
      value - #name (A natural language name identifying the canonical resource. 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 abstract String getName()
      Returns:
      A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • setName

      public abstract CanonicalResource setName(String value)
      Parameters:
      value - A natural language name identifying the canonical resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • getTitleMax

      public int getTitleMax()
      How many allowed for this property by the implementation
    • getTitleElement

      public abstract StringType getTitleElement()
      Returns:
      #title (A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
    • hasTitleElement

      public abstract boolean hasTitleElement()
    • hasTitle

      public abstract boolean hasTitle()
    • setTitleElement

      public abstract CanonicalResource setTitleElement(StringType value)
      Parameters:
      value - #title (A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
    • getTitle

      public abstract String getTitle()
      Returns:
      A short, descriptive, user-friendly title for the canonical resource.
    • setTitle

      public abstract CanonicalResource setTitle(String value)
      Parameters:
      value - A short, descriptive, user-friendly title for the canonical resource.
    • getStatusMax

      public int getStatusMax()
      How many allowed for this property by the implementation
    • getStatusElement

      Returns:
      #status (The status of this canonical resource. 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 abstract boolean hasStatusElement()
    • hasStatus

      public abstract boolean hasStatus()
    • setStatusElement

      Parameters:
      value - #status (The status of this canonical resource. 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

      Returns:
      The status of this canonical resource. Enables tracking the life-cycle of the content.
    • setStatus

      Parameters:
      value - The status of this canonical resource. Enables tracking the life-cycle of the content.
    • getExperimentalMax

      public int getExperimentalMax()
      How many allowed for this property by the implementation
    • getExperimentalElement

      Returns:
      #experimental (A Boolean value to indicate that this canonical resource 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 abstract boolean hasExperimentalElement()
    • hasExperimental

      public abstract boolean hasExperimental()
    • setExperimentalElement

      Parameters:
      value - #experimental (A Boolean value to indicate that this canonical resource 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 abstract boolean getExperimental()
      Returns:
      A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • setExperimental

      public abstract CanonicalResource setExperimental(boolean value)
      Parameters:
      value - A Boolean value to indicate that this canonical resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • getDateMax

      public int getDateMax()
      How many allowed for this property by the implementation
    • getDateElement

      public abstract DateTimeType getDateElement()
      Returns:
      #date (The date (and optionally time) when the canonical resource 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 canonical resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
    • hasDateElement

      public abstract boolean hasDateElement()
    • hasDate

      public abstract boolean hasDate()
    • setDateElement

      Parameters:
      value - #date (The date (and optionally time) when the canonical resource 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 canonical resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
    • getDate

      public abstract Date getDate()
      Returns:
      The date (and optionally time) when the canonical resource 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 canonical resource changes.
    • setDate

      public abstract CanonicalResource setDate(Date value)
      Parameters:
      value - The date (and optionally time) when the canonical resource 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 canonical resource changes.
    • getPublisherMax

      public int getPublisherMax()
      How many allowed for this property by the implementation
    • getPublisherElement

      public abstract StringType getPublisherElement()
      Returns:
      #publisher (The name of the organization or individual that published the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
    • hasPublisherElement

      public abstract boolean hasPublisherElement()
    • hasPublisher

      public abstract boolean hasPublisher()
    • setPublisherElement

      Parameters:
      value - #publisher (The name of the organization or individual that published the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
    • getPublisher

      public abstract String getPublisher()
      Returns:
      The name of the organization or individual that published the canonical resource.
    • setPublisher

      public abstract CanonicalResource setPublisher(String value)
      Parameters:
      value - The name of the organization or individual that published the canonical resource.
    • getContactMax

      public int getContactMax()
      How many allowed for this property by the implementation
    • getContact

      public abstract List<ContactDetail> getContact()
      Returns:
      #contact (Contact details to assist a user in finding and communicating with the publisher.)
    • setContact

      public abstract CanonicalResource setContact(List<ContactDetail> theContact)
      Returns:
      Returns a reference to this for easy method chaining
    • hasContact

      public abstract boolean hasContact()
    • addContact

      public abstract ContactDetail addContact()
    • addContact

    • getContactFirstRep

      public abstract ContactDetail getContactFirstRep()
      Returns:
      The first repetition of repeating field #contact, creating it if it does not already exist {1}
    • getDescriptionMax

      public int getDescriptionMax()
      How many allowed for this property by the implementation
    • getDescriptionElement

      Returns:
      #description (A free text natural language description of the canonical resource 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 abstract boolean hasDescriptionElement()
    • hasDescription

      public abstract boolean hasDescription()
    • setDescriptionElement

      Parameters:
      value - #description (A free text natural language description of the canonical resource 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 abstract String getDescription()
      Returns:
      A free text natural language description of the canonical resource from a consumer's perspective.
    • setDescription

      public abstract CanonicalResource setDescription(String value)
      Parameters:
      value - A free text natural language description of the canonical resource from a consumer's perspective.
    • getUseContextMax

      public int getUseContextMax()
      How many allowed for this property by the implementation
    • getUseContext

      public abstract 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 canonical resource instances.)
    • setUseContext

      public abstract CanonicalResource setUseContext(List<UsageContext> theUseContext)
      Returns:
      Returns a reference to this for easy method chaining
    • hasUseContext

      public abstract boolean hasUseContext()
    • addUseContext

      public abstract UsageContext addUseContext()
    • addUseContext

    • getUseContextFirstRep

      Returns:
      The first repetition of repeating field #useContext, creating it if it does not already exist {1}
    • getJurisdictionMax

      public int getJurisdictionMax()
      How many allowed for this property by the implementation
    • getJurisdiction

      public abstract List<CodeableConcept> getJurisdiction()
      Returns:
      #jurisdiction (A legal or geographic region in which the canonical resource is intended to be used.)
    • setJurisdiction

      public abstract CanonicalResource setJurisdiction(List<CodeableConcept> theJurisdiction)
      Returns:
      Returns a reference to this for easy method chaining
    • hasJurisdiction

      public abstract boolean hasJurisdiction()
    • addJurisdiction

      public abstract CodeableConcept addJurisdiction()
    • addJurisdiction

    • getJurisdictionFirstRep

      Returns:
      The first repetition of repeating field #jurisdiction, creating it if it does not already exist {1}
    • getPurposeMax

      public int getPurposeMax()
      How many allowed for this property by the implementation
    • getPurposeElement

      public abstract MarkdownType getPurposeElement()
      Returns:
      #purpose (Explanation of why this canonical resource 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 abstract boolean hasPurposeElement()
    • hasPurpose

      public abstract boolean hasPurpose()
    • setPurposeElement

      Parameters:
      value - #purpose (Explanation of why this canonical resource 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 abstract String getPurpose()
      Returns:
      Explanation of why this canonical resource is needed and why it has been designed as it has.
    • setPurpose

      public abstract CanonicalResource setPurpose(String value)
      Parameters:
      value - Explanation of why this canonical resource is needed and why it has been designed as it has.
    • getCopyrightMax

      public int getCopyrightMax()
      How many allowed for this property by the implementation
    • getCopyrightElement

      public abstract MarkdownType getCopyrightElement()
      Returns:
      #copyright (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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
    • hasCopyrightElement

      public abstract boolean hasCopyrightElement()
    • hasCopyright

      public abstract boolean hasCopyright()
    • setCopyrightElement

      Parameters:
      value - #copyright (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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
    • getCopyright

      public abstract String 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

      public abstract CanonicalResource setCopyright(String value)
      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.
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      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 DomainResource
      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 DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      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 DomainResource
    • copy

      public abstract CanonicalResource copy()
      Specified by:
      copy in class DomainResource
    • copyValues

      public void copyValues(CanonicalResource dst)
    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class DomainResource
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class DomainResource
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • present

      public String present()
    • getVUrl

      public String getVUrl()
    • supportsCopyright

      public boolean supportsCopyright()
    • getVersionedUrl