Package ca.uhn.fhir.model.dstu2.resource

Class ImplementationGuide

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class ImplementationGuide
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR ImplementationGuide Resource (conformance.misc)

    Definition: 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

    Requirements: An implementation guide is able to define default profiles that must apply to any use of a resource, so validation services may need to take one or more implementation guide resources when validating.

    Profile Definition: http://hl7.org/fhir/profiles/ImplementationGuide

    See Also:
    Serialized Form

    • Field Detail

      • URL

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

        Description:
        Type: uri
        Path: ImplementationGuide.url

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter constant for 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

      • SP_NAME

        public static final String SP_NAME
        Search parameter constant for 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_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter constant for 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_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter constant for 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_STATUS

        public static final String SP_STATUS
        Search parameter constant for 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_DATE

        public static final String SP_DATE
        Search parameter constant for 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_CONTEXT

        public static final String SP_CONTEXT
        Search parameter constant for 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

      • EXPERIMENTAL

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

        Description:
        Type: token
        Path: ImplementationGuide.experimental

      • DEPENDENCY

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

        Description:
        Type: uri
        Path: ImplementationGuide.dependency.uri

    • Method Detail

      • isEmpty

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

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getUrlElement

        public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
        Gets the value(s) for url (id). creating it if it does not exist. Will not return null.

        Definition: 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

      • getUrl

        public String getUrl()
        Gets the value(s) for url (id). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for url (id)

        Definition: 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 theUri)
        Sets the value for url (id)

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
        Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.

        Definition: 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

      • getVersion

        public String getVersion()
        Gets the value(s) for version (id.version). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for version (id.version)

        Definition: 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 theString)
        Sets the value for version (id.version)

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language name identifying the Implementation Guide

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language name identifying the Implementation Guide

      • setName

        public ImplementationGuide setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: A free text natural language name identifying the Implementation Guide

      • setName

        public ImplementationGuide setName​(String theString)
        Sets the value for name ()

        Definition: A free text natural language name identifying the Implementation Guide

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The status of the Implementation Guide

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The status of the Implementation Guide

      • getExperimentalElement

        public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
        Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.

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

      • getExperimental

        public Boolean getExperimental()
        Gets the value(s) for experimental (class). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for experimental (class)

        Definition: 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 theBoolean)
        Sets the value for experimental (class)

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

      • getPublisherElement

        public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
        Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

        Definition: The name of the individual or organization that published the implementation guide

      • getPublisher

        public String getPublisher()
        Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

        Definition: The name of the individual or organization that published the implementation guide

      • setPublisher

        public ImplementationGuide setPublisher​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for publisher (who.witness)

        Definition: The name of the individual or organization that published the implementation guide

      • setPublisher

        public ImplementationGuide setPublisher​(String theString)
        Sets the value for publisher (who.witness)

        Definition: The name of the individual or organization that published the implementation guide

      • getContact

        public List<ImplementationGuide.Contact> getContact()
        Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public ImplementationGuide.Contact addContact()
        Adds and returns a new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • getContactFirstRep

        public ImplementationGuide.Contact getContactFirstRep()
        Gets the first repetition for contact (), creating it if it does not already exist.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

        Definition: 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

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.recorded)

        Definition: 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 theDate,
                                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.recorded)

        Definition: 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

      • setDateWithSecondsPrecision

        public ImplementationGuide setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date (when.recorded)

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language description of the Implementation Guide and its use

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language description of the Implementation Guide and its use

      • setDescription

        public ImplementationGuide setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A free text natural language description of the Implementation Guide and its use

      • setDescription

        public ImplementationGuide setDescription​(String theString)
        Sets the value for description ()

        Definition: A free text natural language description of the Implementation Guide and its use

      • getUseContext

        public List<CodeableConceptDt> getUseContext()
        Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setUseContext

        public ImplementationGuide setUseContext​(List<CodeableConceptDt> theValue)
        Sets the value(s) for useContext ()

        Definition: 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 CodeableConceptDt addUseContext()
        Adds and returns a new value for useContext ()

        Definition: 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​(CodeableConceptDt theValue)
        Adds a given new value for useContext ()

        Definition: 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

        Parameters:
        theValue - The useContext to add (must not be null)

      • getUseContextFirstRep

        public CodeableConceptDt getUseContextFirstRep()
        Gets the first repetition for useContext (), creating it if it does not already exist.

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getCopyrightElement()
        Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getCopyright

        public String getCopyright()
        Gets the value(s) for copyright (). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for copyright ()

        Definition: 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 theString)
        Sets the value for copyright ()

        Definition: 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 ca.uhn.fhir.model.primitive.IdDt getFhirVersionElement()
        Gets the value(s) for fhirVersion (). creating it if it does not exist. Will not return null.

        Definition: 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 $version$ for this version

      • getFhirVersion

        public String getFhirVersion()
        Gets the value(s) for fhirVersion (). creating it if it does not exist. This method may return null.

        Definition: 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 $version$ for this version

      • setFhirVersion

        public ImplementationGuide setFhirVersion​(ca.uhn.fhir.model.primitive.IdDt theValue)
        Sets the value(s) for fhirVersion ()

        Definition: 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 $version$ for this version

      • setFhirVersion

        public ImplementationGuide setFhirVersion​(String theId)
        Sets the value for fhirVersion ()

        Definition: 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 $version$ for this version

      • getDependency

        public List<ImplementationGuide.Dependency> getDependency()
        Gets the value(s) for dependency (). creating it if it does not exist. Will not return null.

        Definition: 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.Dependency addDependency()
        Adds and returns a new value for dependency ()

        Definition: 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.Dependency theValue)
        Adds a given new value for dependency ()

        Definition: Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides

        Parameters:
        theValue - The dependency to add (must not be null)

      • getDependencyFirstRep

        public ImplementationGuide.Dependency getDependencyFirstRep()
        Gets the first repetition for dependency (), creating it if it does not already exist.

        Definition: Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides

      • getPackage

        public List<ImplementationGuide.Package> getPackage()
        Gets the value(s) for package (). creating it if it does not exist. Will not return null.

        Definition: A logical group of resources. Logical groups can be used when building pages

      • addPackage

        public ImplementationGuide.Package addPackage()
        Adds and returns a new value for package ()

        Definition: A logical group of resources. Logical groups can be used when building pages

      • addPackage

        public ImplementationGuide addPackage​(ImplementationGuide.Package theValue)
        Adds a given new value for package ()

        Definition: A logical group of resources. Logical groups can be used when building pages

        Parameters:
        theValue - The package to add (must not be null)

      • getPackageFirstRep

        public ImplementationGuide.Package getPackageFirstRep()
        Gets the first repetition for package (), creating it if it does not already exist.

        Definition: A logical group of resources. Logical groups can be used when building pages

      • getGlobal

        public List<ImplementationGuide.Global> getGlobal()
        Gets the value(s) for global (). creating it if it does not exist. Will not return null.

        Definition: A set of profiles that all resources covered by this implementation guide must conform to

      • addGlobal

        public ImplementationGuide.Global addGlobal()
        Adds and returns a new value for global ()

        Definition: A set of profiles that all resources covered by this implementation guide must conform to

      • addGlobal

        public ImplementationGuide addGlobal​(ImplementationGuide.Global theValue)
        Adds a given new value for global ()

        Definition: A set of profiles that all resources covered by this implementation guide must conform to

        Parameters:
        theValue - The global to add (must not be null)

      • getGlobalFirstRep

        public ImplementationGuide.Global getGlobalFirstRep()
        Gets the first repetition for global (), creating it if it does not already exist.

        Definition: A set of profiles that all resources covered by this implementation guide must conform to

      • getBinary

        public List<ca.uhn.fhir.model.primitive.UriDt> getBinary()
        Gets the value(s) for binary (). creating it if it does not exist. Will not return null.

        Definition: A binary file that is included in the implementation guide when it is published

      • setBinary

        public ImplementationGuide setBinary​(List<ca.uhn.fhir.model.primitive.UriDt> theValue)
        Sets the value(s) for binary ()

        Definition: A binary file that is included in the implementation guide when it is published

      • addBinary

        public ca.uhn.fhir.model.primitive.UriDt addBinary()
        Adds and returns a new value for binary ()

        Definition: A binary file that is included in the implementation guide when it is published

      • addBinary

        public ImplementationGuide addBinary​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Adds a given new value for binary ()

        Definition: A binary file that is included in the implementation guide when it is published

        Parameters:
        theValue - The binary to add (must not be null)

      • getBinaryFirstRep

        public ca.uhn.fhir.model.primitive.UriDt getBinaryFirstRep()
        Gets the first repetition for binary (), creating it if it does not already exist.

        Definition: A binary file that is included in the implementation guide when it is published

      • addBinary

        public ImplementationGuide addBinary​(String theUri)
        Adds a new value for binary ()

        Definition: A binary file that is included in the implementation guide when it is published

        Returns:
        Returns a reference to this object, to allow for simple chaining.

      • getPage

        public ImplementationGuide.Page getPage()
        Gets the value(s) for page (). creating it if it does not exist. Will not return null.

        Definition: A page / section in the implementation guide. The root page is the implementation guide home page

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource