Package org.hl7.fhir.r5.patterns

Interface Definition

All Superinterfaces:
PatternBase
All Known Implementing Classes:
ActivityDefinitionDefinitionImpl
public interface Definition extends PatternBase
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.

  • Method Details

    • getUrlElement

      UriType getUrlElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #url
      (An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasUrl

      boolean hasUrl()
      Returns:
      whether there is more than zero values for url

    • getUrlMin

      int getUrlMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for url. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getUrlMax

      int getUrlMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for url. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasUrlElement

      boolean hasUrlElement()

    • setUrlElement

      Definition setUrlElement(UriType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #url
      (An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getUrl

      String getUrl() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setUrl

      Definition setUrl(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - An absolute URL that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this {{title}} is (or will be) published. The URL SHOULD include the major version of the {{title}}. For more information see [Technical and Business Versions](resource.html#versions).
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getIdentifier

      Identifier getIdentifier() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #identifier
      (Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasIdentifier

      boolean hasIdentifier()
      Returns:
      whether there is more than zero values for identifier

    • getIdentifierMin

      int getIdentifierMin()
      Returns:
      minimum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource

    • getIdentifierMax

      int getIdentifierMax()
      Returns:
      maximum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource

    • setIdentifier

      Definition setIdentifier(Identifier value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #identifier
      (Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getVersionElement

      StringType getVersionElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #version
      (The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasVersion

      boolean hasVersion()
      Returns:
      whether there is more than zero values for version

    • getVersionMin

      int getVersionMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getVersionMax

      int getVersionMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasVersionElement

      boolean hasVersionElement()

    • setVersionElement

      Definition setVersionElement(StringType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #version
      (The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getVersion

      String getVersion() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 are orderable.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setVersion

      Definition setVersion(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 are orderable.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTitleElement

      StringType getTitleElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #title
      (A short, descriptive, user-friendly title for the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTitle

      boolean hasTitle()
      Returns:
      whether there is more than zero values for title

    • getTitleMin

      int getTitleMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for title. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTitleMax

      int getTitleMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for title. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasTitleElement

      boolean hasTitleElement()

    • setTitleElement

      Definition setTitleElement(StringType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #title
      (A short, descriptive, user-friendly title for the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTitle

      String getTitle() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      A short, descriptive, user-friendly title for the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setTitle

      Definition setTitle(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - A short, descriptive, user-friendly title for the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDerivedFromCanonical

      List<CanonicalType> getDerivedFromCanonical() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #derivedFromCanonical
      (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setDerivedFromCanonical

      Definition setDerivedFromCanonical(List<CanonicalType> theDerivedFromCanonical) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDerivedFromCanonical

      boolean hasDerivedFromCanonical()
      Returns:
      whether there is more than zero values for derivedFromCanonical

    • getDerivedFromCanonicalMin

      int getDerivedFromCanonicalMin()
      Returns:
      minimum allowed cardinality for derivedFromCanonical. Note that with patterns, this may be different for the underlying resource

    • getDerivedFromCanonicalMax

      int getDerivedFromCanonicalMax()
      Returns:
      maximum allowed cardinality for derivedFromCanonical. Note that with patterns, this may be different for the underlying resource

    • addDerivedFromCanonicalElement

      CanonicalType addDerivedFromCanonicalElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #derivedFromCanonical
      (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addDerivedFromCanonical

      Definition addDerivedFromCanonical(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #derivedFromCanonical
      (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDerivedFromCanonical

      boolean hasDerivedFromCanonical(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #derivedFromCanonical
      (The canonical URL pointing to another FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDerivedFromUri

      List<UriType> getDerivedFromUri() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #derivedFromUri
      (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setDerivedFromUri

      Definition setDerivedFromUri(List<UriType> theDerivedFromUri) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDerivedFromUri

      boolean hasDerivedFromUri()
      Returns:
      whether there is more than zero values for derivedFromUri

    • getDerivedFromUriMin

      int getDerivedFromUriMin()
      Returns:
      minimum allowed cardinality for derivedFromUri. Note that with patterns, this may be different for the underlying resource

    • getDerivedFromUriMax

      int getDerivedFromUriMax()
      Returns:
      maximum allowed cardinality for derivedFromUri. Note that with patterns, this may be different for the underlying resource

    • addDerivedFromUriElement

      UriType addDerivedFromUriElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #derivedFromUri
      (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addDerivedFromUri

      Definition addDerivedFromUri(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #derivedFromUri
      (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDerivedFromUri

      boolean hasDerivedFromUri(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #derivedFromUri
      (The URL pointing to an externally-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPartOf

      List<CanonicalType> getPartOf() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #partOf
      (A larger definition of which this particular definition is a component or step.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setPartOf

      Definition setPartOf(List<CanonicalType> thePartOf) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPartOf

      boolean hasPartOf()
      Returns:
      whether there is more than zero values for partOf

    • getPartOfMin

      int getPartOfMin()
      Returns:
      minimum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource

    • getPartOfMax

      int getPartOfMax()
      Returns:
      maximum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource

    • addPartOfElement

      CanonicalType addPartOfElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #partOf
      (A larger definition of which this particular definition is a component or step.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addPartOf

      Definition addPartOf(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #partOf
      (A larger definition of which this particular definition is a component or step.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPartOf

      boolean hasPartOf(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #partOf
      (A larger definition of which this particular definition is a component or step.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getReplaces

      List<CanonicalType> getReplaces() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #replaces
      (Completed or terminated request(s) whose function is taken by this new request.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setReplaces

      Definition setReplaces(List<CanonicalType> theReplaces) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasReplaces

      boolean hasReplaces()
      Returns:
      whether there is more than zero values for replaces

    • getReplacesMin

      int getReplacesMin()
      Returns:
      minimum allowed cardinality for replaces. Note that with patterns, this may be different for the underlying resource

    • getReplacesMax

      int getReplacesMax()
      Returns:
      maximum allowed cardinality for replaces. Note that with patterns, this may be different for the underlying resource

    • addReplacesElement

      CanonicalType addReplacesElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #replaces
      (Completed or terminated request(s) whose function is taken by this new request.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addReplaces

      Definition addReplaces(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #replaces
      (Completed or terminated request(s) whose function is taken by this new request.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasReplaces

      boolean hasReplaces(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #replaces
      (Completed or terminated request(s) whose function is taken by this new request.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getStatusElement

      Enumeration<Enumerations.PublicationStatus> getStatusElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #status
      (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasStatus

      boolean hasStatus()
      Returns:
      whether there is more than zero values for status

    • getStatusMin

      int getStatusMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getStatusMax

      int getStatusMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasStatusElement

      boolean hasStatusElement()

    • setStatusElement

      Definition setStatusElement(Enumeration<Enumerations.PublicationStatus> value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #status
      (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getStatus

      Enumerations.PublicationStatus getStatus() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The current state of the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setStatus

      Definition setStatus(Enumerations.PublicationStatus value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - The current state of the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getExperimentalElement

      BooleanType getExperimentalElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #experimental
      (A flag to indicate that this {{title}} 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasExperimental

      boolean hasExperimental()
      Returns:
      whether there is more than zero values for experimental

    • getExperimentalMin

      int getExperimentalMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for experimental. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getExperimentalMax

      int getExperimentalMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for experimental. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasExperimentalElement

      boolean hasExperimentalElement()

    • setExperimentalElement

      Definition setExperimentalElement(BooleanType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #experimental
      (A flag to indicate that this {{title}} 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getExperimental

      boolean getExperimental() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setExperimental

      Definition setExperimental(boolean value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - A flag to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getSubject

      DataType getSubject() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #subject
      (A code or group definition that describes the intended subject of instantiations of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getSubjectCodeableConcept

      CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #subject
      (A code or group definition that describes the intended subject of instantiations of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasSubjectCodeableConcept

      boolean hasSubjectCodeableConcept()

    • getSubjectReference

      Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #subject
      (A code or group definition that describes the intended subject of instantiations of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasSubjectReference

      boolean hasSubjectReference()

    • hasSubject

      boolean hasSubject()
      Returns:
      whether there is more than zero values for subject

    • getSubjectMin

      int getSubjectMin()
      Returns:
      minimum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource

    • getSubjectMax

      int getSubjectMax()
      Returns:
      maximum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource

    • setSubject

      Definition setSubject(DataType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #subject
      (A code or group definition that describes the intended subject of instantiations of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDateElement

      DateTimeType getDateElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #date
      (For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDate

      boolean hasDate()
      Returns:
      whether there is more than zero values for date

    • getDateMin

      int getDateMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for date. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDateMax

      int getDateMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for date. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDateElement

      boolean hasDateElement()

    • setDateElement

      Definition setDateElement(DateTimeType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #date
      (For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDate

      Date getDate() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setDate

      Definition setDate(Date value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPublisher

      Reference getPublisher() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #publisher
      (Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPublisher

      boolean hasPublisher()
      Returns:
      whether there is more than zero values for publisher

    • getPublisherMin

      int getPublisherMin()
      Returns:
      minimum allowed cardinality for publisher. Note that with patterns, this may be different for the underlying resource

    • getPublisherMax

      int getPublisherMax()
      Returns:
      maximum allowed cardinality for publisher. Note that with patterns, this may be different for the underlying resource

    • setPublisher

      Definition setPublisher(Reference value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #publisher
      (Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getContact

      List<ContactDetail> getContact() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #contact
      (Contact details to assist a user in finding and communicating with the publisher.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setContact

      Definition setContact(List<ContactDetail> theContact) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasContact

      boolean hasContact()
      Returns:
      whether there is more than zero values for contact

    • getContactMin

      int getContactMin()
      Returns:
      minimum allowed cardinality for contact. Note that with patterns, this may be different for the underlying resource

    • getContactMax

      int getContactMax()
      Returns:
      maximum allowed cardinality for contact. Note that with patterns, this may be different for the underlying resource

    • addContact

      ContactDetail addContact() throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addContact

      Definition addContact(ContactDetail t) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getContactFirstRep

      ContactDetail getContactFirstRep() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The first repetition of repeating field
      invalid reference 
      #contact
      , creating it if it does not already exist
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDescriptionElement

      MarkdownType getDescriptionElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #description
      (A free text natural language description of the {{title}} from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDescription

      boolean hasDescription()
      Returns:
      whether there is more than zero values for description

    • getDescriptionMin

      int getDescriptionMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for description. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDescriptionMax

      int getDescriptionMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for description. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasDescriptionElement

      boolean hasDescriptionElement()

    • setDescriptionElement

      Definition setDescriptionElement(MarkdownType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #description
      (A free text natural language description of the {{title}} from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getDescription

      String getDescription() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      A free text natural language description of the {{title}} from the consumer's perspective.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setDescription

      Definition setDescription(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - A free text natural language description of the {{title}} from the consumer's perspective.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getUseContext

      List<UsageContext> getUseContext() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #useContext
      (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setUseContext

      Definition setUseContext(List<UsageContext> theUseContext) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasUseContext

      boolean hasUseContext()
      Returns:
      whether there is more than zero values for useContext

    • getUseContextMin

      int getUseContextMin()
      Returns:
      minimum allowed cardinality for useContext. Note that with patterns, this may be different for the underlying resource

    • getUseContextMax

      int getUseContextMax()
      Returns:
      maximum allowed cardinality for useContext. Note that with patterns, this may be different for the underlying resource

    • addUseContext

      UsageContext addUseContext() throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addUseContext

      Definition addUseContext(UsageContext t) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getUseContextFirstRep

      UsageContext getUseContextFirstRep() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The first repetition of repeating field
      invalid reference 
      #useContext
      , creating it if it does not already exist
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getJurisdiction

      List<CodeableConcept> getJurisdiction() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #jurisdiction
      (A jurisdiction in which the {{title}} is intended to be used.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setJurisdiction

      Definition setJurisdiction(List<CodeableConcept> theJurisdiction) throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Returns a reference to this for easy method chaining
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasJurisdiction

      boolean hasJurisdiction()
      Returns:
      whether there is more than zero values for jurisdiction

    • getJurisdictionMin

      int getJurisdictionMin()
      Returns:
      minimum allowed cardinality for jurisdiction. Note that with patterns, this may be different for the underlying resource

    • getJurisdictionMax

      int getJurisdictionMax()
      Returns:
      maximum allowed cardinality for jurisdiction. Note that with patterns, this may be different for the underlying resource

    • addJurisdiction

      CodeableConcept addJurisdiction() throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addJurisdiction

      Definition addJurisdiction(CodeableConcept t) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getJurisdictionFirstRep

      CodeableConcept getJurisdictionFirstRep() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The first repetition of repeating field
      invalid reference 
      #jurisdiction
      , creating it if it does not already exist
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPurposeElement

      MarkdownType getPurposeElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #purpose
      (Explains why this {{title}} 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPurpose

      boolean hasPurpose()
      Returns:
      whether there is more than zero values for purpose

    • getPurposeMin

      int getPurposeMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for purpose. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPurposeMax

      int getPurposeMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for purpose. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPurposeElement

      boolean hasPurposeElement()

    • setPurposeElement

      Definition setPurposeElement(MarkdownType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #purpose
      (Explains why this {{title}} 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPurpose

      String getPurpose() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      Explains why this {{title}} is needed and why it has been designed as it has.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setPurpose

      Definition setPurpose(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - Explains why this {{title}} is needed and why it has been designed as it has.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getCopyrightElement

      MarkdownType getCopyrightElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #copyright
      (A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasCopyright

      boolean hasCopyright()
      Returns:
      whether there is more than zero values for copyright

    • getCopyrightMin

      int getCopyrightMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for copyright. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getCopyrightMax

      int getCopyrightMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for copyright. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasCopyrightElement

      boolean hasCopyrightElement()

    • setCopyrightElement

      Definition setCopyrightElement(MarkdownType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #copyright
      (A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getCopyright

      String getCopyright() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setCopyright

      Definition setCopyright(String value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getApprovalDateElement

      DateType getApprovalDateElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #approvalDate
      (The date on which the asset 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasApprovalDate

      boolean hasApprovalDate()
      Returns:
      whether there is more than zero values for approvalDate

    • getApprovalDateMin

      int getApprovalDateMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for approvalDate. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getApprovalDateMax

      int getApprovalDateMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for approvalDate. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasApprovalDateElement

      boolean hasApprovalDateElement()

    • setApprovalDateElement

      Definition setApprovalDateElement(DateType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #approvalDate
      (The date on which the asset 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
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getApprovalDate

      Date getApprovalDate() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setApprovalDate

      Definition setApprovalDate(Date value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getLastReviewDateElement

      DateType getLastReviewDateElement() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #lastReviewDate
      (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasLastReviewDate

      boolean hasLastReviewDate()
      Returns:
      whether there is more than zero values for lastReviewDate

    • getLastReviewDateMin

      int getLastReviewDateMin() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      minimum allowed cardinality for lastReviewDate. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getLastReviewDateMax

      int getLastReviewDateMax() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      maximum allowed cardinality for lastReviewDate. Note that with patterns, this may be different for the underlying resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasLastReviewDateElement

      boolean hasLastReviewDateElement()

    • setLastReviewDateElement

      Definition setLastReviewDateElement(DateType value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #lastReviewDate
      (The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getLastReviewDate

      Date getLastReviewDate() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setLastReviewDate

      Definition setLastReviewDate(Date value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value - The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getEffectivePeriod

      Period getEffectivePeriod() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #effectivePeriod
      (The period during which the {{title}} content was or is planned to be effective.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasEffectivePeriod

      boolean hasEffectivePeriod()
      Returns:
      whether there is more than zero values for effectivePeriod

    • getEffectivePeriodMin

      int getEffectivePeriodMin()
      Returns:
      minimum allowed cardinality for effectivePeriod. Note that with patterns, this may be different for the underlying resource

    • getEffectivePeriodMax

      int getEffectivePeriodMax()
      Returns:
      maximum allowed cardinality for effectivePeriod. Note that with patterns, this may be different for the underlying resource

    • setEffectivePeriod

      Definition setEffectivePeriod(Period value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #effectivePeriod
      (The period during which the {{title}} content was or is planned to be effective.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getPerformerType

      CodeableConcept getPerformerType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      invalid reference 
      #performerType
      (The type of individual that is expected to act upon instances of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • hasPerformerType

      boolean hasPerformerType()
      Returns:
      whether there is more than zero values for performerType

    • getPerformerTypeMin

      int getPerformerTypeMin()
      Returns:
      minimum allowed cardinality for performerType. Note that with patterns, this may be different for the underlying resource

    • getPerformerTypeMax

      int getPerformerTypeMax()
      Returns:
      maximum allowed cardinality for performerType. Note that with patterns, this may be different for the underlying resource

    • setPerformerType

      Definition setPerformerType(CodeableConcept value) throws org.hl7.fhir.exceptions.FHIRException
      Parameters:
      value -
      invalid reference 
      #performerType
      (The type of individual that is expected to act upon instances of this definition.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      String fhirType()