Package org.hl7.fhir.dstu2.model

Class ImplementationGuide

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.ImplementationGuide
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
public class ImplementationGuide extends DomainResource
A set of rules or how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole, and to publish a computable definition of all the parts.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getUrlElement

      public UriType getUrlElement()
      Returns:
      url (An absolute URL that is used to identify this implementation guide 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 implementation guide is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public ImplementationGuide setUrlElement(UriType value)
      Parameters:
      value - url (An absolute URL that is used to identify this implementation guide 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 implementation guide is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • getUrl

      public String getUrl()
      Returns:
      An absolute URL that is used to identify this implementation guide 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 implementation guide is (or will be) published.

    • setUrl

      public ImplementationGuide setUrl(String value)
      Parameters:
      value - An absolute URL that is used to identify this implementation guide 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 implementation guide is (or will be) published.

    • getVersionElement

      public StringType getVersionElement()
      Returns:
      version (The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • setVersionElement

      public ImplementationGuide setVersionElement(StringType value)
      Parameters:
      value - version (The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • getVersion

      public String getVersion()
      Returns:
      The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.

    • setVersion

      public ImplementationGuide setVersion(String value)
      Parameters:
      value - The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.

    • getNameElement

      public StringType getNameElement()
      Returns:
      name (A free text natural language name identifying the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • hasNameElement

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public ImplementationGuide setNameElement(StringType value)
      Parameters:
      value - name (A free text natural language name identifying the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • getName

      public String getName()
      Returns:
      A free text natural language name identifying the Implementation Guide.

    • setName

      public ImplementationGuide setName(String value)
      Parameters:
      value - A free text natural language name identifying the Implementation Guide.

    • getStatusElement

      public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
      Returns:
      status (The status of the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public ImplementationGuide setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
      Parameters:
      value - status (The status of the Implementation Guide.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.ConformanceResourceStatus getStatus()
      Returns:
      The status of the Implementation Guide.

    • setStatus

      public ImplementationGuide setStatus(Enumerations.ConformanceResourceStatus value)
      Parameters:
      value - The status of the Implementation Guide.

    • getExperimentalElement

      public BooleanType getExperimentalElement()
      Returns:
      experimental (This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

    • hasExperimentalElement

      public boolean hasExperimentalElement()

    • hasExperimental

      public boolean hasExperimental()

    • setExperimentalElement

      public ImplementationGuide setExperimentalElement(BooleanType value)
      Parameters:
      value - experimental (This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

    • getExperimental

      public boolean getExperimental()
      Returns:
      This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • setExperimental

      public ImplementationGuide setExperimental(boolean value)
      Parameters:
      value - This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • getPublisherElement

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

    • hasPublisherElement

      public boolean hasPublisherElement()

    • hasPublisher

      public boolean hasPublisher()

    • setPublisherElement

      public ImplementationGuide setPublisherElement(StringType value)
      Parameters:
      value - publisher (The name of the individual or organization that published the implementation guide.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

    • getPublisher

      public String getPublisher()
      Returns:
      The name of the individual or organization that published the implementation guide.

    • setPublisher

      public ImplementationGuide setPublisher(String value)
      Parameters:
      value - The name of the individual or organization that published the implementation guide.

    • getContact

      public List<ImplementationGuide.ImplementationGuideContactComponent> getContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • hasContact

      public boolean hasContact()

    • addContact

      public ImplementationGuide.ImplementationGuideContactComponent addContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • addContact

      public ImplementationGuide addContact(ImplementationGuide.ImplementationGuideContactComponent t)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      date (The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public ImplementationGuide setDateElement(DateTimeType value)
      Parameters:
      value - date (The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • getDate

      public Date getDate()
      Returns:
      The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

    • setDate

      public ImplementationGuide setDate(Date value)
      Parameters:
      value - The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

    • getDescriptionElement

      public StringType getDescriptionElement()
      Returns:
      description (A free text natural language description of the Implementation Guide and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public ImplementationGuide setDescriptionElement(StringType value)
      Parameters:
      value - description (A free text natural language description of the Implementation Guide and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      A free text natural language description of the Implementation Guide and its use.

    • setDescription

      public ImplementationGuide setDescription(String value)
      Parameters:
      value - A free text natural language description of the Implementation Guide and its use.

    • getUseContext

      public List<CodeableConcept> getUseContext()
      Returns:
      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 implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.)

    • hasUseContext

      public boolean hasUseContext()

    • addUseContext

      public CodeableConcept addUseContext()
      Returns:
      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 implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.)

    • addUseContext

      public ImplementationGuide addUseContext(CodeableConcept t)

    • getCopyrightElement

      public StringType getCopyrightElement()
      Returns:
      copyright (A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

    • hasCopyrightElement

      public boolean hasCopyrightElement()

    • hasCopyright

      public boolean hasCopyright()

    • setCopyrightElement

      public ImplementationGuide setCopyrightElement(StringType value)
      Parameters:
      value - copyright (A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

    • getCopyright

      public String getCopyright()
      Returns:
      A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.

    • setCopyright

      public ImplementationGuide setCopyright(String value)
      Parameters:
      value - A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.

    • getFhirVersionElement

      public IdType getFhirVersionElement()
      Returns:
      fhirVersion (The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value

    • hasFhirVersionElement

      public boolean hasFhirVersionElement()

    • hasFhirVersion

      public boolean hasFhirVersion()

    • setFhirVersionElement

      public ImplementationGuide setFhirVersionElement(IdType value)
      Parameters:
      value - fhirVersion (The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value

    • getFhirVersion

      public String getFhirVersion()
      Returns:
      The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.

    • setFhirVersion

      public ImplementationGuide setFhirVersion(String value)
      Parameters:
      value - The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version.

    • getDependency

      public List<ImplementationGuide.ImplementationGuideDependencyComponent> getDependency()
      Returns:
      dependency (Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.)

    • hasDependency

      public boolean hasDependency()

    • addDependency

      public ImplementationGuide.ImplementationGuideDependencyComponent addDependency()
      Returns:
      dependency (Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.)

    • addDependency

      public ImplementationGuide addDependency(ImplementationGuide.ImplementationGuideDependencyComponent t)

    • getPackage

      public List<ImplementationGuide.ImplementationGuidePackageComponent> getPackage()
      Returns:
      package_ (A logical group of resources. Logical groups can be used when building pages.)

    • hasPackage

      public boolean hasPackage()

    • addPackage

      public ImplementationGuide.ImplementationGuidePackageComponent addPackage()
      Returns:
      package_ (A logical group of resources. Logical groups can be used when building pages.)

    • addPackage

      public ImplementationGuide addPackage(ImplementationGuide.ImplementationGuidePackageComponent t)

    • getGlobal

      public List<ImplementationGuide.ImplementationGuideGlobalComponent> getGlobal()
      Returns:
      global (A set of profiles that all resources covered by this implementation guide must conform to.)

    • hasGlobal

      public boolean hasGlobal()

    • addGlobal

      public ImplementationGuide.ImplementationGuideGlobalComponent addGlobal()
      Returns:
      global (A set of profiles that all resources covered by this implementation guide must conform to.)

    • addGlobal

      public ImplementationGuide addGlobal(ImplementationGuide.ImplementationGuideGlobalComponent t)

    • getBinary

      public List<UriType> getBinary()
      Returns:
      binary (A binary file that is included in the implementation guide when it is published.)

    • hasBinary

      public boolean hasBinary()

    • addBinaryElement

      public UriType addBinaryElement()
      Returns:
      binary (A binary file that is included in the implementation guide when it is published.)

    • addBinary

      public ImplementationGuide addBinary(String value)
      Parameters:
      value - binary (A binary file that is included in the implementation guide when it is published.)

    • hasBinary

      public boolean hasBinary(String value)
      Parameters:
      value - binary (A binary file that is included in the implementation guide when it is published.)

    • getPage

      public ImplementationGuide.ImplementationGuidePageComponent getPage()
      Returns:
      page (A page / section in the implementation guide. The root page is the implementation guide home page.)

    • hasPage

      public boolean hasPage()

    • setPage

      public ImplementationGuide setPage(ImplementationGuide.ImplementationGuidePageComponent value)
      Parameters:
      value - page (A page / section in the implementation guide. The root page is the implementation guide home page.)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty 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 ImplementationGuide copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected ImplementationGuide typedCopy()

    • 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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource