Package org.hl7.fhir.dstu2016may.model

Class 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:
    Serialized Form

    • Field Detail

      • url

        protected UriType 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.

      • version

        protected StringType 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.

      • name

        protected StringType name
        A free text natural language name identifying the Implementation Guide.

      • experimental

        protected BooleanType experimental
        This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

      • publisher

        protected StringType publisher
        The name of the individual or organization that published the implementation guide.

      • date

        protected DateTimeType 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.

      • description

        protected StringType description
        A free text natural language description of the Implementation Guide and its use.

      • useContext

        protected List<CodeableConcept> 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.

      • copyright

        protected StringType 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.

      • fhirVersion

        protected IdType 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.4.0 for this version.

      • binary

        protected List<UriType> binary
        A binary file that is included in the implementation guide when it is published.

      • SP_DEPENDENCY

        public static final String SP_DEPENDENCY
        Search parameter: dependency

        Description: Where to find dependency
        Type: uri
        Path: ImplementationGuide.dependency.uri

        See Also:
        Constant Field Values

      • DEPENDENCY

        public static final ca.uhn.fhir.rest.gclient.UriClientParam DEPENDENCY
        Fluent Client search parameter constant for dependency

        Description: Where to find dependency
        Type: uri
        Path: ImplementationGuide.dependency.uri

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the implementation guide
        Type: token
        Path: ImplementationGuide.status

        See Also:
        Constant Field Values

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The current status of the implementation guide
        Type: token
        Path: ImplementationGuide.status

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: Text search in the description of the implementation guide
        Type: string
        Path: ImplementationGuide.description

        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description: Text search in the description of the implementation guide
        Type: string
        Path: ImplementationGuide.description

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Name of the implementation guide
        Type: string
        Path: ImplementationGuide.name

        See Also:
        Constant Field Values

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: Name of the implementation guide
        Type: string
        Path: ImplementationGuide.name

      • SP_RESOURCE

        public static final String SP_RESOURCE
        Search parameter: resource

        Description: Location of the resource
        Type: reference
        Path: ImplementationGuide.package.resource.source[x]

        See Also:
        Constant Field Values

      • RESOURCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESOURCE
        Fluent Client search parameter constant for resource

        Description: Location of the resource
        Type: reference
        Path: ImplementationGuide.package.resource.source[x]

      • INCLUDE_RESOURCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RESOURCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ImplementationGuide:resource".

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the structure
        Type: token
        Path: ImplementationGuide.useContext

        See Also:
        Constant Field Values

      • CONTEXT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
        Fluent Client search parameter constant for context

        Description: A use context assigned to the structure
        Type: token
        Path: ImplementationGuide.useContext

      • SP_EXPERIMENTAL

        public static final String SP_EXPERIMENTAL
        Search parameter: experimental

        Description: If for testing purposes, not real usage
        Type: token
        Path: ImplementationGuide.experimental

        See Also:
        Constant Field Values

      • EXPERIMENTAL

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
        Fluent Client search parameter constant for experimental

        Description: If for testing purposes, not real usage
        Type: token
        Path: ImplementationGuide.experimental

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The implementation guide publication date
        Type: date
        Path: ImplementationGuide.date

        See Also:
        Constant Field Values

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: The implementation guide publication date
        Type: date
        Path: ImplementationGuide.date

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Absolute URL used to reference this Implementation Guide
        Type: uri
        Path: ImplementationGuide.url

        See Also:
        Constant Field Values

      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Absolute URL used to reference this Implementation Guide
        Type: uri
        Path: ImplementationGuide.url

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the implementation guide
        Type: string
        Path: ImplementationGuide.publisher

        See Also:
        Constant Field Values

      • PUBLISHER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
        Fluent Client search parameter constant for publisher

        Description: Name of the publisher of the implementation guide
        Type: string
        Path: ImplementationGuide.publisher

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The version identifier of the implementation guide
        Type: token
        Path: ImplementationGuide.version

        See Also:
        Constant Field Values

      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

        Description: The version identifier of the implementation guide
        Type: token
        Path: ImplementationGuide.version

    • Method Detail

      • 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

      • 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

      • 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

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

      • 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

      • 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

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

      • 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

      • 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

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

      • 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.)

      • 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.)

      • 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

      • 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.4.0 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value

      • 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.4.0 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.4.0 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.4.0 for this version.

      • getBinary

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

      • addBinaryElement

        public UriType addBinaryElement()
        Returns:
        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.)

      • hasPage

        public boolean hasPage()

      • 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

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

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